query · world.actor

Actor information

Returns detached identity, affiliation, actor revision, control authority, and condition facts for one actor.

world.actor.info(filters?, cursor?, page_size?) -> query-page
Stable ID
world.actor.info
Owner
game.actor-runtime and game.control-authority
Authority
read_only
Timing
immediate
Availability
active-session
Side effects
none
Determinism
stable owner order at the current committed tick
Introduced
1.0.0

Usage

Read stable Actor identity, role, life, plan, and versioned appearance-generation facts. The record also reports current work, carried work-tool and hunting-spear custody, injury and illness severity, and local weather used by detached presentation. These are source-owner facts; they do not expose sprite or mutation authority. Consume records during the current callback and use the returned cursor for bounded continuation.

Parameters

Returns

A detached query page with status, records, continuation metadata, and a stable diagnostic when the request cannot complete.

Cost

Bounded by page size, per-package query budget, and the owning snapshot builder; results are detached before Lua receives them.

Fields

IDTypeUnitsRequiredDescription
actor_idstable-idnoneyesActor identity.
affiliation_idstable-idnoneyesAffiliation identity.
appearance_generation_keyunsigned-integernoneyesStable Actor-owned appearance generation key.
appearance_policy_idstringnoneyesAuthored appearance generator policy.
authority_revisionunsigned-integernoneyesControl-authority owner revision.
body_shapeunsigned-integernoneyesInherited body-shape trait index.
carries_hunting_spearbooleannoneyesWhether Resource custody currently supplies a hunting spear.
carries_work_toolbooleannoneyesWhether Resource custody currently supplies a carried work tool.
control_modeenumerationnoneyesCurrent actor control mode.
current_cell_xsigned-integergrid-cellsyesCurrent World-grid X coordinate.
current_cell_ysigned-integergrid-cellsyesCurrent World-grid Y coordinate.
current_x_metersnumbermetersyesCurrent embodied World X coordinate.
current_y_metersnumbermetersyesCurrent embodied World Y coordinate.
face_shapeunsigned-integernoneyesInherited face-shape trait index.
hair_colorunsigned-integernoneyesInherited hair-color trait index.
hair_textureunsigned-integernoneyesInherited hair-texture trait index.
illness_severityunsigned-integerbasis-pointsyesCurrent Actor-owned illness severity.
injury_severityunsigned-integerbasis-pointsyesCurrent Actor-owned injury severity.
life_stageenumerationnoneyesAge-derived life stage.
livingbooleannoneyesWhether the actor is alive.
local_weatherenumerationnoneyesCurrent World-owned weather at the embodied Actor site.
revisionunsigned-integernoneyesOwner revision.
skin_toneunsigned-integernoneyesInherited skin-tone trait index.
workingbooleannoneyesWhether Actor currently supplies a work layer.

Errors

Examples

local result = world.query("world.actor.info", {page_size = 16})
if result.status == "completed" then
    for _, record in ipairs(result.records) do
        -- Render or inspect detached record fields here.
    end
end

API history

Related symbols

Project references