Skip to main content

Type Alias: TriggerVolumeOptions

TriggerVolumeOptions = object

Options used to create a Script-Owned trigger volume.

Properties

dimension

dimension: DimensionInput

Dimension containing the trigger volume.


id?

optional id?: string | null

Optional Script-local identifier; the runtime creates one when omitted.


playersOnly?

optional playersOnly?: true

Non-player trigger sources are not implemented yet.


tickInterval?

optional tickInterval?: number

Number of ticks between membership samples.


volume

volume: BlockVolume

Inclusive block volume sampled by the trigger.