Skip to main content

traceless.entities

These factories return entity userdata with methods, rather than bare integer entity indices. See entity types.

from_index​

traceless.entities.from_index(index)

Returns: Entity, Controller, Pawn, or Weapon; or nil, reason.

Accepts an integer entry index. Captures the current entity serial in its handle; unavailable indices fail with a reason.

from_handle​

traceless.entities.from_handle(handle)

Returns: Entity, Controller, Pawn, or Weapon; or nil, reason.

Accepts the complete integer entity handle, including its serial. Stale handles fail rather than being silently reused for a new entity.

all​

traceless.entities.all([class_name = nil])

Returns: array of entity userdata.

Returns a snapshot of matching entities; optional string class name performs the implementation's exact class-name comparison. An unavailable entity system returns an empty table.

local traceless = require("traceless")
for _, entity in ipairs(traceless.entities.all()) do
    if entity:is_valid() then traceless.console.info(entity:classname()) end
end