Protocol: TriggerVolume

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

class TriggerVolume(Protocol)

Properties

@property
def id(self) -> str:

Script-local trigger identifier.

@property
def dimension(self) -> Dimension:

Dimension sampled by the trigger.

Related API: Dimension

@property
def volume(self) -> BlockVolume:

Inclusive volume sampled by the trigger.

Related API: BlockVolume

@property
def is_active(self) -> bool:

Whether the trigger is still sampling and emitting events.

@property
def after_events(self) -> TriggerVolumeAfterEvents:

Trigger-specific event streams.

Related API: TriggerVolumeAfterEvents

def get_players(self) -> Sequence[Player]:

Return players present at the latest membership sample.

Related API: Player

def contains(self, entity_or_location: EntityOrLocationInput) -> bool:

Test a live entity or coordinate against this trigger.

Related API: EntityOrLocationInput

def dispose(self) -> None:

Stop sampling, remove handlers, and release Script-Owned state.