API reference

Declares the properties read by the engine. Keep this exact name when silencing lint.

Declares the dialogue entries read by the engine. Keep this exact name when silencing lint.

Selects the light-only OnUsed profile: 2048 charged callbacks, 256 distinct staged lights. Tier-1 uses and dialogue effects cannot coexist. Steps and VM allocation limits stay unchanged.

Defines the use handler. Light declarations select copied object/light access and light-only proposals; other handlers retain the uses transaction. Dialogue entries receive opaque EventContext.

Runs after a validated open commits. No return values; counter or light-only effects.

Runs after a close commits, including Container access loss or departure.

Runs on Area membership entry after Module join or old Area exit.

Runs on Area departure before destination entry or Module leave.

Runs after restore and recovery departures, before new joins.

Runs before the joining Character's Area entry.

Runs after the departing Character's Area exit.

Returns the captured first admitted start flag, saved atomically with the start event, including a faulting start.

Defining or accessing this name faults as reserved. Custom event handlers are deferred.

The Script host, with exported configuration and copied object members in the light profile.

Reads an exported property from the host's effective configuration. Unknown keys fault; metadata table edits cannot change the copied configuration.

Identifies the Script host within this invocation. Equality is canonical; no persistent ID or World pointer is exposed.

Defining or accessing this name faults as reserved. Timers are deferred.

The handler first argument; in light OnUsed it represents the using Character. It cannot read self configuration.

The event's copied Character name remains available after disconnect or transfer.

Queries copied objects in the event host Area, in instanced-placement order.

Returns a dense array in placement order. More than 64 matches faults instead of truncating.

Returns the first object in placement order or nil, even when more than 64 match.

Defining or accessing this name faults as reserved. Custom event delivery is deferred.

A copied object; equality is canonical. No persistent identity or live World access.

The copied effective object name.

Effective Blueprint and placement tags in sorted order. Editing the copy changes no object.

Tests copied effective tag membership.

Returns a dense array in ComponentId order. Self lights require the self capability.

Returns a named light or nil. Duplicate matching names fault.

Reads copied baseline plus staged changes. Any fault discards every write. World validates the stamped proposal at commit.

Stages enabled state; subsequent reads see the write.

Stages intensity; signed zero is canonicalized and subsequent reads see float32.

Returns a copied color. Assign the complete r/g/b table to replace it; editing a returned table does not stage writes.

The copied light kind.

The copied light range.

Whether the authored light casts shadows.

Reads copied player facts and stages the existing declared gold reward. It never accesses a live World object.

Returns total level, or nil when the copied player has no build.

Returns the copied class level, or nil without a build. An unknown rules key with a build faults.

Returns the copied alignment, or nil when unavailable.

Returns copied skill ranks, or nil without a build. An unknown rules key with a build faults.

Returns whether the copied build can use a skill, or nil without a build. Unknown rules keys fault when a build exists.

Returns copied gold including this entry's staged gold proposal.

Returns the copied inventory count for a Blueprint, or zero when absent.

Stages gold within the entry's literal give_gold envelope. Later Gold reads see it; faults discard all proposals.

Reads the invocation's declared quest facts from copied context.

Returns the copied stage of a declared quest. Undeclared quests fault.

Returns whether a declared quest is complete. Undeclared quests fault.

Reads declared conversation facts and stages bounded variable proposals over copied input.

Returns a declared flag, defaulting to zero when unset. Undeclared names fault.

Returns a declared variable, including this entry's proposals, or zero when unset. Undeclared names fault.

Returns whether the declared reward was claimed. Undeclared names fault.

Returns passed or failed for a resolved declared check, or nil when unresolved. Undeclared names fault.

Returns an entry parameter. Asset parameters are copied UUID strings; undeclared parameters fault. Tooling uses any because the type is supplied by the entry's literal parameter declaration.

Stages replacement of a declared variable for an effect entry. Later reads see the staged value; conditions cannot propose.

Stages addition to a declared variable for an effect entry. The resulting value clamps to the variable bounds and later reads see it.

Reads the copied committed use count. Pending proposals do not change this value.

Proposes the next durable use count. A successful OnUsed must publish the same count; any later fault discards the proposal.

Proposes the public use count. It must equal SetUses at successful completion of the transaction.