TypedDict: TriggerVolumeOptions

Options used to create a Script-Owned trigger volume.

class TriggerVolumeOptions(TypedDict)

Related API: BlockVolume, DimensionInput

Properties

id: NotRequired[Optional[str]]

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

dimension: DimensionInput

Dimension containing the trigger volume.

Related API: DimensionInput

volume: BlockVolume

Inclusive block volume sampled by the trigger.

Related API: BlockVolume

players_only: NotRequired[Literal[True]]

Non-player trigger sources are not implemented yet.

tick_interval: NotRequired[int]

Number of ticks between membership samples.