Worldforge API Reference

Worldforge scripting platform

Worldforge API Reference

Search the versioned queries, commands, events, UI contracts, receipts, and errors exposed to Worldforge interface packages.

Build with the API

Use these procedures for complete package tasks, command handling, reload-safe state, and recovery.

Guide

Listen for a post-commit event

Register a generation-scoped handler for an immutable owner fact without placing gameplay control flow inside the event chain.

Find an API symbol

300 symbols

namespace · command

Command

namespace command

Typed normal command requests and receipts.

namespace · command.actor

Actor commands

namespace command.actor

Typed normal requests that change Actor control through its owner.

command · command.actor

Release control

command.actor.release-control(actor_id, expected_authority_revision, expected_actor_revision) -> command.receipt

Requests release of direct player control through ControlAuthority.

command · command.actor

Take control

command.actor.take-control(actor_id, expected_authority_revision, expected_actor_revision) -> command.receipt

Requests direct player control of one Actor through ControlAuthority.

namespace · command.construction

Construction commands

namespace command.construction

Typed normal construction designation and cancellation requests.

command · command.construction

Cancel construction

command.construction.cancel(construction_id) -> command.receipt

Cancels one current construction project through its existing owners.

command · command.construction

Designate construction

command.construction.designate(settlement_id, expected_settlement_revision, definition_id, origin_x, origin_y, orientation) -> command.receipt

Designates one authored building on the World grid through Settlement and Construction.

namespace · command.infrastructure

Infrastructure commands

namespace command.infrastructure

Typed requests that control retained road, fence, and gate projects.

command · command.infrastructure

Cancel infrastructure work

command.infrastructure.cancel(infrastructure_id, expected_revision) -> command.receipt

Cancels one current infrastructure project through Construction, Work, Actor, Resource, and World owners.

command · command.infrastructure

Request infrastructure work

command.infrastructure.request-work(settlement_id, infrastructure_id, kind) -> command.receipt

Directs one Settlement to evaluate a specific repair or network extension through current World, Construction, Work, Resource, and labor facts.

command · command.infrastructure

Set gate access policy

command.infrastructure.set-access-policy(infrastructure_id, expected_revision, access_policy_id) -> command.receipt

Changes one gate to a validated World access policy through revision-checked World authority.

namespace · command.money

Money commands

namespace command.money

Typed normal requests that move conserved currency through Resource.

command · command.money

Contribute money

command.money.contribute(actor_id, household_id, currency_definition_id, amount_minor_units, expected_authority_revision, expected_household_revision, expected_personal_custody_revision, expected_household_custody_revision) -> command.receipt

Requests one conserved transfer from a directly controlled Actor wallet to that Actor's Household.

receipt · command

Command receipt

command.receipt

Reports validation and owner completion for a typed command.

function · command

submit

command.submit(command_id, arguments, delay_ticks?) -> receipt

Submits one normal command with host-created package origin.

namespace · command.work

Work commands

namespace command.work

Typed normal requests for Work assignment, cancellation, and priority.

command · command.work

Assign work

command.work.assign(actor_id, expected_actor_revision, job_id, expected_job_revision, work_task_id, expected_task_revision, target_site_id, expected_topology_revision) -> command.receipt

Assigns one current visible Work job to one Actor through the retained order path.

command · command.work

Cancel work assignment

command.work.cancel(order_id, expected_order_revision) -> command.receipt

Cancels one current player assignment through Work.

command · command.work

Set work priority

command.work.set-priority(job_id, expected_job_revision, priority_basis_points) -> command.receipt

Sets one durable player-priority contribution on a current Work job.

namespace · developer

Developer

namespace developer

Bounded diagnostics available to development packages.

namespace · developer.capacity-policy

Developer capacity policy

namespace developer.capacity-policy

Detached scenario capacity limits, observed use, and policy revision.

query · developer.capacity-policy

Current capacity policy

developer.capacity-policy.current(filters?, cursor?, page_size?) -> query-page

Returns the current scenario capacity limits, observed use, and policy revision.

namespace · developer.performance

Developer performance

namespace developer.performance

Detached current and bounded logged frame, CPU, and process-memory diagnostics.

query · developer.performance

Current performance

developer.performance.current(filters?, cursor?, page_size?) -> query-page

Returns a continuously updated rolling frame, CPU, and process-memory snapshot.

query · developer.performance

Performance log summary

developer.performance.log(filters?, cursor?, page_size?) -> query-page

Returns min, average, and max values for the current or most recent bounded log.

query · developer.performance

Performance log samples

developer.performance.log-samples(filters?, cursor?, page_size?) -> query-page

Returns one bounded page of frame, CPU, and process-memory samples from the current or most recent log.

query · developer

Runtime diagnostics

developer.runtime(filters?, cursor?, page_size?) -> query-page

Returns bounded scheduler and frame diagnostics.

namespace · developer.tuning

Developer tuning

namespace developer.tuning

Detached runtime tuning definitions and current values.

query · developer.tuning

Runtime tuning values

developer.tuning.values(filters?, cursor?, page_size?) -> query-page

Returns registered runtime tuning definitions and their current detached values.

namespace · error

Error

namespace error

Stable script API error identities.

error · error

Action collision

error.action-collision

A logical action identity conflicts with another declaration.

error · error

Capability unavailable

error.capability-unavailable

The current runtime does not implement the requested capability.

error · error

Command budget exhausted

error.command-budget-exhausted

The package exhausted its bounded command submissions.

error · error

Command owner rejected

error.command-owner-rejected

The authoritative gameplay owner rejected the validated request.

error · error

Command queue full

error.command-queue-full

The bounded command queue cannot accept another request.

error · error

Indicator channel unavailable

error.indicator-channel-unavailable

The requested world-indicator channel is not registered or visible to the calling package origin.

error · error

Invalid action

error.invalid-action

The action identity is not declared by the calling package.

error · error

Invalid capacity policy

error.invalid-capacity-policy

The capacity-policy identity, value, or patch is invalid.

error · error

Invalid command

error.invalid-command

The command identity or argument schema is invalid.

error · error

Invalid query

error.invalid-query

The query identity, filters, cursor, or page size is invalid.

error · error

Invalid theme

error.invalid-theme

The theme contract violates scale or accessibility constraints.

error · error

Invalid tuning

error.invalid-tuning

The tuning identity, value, or patch is invalid.

error · error

Package reload failed

error.package-reload

Candidate package validation or proof composition failed.

error · error

Query budget exhausted

error.query-budget-exhausted

The package exhausted query, record, or owner-visit work.

error · error

Query contract violation

error.query-contract-violation

Returned owner data does not match the registered detached schema.

error · error

Stale tuning revision

error.stale-tuning

The tuning owner changed after the caller captured its revision.

namespace · events

Events

namespace events

Immutable facts published after committed mutation.

function · events

after

events.after(sequence, maximum_count) -> event[]

Returns bounded post-commit events after a sequence.

namespace · events.capacity-policy

Capacity-policy events

namespace events.capacity-policy

Post-commit facts produced by scenario capacity-policy changes.

event · events.capacity-policy

Capacity policy changed

events.capacity-policy.changed(policy_id, previous_limit, current_limit, current_usage, revision, origin_id, request_sequence)

Reports one scenario capacity limit only after the policy owner commits it.

namespace · events.command

Command events

namespace events.command

Post-commit facts produced by typed command execution.

event · events.command

Command completed

events.command.completed(request_sequence, command_id, origin_id, target_tick)

Reports a typed command only after its owner commits successfully.

event · events.command

Command failed

events.command.failed(request_sequence, command_id, origin_id, target_tick, error_id, detail)

Reports a typed command after its gameplay owner rejects the fixed-tick request.

function · events

ignore

events.ignore(subscription_id) -> removed

Removes one generation-scoped event subscription created by this package.

function · events

listen

events.listen(event_id, callback) -> subscription_id

Registers a generation-scoped callback for one typed post-commit event.

namespace · events.money

Money events

namespace events.money

Post-commit facts produced by conserved currency transfers.

event · events.money

Money transferred

events.money.transferred(transfer_id, actor_id, household_id, currency_definition_id, resource_id, amount_minor_units, personal_balance, household_balance, origin_id, request_sequence)

Reports a conserved currency transfer only after Resource commits both custody changes.

namespace · events.tuning

Tuning events

namespace events.tuning

Post-commit facts produced by runtime tuning changes.

event · events.tuning

Tuning changed

events.tuning.changed(tuning_id, previous_value, current_value, revision, origin_id, request_sequence)

Reports one runtime tuning value only after the tuning owner commits it.

namespace · lifecycle

Lifecycle

namespace lifecycle

Host-dispatched package lifecycle callbacks.

lifecycle · lifecycle

handle_action

handle_action(action_id, row_id?)

Receives one activated logical action and an optional selected list row ID.

lifecycle · lifecycle

initialize

initialize()

Host-dispatched bounded package lifecycle callback.

lifecycle · lifecycle

shutdown

shutdown()

Host-dispatched bounded package lifecycle callback.

lifecycle · lifecycle

suspend

suspend()

Host-dispatched bounded package lifecycle callback.

lifecycle · lifecycle

validate

validate()

Host-dispatched bounded package lifecycle callback.

namespace · performance

Performance logging

namespace performance

Host-controlled bounded performance logging for packages.

function · performance

start_logging

performance.start_logging(maximum_samples?) -> session_id

Starts one bounded host-wide performance log owned by the calling package.

function · performance

stop_logging

performance.stop_logging() -> stopped

Stops the active performance log when the calling package owns it.

namespace · restricted.actor

Restricted Actor commands

namespace restricted.actor

Development-only Actor control requests routed through the normal owner.

command · restricted.actor

Crisis override

restricted.actor.crisis-override(actor_id, expected_authority_revision, expected_actor_revision) -> command.receipt

Requests development-only crisis control of one Actor through ControlAuthority.

namespace · restricted.capacity-policy

Restricted capacity-policy commands

namespace restricted.capacity-policy

Development-only scenario capacity requests routed through the App owner.

command · restricted.capacity-policy

Set capacity-policy limit

restricted.capacity-policy.set-limit(policy_id, value, expected_revision) -> command.receipt

Requests one revision-checked scenario capacity-limit change from a development package.

namespace · restricted.command

Restricted command submission

namespace restricted.command

Development-only entry point for registered restricted commands.

function · restricted.command

submit

restricted.command.submit(command_id, arguments, delay_ticks?) -> receipt

Submits one restricted command from a development package.

namespace · restricted.tuning

Restricted tuning commands

namespace restricted.tuning

Development-only runtime tuning requests routed through the App owner.

command · restricted.tuning

Set tuning value

restricted.tuning.set-value(tuning_id, value, expected_revision) -> command.receipt

Requests one validated live tuning change from a development package.

namespace · ui

Interface

namespace ui

Backend-neutral semantic interface composition functions.

namespace · ui.action

Interface actions

namespace ui.action

Stable logical action identities independent of physical input.

namespace · ui.action.actor

Actor interface actions

namespace ui.action.actor

Logical actions used by the standard Actor interface.

action · ui.action.actor

actor.contribute-one

ui.action.actor.contribute-one

Contributes one currency unit from the selected actor to their household.

action · ui.action.actor

actor.release-control

ui.action.actor.release-control

Returns the selected actor to autonomous control.

action · ui.action.actor

actor.take-control

ui.action.actor.take-control

Requests direct control of the selected actor.

namespace · ui.action.composition-proof

Composition proof actions

namespace ui.action.composition-proof

Logical actions used by the development replacement proof.

action · ui.action.composition-proof

composition-proof.crisis-override

ui.action.composition-proof.crisis-override

Requests the development-restricted crisis control transition.

action · ui.action.composition-proof

composition-proof.take-control

ui.action.composition-proof.take-control

Requests normal direct control from the composition proof surface.

action · ui.action.composition-proof

composition-proof.use-alternate

ui.action.composition-proof.use-alternate

Selects the alternate composition proof player HUD provider.

namespace · ui.action.empire

Empire interface actions

namespace ui.action.empire

Logical actions used by the standard regional strategy view.

action · ui.action.empire

empire.close

ui.action.empire.close

Closes the standard regional strategy view.

action · ui.action.empire

empire.map-select

ui.action.empire.map-select

Selects one stable World-grid position on the regional map.

action · ui.action.empire

empire.open

ui.action.empire.open

Opens the standard regional strategy view.

action · ui.action.empire

empire.select-faction

ui.action.empire.select-faction

Selects one stable Faction standing row.

action · ui.action.empire

empire.select-lens

ui.action.empire.select-lens

Selects one transient regional map lens.

action · ui.action.empire

empire.select-route

ui.action.empire.select-route

Selects one stable known route for regional inspection.

namespace · ui.action.events

Event-feed actions

namespace ui.action.events

Logical actions used by the standard causal history feed.

action · ui.action.events

events.close

ui.action.events.close

Closes the standard causal event feed.

action · ui.action.events

events.open

ui.action.events.open

Opens the standard causal event feed.

action · ui.action.events

events.select-entry

ui.action.events.select-entry

Selects one stable event row and requests its map location.

action · ui.action.events

events.select-tab

ui.action.events.select-tab

Selects one stable event-feed category.

namespace · ui.action.packages

Package actions

namespace ui.action.packages

Logical host actions that operate on the package graph.

action · ui.action.packages

reload

ui.action.packages.reload

Reloads the complete script package graph at a safe frame boundary.

action · ui.action

resource-counts.toggle

ui.action.resource-counts.toggle

Logical Controls-owned action for resource panel visibility.

namespace · ui.action.selection

Selection interface actions

namespace ui.action.selection

Logical actions used by the standard selection interface.

action · ui.action.selection

selection.focus

ui.action.selection.focus

Focuses one stable Actor row in the current multiple selection.

namespace · ui.action.settlement

Settlement interface actions

namespace ui.action.settlement

Logical actions used by standard settlement direction.

action · ui.action.settlement

settlement.cancel-construction

ui.action.settlement.cancel-construction

Requests cancellation of the displayed active construction project.

action · ui.action.settlement

settlement.close-sheet

ui.action.settlement.close-sheet

Closes the settlement overview sheet.

action · ui.action.settlement

settlement.designate

ui.action.settlement.designate

Requests designation of the displayed settlement project.

action · ui.action.settlement

settlement.focus-priority-high

ui.action.settlement.focus-priority-high

Raises the current village project's player priority.

action · ui.action.settlement

settlement.focus-priority-normal

ui.action.settlement.focus-priority-normal

Returns the current village project to normal player priority.

action · ui.action.settlement

settlement.open-sheet

ui.action.settlement.open-sheet

Opens the settlement overview sheet.

action · ui.action.settlement

settlement.placement-begin

ui.action.settlement.placement-begin

Begins placement of the displayed authored settlement project.

action · ui.action.settlement

settlement.placement-cancel

ui.action.settlement.placement-cancel

Cancels the current construction placement preview.

action · ui.action.settlement

settlement.placement-east

ui.action.settlement.placement-east

Moves the construction cursor one World-grid cell east.

action · ui.action.settlement

settlement.placement-north

ui.action.settlement.placement-north

Moves the construction cursor one World-grid cell north.

action · ui.action.settlement

settlement.placement-rotate

ui.action.settlement.placement-rotate

Rotates the current construction placement preview clockwise.

action · ui.action.settlement

settlement.placement-south

ui.action.settlement.placement-south

Moves the construction cursor one World-grid cell south.

action · ui.action.settlement

settlement.placement-west

ui.action.settlement.placement-west

Moves the construction cursor one World-grid cell west.

action · ui.action.settlement

settlement.project-next

ui.action.settlement.project-next

Selects the next authored settlement project.

action · ui.action.settlement

settlement.project-previous

ui.action.settlement.project-previous

Selects the previous authored settlement project.

action · ui.action.settlement

settlement.select-tab

ui.action.settlement.select-tab

Selects one stable settlement sheet tab.

namespace · ui.action.surface

Spatial surface actions

namespace ui.action.surface

Logical actions emitted by bounded spatial interface surfaces.

action · ui.action.surface

surface.minimap-select

ui.action.surface.minimap-select

Selects one stable World-grid position from the minimap.

namespace · ui.action.tuning-bench

Tuning bench actions

namespace ui.action.tuning-bench

Logical actions used by the first-party development tuning panel.

action · ui.action.tuning-bench

tuning-bench.construction-010

ui.action.tuning-bench.construction-010

Sets base construction throughput to 10 work units per second.

action · ui.action.tuning-bench

tuning-bench.construction-020

ui.action.tuning-bench.construction-020

Sets base construction throughput to 20 work units per second.

action · ui.action.tuning-bench

tuning-bench.construction-040

ui.action.tuning-bench.construction-040

Sets base construction throughput to 40 work units per second.

action · ui.action.tuning-bench

tuning-bench.fps-030

ui.action.tuning-bench.fps-030

Sets the presentation frame target to 30 frames per second.

action · ui.action.tuning-bench

tuning-bench.fps-060

ui.action.tuning-bench.fps-060

Sets the presentation frame target to 60 frames per second.

action · ui.action.tuning-bench

tuning-bench.fps-120

ui.action.tuning-bench.fps-120

Sets the presentation frame target to 120 frames per second.

action · ui.action.tuning-bench

tuning-bench.movement-0750

ui.action.tuning-bench.movement-0750

Sets the base physical movement rate to 0.75 meters per second.

action · ui.action.tuning-bench

tuning-bench.movement-1400

ui.action.tuning-bench.movement-1400

Sets the base physical movement rate to 1.40 meters per second.

action · ui.action.tuning-bench

tuning-bench.movement-2500

ui.action.tuning-bench.movement-2500

Sets the base physical movement rate to 2.50 meters per second.

action · ui.action.tuning-bench

tuning-bench.time-050

ui.action.tuning-bench.time-050

Sets simulation wall-clock pace to 0.5x.

action · ui.action.tuning-bench

tuning-bench.time-100

ui.action.tuning-bench.time-100

Sets simulation wall-clock pace to 1x.

action · ui.action.tuning-bench

tuning-bench.time-200

ui.action.tuning-bench.time-200

Sets simulation wall-clock pace to 2x.

namespace · ui.action.work

Work interface actions

namespace ui.action.work

Logical actions used by standard work direction.

action · ui.action.work

work.assign

ui.action.work.assign

Requests assignment of the selected actor to the displayed Work target.

action · ui.action.work

work.cancel

ui.action.work.cancel

Requests cancellation of the selected actor's current Work assignment.

action · ui.action.work

work.next

ui.action.work.next

Selects the next actionable Work target.

action · ui.action.work

work.previous

ui.action.work.previous

Selects the previous actionable Work target.

action · ui.action.work

work.priority-high

ui.action.work.priority-high

Raises the displayed Work target's player priority.

action · ui.action.work

work.priority-normal

ui.action.work.priority-normal

Returns the displayed Work target to normal player priority.

function · ui

begin_panel

ui.begin_panel(panel_contract)

Begins one bounded backend-neutral semantic panel.

function · ui

begin_row_group

ui.begin_row_group()

Begins one non-nested horizontal widget group.

function · ui

button

ui.button(label, action_id, semantic_label, focus_order?)

Records one semantic button bound to a logical action.

function · ui

end_panel

ui.end_panel()

Closes the current semantic panel.

function · ui

end_row_group

ui.end_row_group()

Closes the current horizontal widget group.

function · ui

explain

ui.explain(text)

Records one wrapped full-width explanation paragraph.

function · ui

ghost

ui.ghost(origin_x, origin_y, width, height, valid, caption)

Records one optional placement-footprint ghost.

type · ui.intent

camera

{ cell_x, cell_y, center }

One optional request to center the Render-owned camera on a World cell.

type · ui.intent

ghost

{ origin_x, origin_y, width_cells, height_cells, valid, caption }

One optional validated construction-footprint preview.

namespace · ui.layout

Interface layout

namespace ui.layout

Scale-aware semantic layout contracts.

type · ui.layout

anchored

top-left | top-right | bottom-left | bottom-right | center

Scale-aware layout with bounds and a semantic screen anchor.

type · ui.layout

canvas

mode = canvas

Viewport-filling non-movable panel for a spatial surface behind frame panels.

type · ui.layout

dock

top | bottom | left | right

Fixed edge dock that may reserve world viewport space.

type · ui.layout

sheet

mode = sheet, margin = logical-pixels

Centered backdrop panel constrained by a bounded viewport margin.

function · ui

list

ui.list(action_id, rows, options?)

Records one bounded selectable list with stable row identities.

function · ui

menu

ui.menu(label, state?)

Records one menu heading.

function · ui

pan_camera

ui.pan_camera(cell_x, cell_y)

Records one optional camera-centering intent.

function · ui

progress

ui.progress(label, value, maximum)

Records one bounded progress value.

function · ui

row

ui.row(label, value)

Records one labeled value row.

function · ui

select_provider

ui.select_provider(surface_id, provider_id)

Requests one declared provider for a replaceable UI surface.

function · ui

separator

ui.separator()

Records a vertical group separator or horizontal panel separator.

function · ui

set_theme

ui.set_theme(theme_contract)

Selects typed scale and accessibility theme constraints.

namespace · ui.slot

Interface slots

namespace ui.slot

Versioned extension points inside registered surfaces.

slot · ui.slot

panels

slot(maximum=32)

Stable UI composition surface.

slot · ui.slot

toolbar

slot(maximum=32)

Stable UI composition surface.

slot · ui.slot

status

slot(maximum=8)

Stable UI composition surface.

function · ui

spacer

ui.spacer()

Consumes remaining width inside a horizontal widget group.

function · ui

surface

ui.surface(kind, aspect, action_id)

Records one bounded spatial presentation surface.

function · ui

stat

ui.stat(value, label)

Records one compact figure with a caption.

namespace · ui.surface

Interface surfaces

namespace ui.surface

Versioned replaceable and non-replaceable interface surfaces.

type · ui.surface

kind

minimap | region_map | world_thumbnail

Bounded spatial surface kind for overview and navigation presentation.

surface · ui.surface

panel

panel_contract

Movable or fixed semantic panel with scale-aware anchored layout.

surface · ui.surface

ui.surface.recovery

surface(context_version=1)

Stable UI composition surface.

function · ui

tabs

ui.tabs(action_id, labels, active_index)

Records one bounded tab strip before a panel's widgets.

function · ui

text

ui.text(label, value?)

Records one text widget.

namespace · ui.theme.color

Theme colors

namespace ui.theme.color

Semantic colors with host-owned accessibility fallback.

theme_token · ui.theme.color

accent

ui.theme.color.accent

Typed semantic color token with host-owned accessibility fallback.

theme_token · ui.theme.color

danger

ui.theme.color.danger

Typed semantic color token with host-owned accessibility fallback.

theme_token · ui.theme.color

success

ui.theme.color.success

Typed semantic color token with host-owned accessibility fallback.

theme_token · ui.theme.color

text-muted

ui.theme.color.text-muted

Typed semantic color token with host-owned accessibility fallback.

theme_token · ui.theme.color

text-primary

ui.theme.color.text-primary

Typed semantic color token with host-owned accessibility fallback.

theme_token · ui.theme.color

warning

ui.theme.color.warning

Typed semantic color token with host-owned accessibility fallback.

function · ui

tooltip

ui.tooltip(label, text)

Records tooltip content.

namespace · ui.widget

Interface widgets

namespace ui.widget

Backend-neutral semantic widgets recorded as detached intent.

widget · ui.widget

button

ui.button(label, action_id, semantic_label, focus_order?)

Keyboard-focusable logical-action button.

widget · ui.widget

explain

ui.explain(text)

Full-width wrapped muted explanation paragraph.

widget · ui.widget

list

ui.list(action_id, rows, options?)

Scroll-bounded selectable rows with stable activation identities.

type · ui.widget

list-row

{ id, label, value, color?, selected?, progress? }

One bounded list row with stable identity and optional progress.

widget · ui.widget

menu

ui.menu(label, state?)

Semantic menu heading.

widget · ui.widget

progress

ui.progress(label, value, maximum)

Bounded progress with a non-color label.

widget · ui.widget

row

ui.row(label, value)

Labeled value row.

widget · ui.widget

row-group

ui.begin_row_group() ... ui.end_row_group()

Non-nested horizontal widget group with bounded structural entries.

widget · ui.widget

separator

ui.separator()

Orientation-aware separator for panel or row-group layout.

widget · ui.widget

spacer

ui.spacer()

Remaining-width spacer for a horizontal group.

widget · ui.widget

stat

ui.stat(value, label)

Compact figure with a caption for persistent HUD summaries.

widget · ui.widget

surface

ui.surface(kind, aspect, action_id)

Bounded spatial overview that emits a stable World-cell activation.

widget · ui.widget

tabs

ui.tabs(action_id, labels, active_index)

Bounded tab labels with one active index and stable action identity.

widget · ui.widget

text

ui.text(label, value?)

Semantic text.

widget · ui.widget

tooltip

ui.tooltip(label, text)

Hover and focus help content.

namespace · world

World queries

namespace world

Entry point for registered detached world queries.

namespace · world.actor

Actor queries

namespace world.actor

Detached current Actor facts.

query · world.actor

Actor cargo

world.actor.cargo(filters?, cursor?, page_size?) -> query-page

Returns paginated detached resource quantities carried by one actor.

query · world.actor

Actor information

world.actor.info(filters?, cursor?, page_size?) -> query-page

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

query · world.actor

Actor job choices

world.actor.job-choices(filters?, cursor?, page_size?) -> query-page

Pages one Actor's retained current job alternatives and complete personal scoring evidence.

query · world.actor

Actor needs

world.actor.needs(filters?, cursor?, page_size?) -> query-page

Returns the six current pressure values for one actor.

query · world.actor

Actor relationships

world.actor.relationships(filters?, cursor?, page_size?) -> query-page

Returns one Actor's retained social relationships in stable owner order.

query · world.actor

Actor routine

world.actor.routine(filters?, cursor?, page_size?) -> query-page

Returns one Actor's retained expected activity, actual choice, and reason.

query · world.actor

Actor work status

world.actor.status(filters?, cursor?, page_size?) -> query-page

Returns detached authored identity, health, plan, task, work stage, progress, and destination facts for one actor.

query · world.actor

Actor wealth

world.actor.wealth(filters?, cursor?, page_size?) -> query-page

Returns paginated detached personal currency balances for one actor.

namespace · world.building

Building queries

namespace world.building

Detached current Construction-owned building facts.

query · world.building

Building information

world.building.info(filters?, cursor?, page_size?) -> query-page

Returns one detached building record selected by stable building identity.

namespace · world.calendar

Calendar queries

namespace world.calendar

Detached current calendar and clock facts.

query · world.calendar

World calendar

world.calendar.current(filters?, cursor?, page_size?) -> query-page

Returns the current detached calendar day, clock, season, and day kind.

namespace · world.construction

Construction queries

namespace world.construction

Detached current construction progress and blockage facts.

query · world.construction

Active construction

world.construction.active(filters?, cursor?, page_size?) -> query-page

Returns a bounded stable-ID window of current construction projects.

query · world.construction

Construction placement preview

world.construction.placement-preview(filters?, cursor?, page_size?) -> query-page

Validates one authored building footprint against the World grid and retained Construction occupancy without mutating either owner.

query · world.construction

Construction progress

world.construction.progress(filters?, cursor?, page_size?) -> query-page

Returns detached physical work, assigned-Actor throughput, duration, and blockage facts for one construction project.

namespace · world.expedition

Expedition queries

namespace world.expedition

Detached ScoutingOrder and Party expedition facts.

query · world.expedition

Expedition records

world.expedition.records(filters?, cursor?, page_size?) -> query-page

Returns bounded ScoutingOrder-owned expedition state with Party, supply, route, and discovery facts.

namespace · world.faction

Faction queries

namespace world.faction

Detached Faction-owned strategy and standing facts.

query · world.faction

Faction standings

world.faction.standings(filters?, cursor?, page_size?) -> query-page

Returns bounded Faction-owned identity, strategy, territory, and relation facts.

namespace · world.household

Household queries

namespace world.household

Detached current Household facts and capability boundaries.

query · world.household

Household for actor

world.household.for-actor(filters?, cursor?, page_size?) -> query-page

Returns detached household membership, strain, residence, and latest care facts for one actor.

query · world.household

Household wealth

world.household.wealth(filters?, cursor?, page_size?) -> query-page

Returns paginated detached currency balances held by one household.

namespace · world.infrastructure

Local infrastructure queries

namespace world.infrastructure

Detached World-owned road, fence, gate, anchor, and condition facts.

query · world.infrastructure

Infrastructure construction

world.infrastructure.construction(filters?, cursor?, page_size?) -> query-page

Returns bounded Construction-owned infrastructure project, worker, Work identity, progress, resource-owner, and failure facts.

query · world.infrastructure

World local infrastructure

world.infrastructure.local(filters?, cursor?, page_size?) -> query-page

Returns bounded World-owned local road, fence, and gate plans with typed connection anchors, immutable geometry counts, material, access, condition, and lifecycle.

query · world.infrastructure

Infrastructure maintenance

world.infrastructure.maintenance(filters?, cursor?, page_size?) -> query-page

Returns the latest Settlement-owned repair or extension choice with the bounded World wear evidence and physical material facts that informed it.

namespace · world.job

Job queries

namespace world.job

Detached current Work-owned job facts.

query · world.job

Job information

world.job.info(filters?, cursor?, page_size?) -> query-page

Returns one detached work job selected by stable job identity.

namespace · world.land

Land queries

namespace world.land

Detached World-owned land area, condition, crop, and lifecycle facts.

query · world.land

World land areas

world.land.areas(filters?, cursor?, page_size?) -> query-page

Returns stable cell rows for World-owned irregular land areas and their retained condition.

query · world.land

World land enclosures

world.land.enclosures(filters?, cursor?, page_size?) -> query-page

Returns one bounded derived enclosure record per World land area from authoritative area boundaries and operational fence and gate geometry.

namespace · world.landscape

Landscape queries

namespace world.landscape

Detached World-owned landscape clusters and feature placement facts.

query · world.landscape

World landscape features

world.landscape.features(filters?, cursor?, page_size?) -> query-page

Returns bounded World-owned landscape identities, cluster membership, placement, and stable variation inputs without exposing render frame choices as simulation truth.

namespace · world.order

Order queries

namespace world.order

Detached current Work-owned assignment order facts.

query · world.order

Order information

world.order.info(filters?, cursor?, page_size?) -> query-page

Returns one detached assignment order selected by stable order identity.

namespace · world.project

Project queries

namespace world.project

Detached authored alternatives and retained autonomous project decisions.

query · world.project

Authored project alternatives

world.project.alternatives(filters?, cursor?, page_size?) -> query-page

Returns the settlement's authored building alternatives and immutable construction facts without selecting or proposing a project.

query · world.project

Project proposals

world.project.proposals(filters?, cursor?, page_size?) -> query-page

Returns the latest retained autonomous project decision and its complete bounded candidate trace for one settlement.

function · world

query

world.query(query_id, request?) -> query_result

Executes one registered detached query.

query · world.region

Known regions

world.region.known(filters?, cursor?, page_size?) -> query-page

Returns the observer's bounded current or stale regional environment reports.

namespace · world.resource

Resource queries

namespace world.resource

Detached current resource totals and reservation facts.

query · world.resource

Resource counts

world.resource.counts(filters?, cursor?, page_size?) -> query-page

Returns paginated detached world-wide totals for registered resources.

query · world.resource

Known regional resources

world.resource.known(filters?, cursor?, page_size?) -> query-page

Returns bounded renewable-resource reports with their known site and map position.

namespace · world.route

Regional route queries

namespace world.route

Detached observer-known route and endpoint facts.

query · world.route

Known regional routes

world.route.known(filters?, cursor?, page_size?) -> query-page

Returns the observer's bounded route knowledge with topology endpoints and current reported confidence, pressure, and danger.

namespace · world.selection

Selection queries

namespace world.selection

Detached stable identities selected by presentation.

query · world.selection

Current selection

world.selection.current(filters?, cursor?, page_size?) -> query-page

Returns the stable identities selected by the presentation owner.

namespace · world.settlement

Settlement queries

namespace world.settlement

Detached current Settlement and supply facts.

query · world.settlement

Settlement capability

world.settlement.capability(filters?, cursor?, page_size?) -> query-page

Returns current membership, infrastructure, defense, and revision facts for one settlement.

query · world.settlement

Village demography

world.settlement.demography(filters?, cursor?, page_size?) -> query-page

Returns one detached summary of current population viability, retained life-course transitions, authored bounds, and the current growth blockage.

query · world.settlement

Settlement economy

world.settlement.economy(filters?, cursor?, page_size?) -> query-page

Returns one detached summary of the village's current production, pay, household market, and regional delivery state.

query · world.settlement

Settlement enterprise options

world.settlement.enterprise-options(filters?, cursor?, page_size?) -> query-page

Returns the latest Settlement-owned production and trade portfolio, direct viability evidence, selection, and authoritative commitment lifecycle.

query · world.settlement

Settlement environment

world.settlement.environment(filters?, cursor?, page_size?) -> query-page

Returns current settlement-region weather, ecology, and the resulting routine adaptation.

query · world.settlement

Settlement failure pressure

world.settlement.failure-pressure(filters?, cursor?, page_size?) -> query-page

Returns defense severity and maintenance pressure for one settlement.

query · world.settlement

Village families

world.settlement.families(filters?, cursor?, page_size?) -> query-page

Returns current Household membership, life-stage counts, residence, and latest change together with physical pantry and domestic-work facts.

query · world.settlement

Settlement for actor

world.settlement.for-actor(filters?, cursor?, page_size?) -> query-page

Returns capability facts for the settlement that contains one actor.

query · world.settlement

Settlement goals

world.settlement.goals(filters?, cursor?, page_size?) -> query-page

Returns the latest Settlement-owned goal portfolio, including committed goals and rejected or deferred alternatives.

query · world.settlement

Settlement housing executions

world.settlement.housing-executions(filters?, cursor?, page_size?) -> query-page

Returns the bounded Settlement-owned lifecycle that binds a selected housing method to its Household and authoritative Construction or completed Building outcome.

query · world.settlement

Household housing methods

world.settlement.housing-methods(filters?, cursor?, page_size?) -> query-page

Returns Settlement-owned repair, extension, shared-residence, and new-construction options from the latest current facts, including feasibility, score, selection, cost, capacity, evidence revisions, and direct rejection reason.

query · world.settlement

Settlement housing parcels

world.settlement.housing-parcels(filters?, cursor?, page_size?) -> query-page

Returns Settlement-owned physically feasible new-housing parcel alternatives from the latest selected new-construction method, including the exact composite key, placement, source revisions, score components, selection, and rejection reason.

query · world.settlement

Household housing pressure

world.settlement.housing-pressure(filters?, cursor?, page_size?) -> query-page

Returns the latest Settlement-owned housing pressure for each assessed household, including current and forecast capacity, condition, privacy, access, wealth, owner revisions, and direct reason.

query · world.settlement

Village life events

world.settlement.life-events(filters?, cursor?, page_size?) -> query-page

Returns newest-first partnership, separation, birth, immigration, emigration, and death facts derived from their authoritative owners.

query · world.settlement

Loaded settlements

world.settlement.list(filters?, cursor?, page_size?) -> query-page

Returns a bounded stable-ID page of loaded Settlement capability facts.

query · world.settlement

Settlement needs

world.settlement.needs(filters?, cursor?, page_size?) -> query-page

Returns the latest retained settlement needs, forecasts, severity, evidence count, and direct reason for one settlement.

query · world.settlement

Settlement plans

world.settlement.plans(filters?, cursor?, page_size?) -> query-page

Returns Settlement-owned dependency plans, requirement state, prerequisite count, and exact authoritative owner bindings.

query · world.settlement

Settlement production options

world.settlement.production-options(filters?, cursor?, page_size?) -> query-page

Returns the latest Settlement-owned production alternatives, physical feasibility, scores, selection, and exact Production owner bindings.

query · world.settlement

Settlement stored resources

world.settlement.resources(filters?, cursor?, page_size?) -> query-page

Returns paginated detached quantities physically held in one Settlement's stockpiles.

query · world.settlement

Settlement shortages

world.settlement.shortages(filters?, cursor?, page_size?) -> query-page

Returns active supply alerts for one supply chain.

query · world.settlement

Village social chronicle

world.settlement.social-chronicle(filters?, cursor?, page_size?) -> query-page

Returns recent completed village conversations, support, and disagreements.

query · world.settlement

Settlement spatial districts

world.settlement.spatial-districts(filters?, cursor?, page_size?) -> query-page

Returns descriptive districts inferred by Settlement from current physical anchor proximity and services. District rows are read-only descriptions, not land authority.

query · world.settlement

Settlement spatial executions

world.settlement.spatial-executions(filters?, cursor?, page_size?) -> query-page

Returns the bounded Settlement-owned lifecycle binding selected spatial options to authoritative Building Construction, Infrastructure Construction, or Land conversion.

query · world.settlement

Settlement spatial options

world.settlement.spatial-options(filters?, cursor?, page_size?) -> query-page

Returns the latest Settlement-owned spatial service portfolio, including current coverage, every facility, field, or connection alternative, exact parcel or anchor evidence, selection, score, and direct rejection reason.

query · world.settlement

Settlement supply options

world.settlement.supply-options(filters?, cursor?, page_size?) -> query-page

Returns the latest Settlement-owned physical supply alternatives, direct rejection reasons, scores, selections, and exact Supply owner bindings.

namespace · world.work

Work direction queries

namespace world.work

Detached actionable Work targets and current assignments.

query · world.work

Current work assignment

world.work.assignment(filters?, cursor?, page_size?) -> query-page

Returns the latest live player assignment retained for one Actor.

query · world.work

Work targets

world.work.targets(filters?, cursor?, page_size?) -> query-page

Returns bounded detached gathering and construction jobs valid for one Actor.

namespace · world_indicators

World indicators

namespace world_indicators

Host-owned presentation channels composed from detached world facts.

function · world_indicators

channels

world_indicators.channels() -> channel[]

Lists world-indicator channels available to the calling package.

function · world_indicators

is_visible

world_indicators.is_visible(channel_id) -> visible

Returns whether one available world-indicator channel is visible.

function · world_indicators

set_visible

world_indicators.set_visible(channel_id, visible) -> changed

Changes per-session visibility for one authorized world-indicator channel.

Namespaces

Kinds