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
- filters: optional table of query-specific stable IDs and bounded selectors.
- cursor: optional opaque continuation cursor returned by the same query.
- page_size: optional positive record limit capped by the host.
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
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
diagnostics_visible | boolean | none | yes | Whether compiled diagnostics are visible. |
event_count | unsigned-integer | none | yes | Observed platform event count. |
frame_count | unsigned-integer | none | yes | Rendered frame count. |
frame_ms | number | milliseconds | yes | Last frame duration. |
paused | boolean | none | yes | Whether fixed ticks are paused. |
sim_ms | number | milliseconds | yes | Last simulation duration. |
tick | unsigned-integer | fixed-ticks | yes | Current committed tick. |
tick_limit | unsigned-integer | fixed-ticks | yes | Configured tick limit. |
Errors
error.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violation
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
- 1.0.0: Runtime contract published from the complete Phase 14 registry.
Related symbols
developererror.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violationworld.query