query · developer

Runtime diagnostics

Returns bounded scheduler and frame diagnostics.

developer.runtime(filters?, cursor?, page_size?) -> query-page
Stable ID
developer.runtime
Owner
sim.fixed-step-scheduler
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 developer.runtime. 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
diagnostics_visiblebooleannoneyesWhether compiled diagnostics are visible.
event_countunsigned-integernoneyesObserved platform event count.
frame_countunsigned-integernoneyesRendered frame count.
frame_msnumbermillisecondsyesLast frame duration.
pausedbooleannoneyesWhether fixed ticks are paused.
sim_msnumbermillisecondsyesLast simulation duration.
tickunsigned-integerfixed-ticksyesCurrent committed tick.
tick_limitunsigned-integerfixed-ticksyesConfigured tick limit.

Errors

Examples

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