type · ui.intent

ghost

One optional validated construction-footprint preview.

{ origin_x, origin_y, width_cells, height_cells, valid, caption }
Stable ID
ui.intent.ghost
Owner
app.ScriptUiIntentBuffer
Authority
presentation
Timing
composition
Availability
Phase 19Q9E
Side effects
Records detached presentation intent.
Determinism
At most one validated intent per composition.
Introduced
1.19.0

Usage

Represent one validated placement footprint for Render. The record is presentation-only and has no save or construction authority.

Parameters

Returns

A bounded detached placement-ghost intent.

Cost

At most one record and 64 rendered cells per composition.

Fields

This symbol has no fields.

Errors

Examples

ui.ghost(x, y, width, height, preview.valid, preview.detail)

API history

Related symbols

Project references