Skip to main content

Protocol: ScriptEventReceiveEvent

Data delivered for one received /scriptevent message.

class ScriptEventReceiveEvent(Protocol)

Related API: Block, Dimension, Entity, ScriptEventId, ScriptEventSource, Vector3

Properties​

id​

@property
def id(self) -> ScriptEventId:

Explicit author-chosen <namespace>:<path> message ID.

Related API: ScriptEventId

message​

@property
def message(self) -> str:

Payload text; the command supplies an empty string when it is omitted.

source_type​

@property
def source_type(self) -> ScriptEventSource:

Kind of Minecraft source that sent the message.

Related API: ScriptEventSource

source_key​

@property
def source_key(self) -> Optional[str]:

Stable source key when available.

source_entity_id​

@property
def source_entity_id(self) -> Optional[str]:

Stable UUID of the sending entity, even when its live facade is unavailable.

source_entity​

@property
def source_entity(self) -> Optional[Entity]:

Live sending entity, or None for other or unavailable sources.

Related API: Entity

source_block​

@property
def source_block(self) -> Optional[Block]:

Live sending block, or None for other or unavailable sources.

Related API: Block

dimension​

@property
def dimension(self) -> Dimension:

Dimension in which the message source was resolved.

Related API: Dimension

position​

@property
def position(self) -> Vector3:

World-space source position.

Related API: Vector3