Skip to main content

Interface: TriggerVolume

A Script-Owned, tick-sampled trigger over an inclusive block volume.

Properties​

afterEvents​

readonly afterEvents: TriggerVolumeAfterEvents

Trigger-specific event streams.

dimension​

readonly dimension: Dimension

Dimension sampled by the trigger.

id​

readonly id: string

Script-local trigger identifier.

isActive​

readonly isActive: boolean

Whether the trigger is still sampling and emitting events.

volume​

readonly volume: BlockVolume

Inclusive volume sampled by the trigger.

Methods​

contains()​

contains(entityOrLocation): boolean

Tests a live entity or coordinate against this trigger.

Parameters​

entityOrLocation​

EntityOrLocationInput

Returns​

boolean

dispose()​

dispose(): void

Stops sampling, removes handlers, and releases Script-Owned state.

Returns​

void

getPlayers()​

getPlayers(): readonly Player[]

Returns the players present at the latest membership sample.

Returns​

readonly Player[]