Kind: function

All documented function symbols.

function · command

submit

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

Submits one normal command with host-created package origin.

function · events

after

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

Returns bounded post-commit events after a sequence.

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.

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.

function · restricted.command

submit

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

Submits one restricted command from a development package.

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.

function · ui

list

ui.list(action_id, rows, options?)

Records one bounded selectable list with stable row identities.

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.

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.

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.

function · ui

tooltip

ui.tooltip(label, text)

Records tooltip content.

function · world

query

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

Executes one registered detached query.

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.