function · ui
surface
Records one bounded spatial presentation surface.
ui.surface(kind, aspect, action_id)- Stable ID
ui.spatial-surface- Owner
- app.ScriptPackageHost
- Authority
- presentation
- Timing
- composition
- Availability
- Phase 14 package callbacks
- Side effects
- records bounded detached presentation intent
- Determinism
- Host-created package identity and per-callback budgets.
- Introduced
- 1.19.0
Usage
Declare one bounded minimap, region map, or world thumbnail inside the open panel. Activation returns a stable comma-separated World-cell coordinate as row_id.
Parameters
- kind: minimap, region_map, or world_thumbnail.
- aspect: finite aspect ratio from 0.5 through 4.0.
- action_id: stable logical action for spatial activation.
Returns
No gameplay value. The call appends detached spatial widget intent.
Cost
One widget and its action identity against the composition budgets.
Fields
This symbol has no fields.
Errors
- None
Examples
ui.surface("minimap", 1.6, "ui.action.surface.minimap-select")API history
- 1.19.0: Bounded spatial surfaces added for Phase 19Q9E.