query · world.selection

Current selection

Returns the stable identities selected by the presentation owner.

world.selection.current(filters?, cursor?, page_size?) -> query-page
Stable ID
world.selection.current
Owner
render.selection
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

Call this query through world.query with the stable ID world.selection.current. Consume detached 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
entity_idstable-idnoneyesSelected stable entity identity.

Errors

Examples

local result = world.query("world.selection.current", {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