function · ui
ghost
Records one optional placement-footprint ghost.
ui.ghost(origin_x, origin_y, width, height, valid, caption)- Stable ID
ui.ghost- 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 at most one bounded placement-footprint preview outside a panel. Render draws the footprint using valid or blocked presentation without designating construction.
Parameters
- origin_x and origin_y: signed World-grid origin.
- width and height: positive footprint bounds with at most 64 cells total.
- valid: whether the preview is currently available.
- caption: bounded player-facing validation detail.
Returns
No gameplay value. The call records one detached world-overlay intent.
Cost
At most 64 outlined World cells during presentation.
Fields
This symbol has no fields.
Errors
- None
Examples
ui.ghost(8, 3, 2, 2, preview.valid, preview.detail)API history
- 1.19.0: Placement ghost intent added for Phase 19Q9E.