Skip to main content

Protocol: World

Main QuestScript-owned entry point for world access and Script state.

class World(Protocol)

Related API: BlockVolume, DataValue, Dimension, DimensionInput, InventoryLeaseRegistry, Player, ScriptStorage, TriggerVolume, WorldAfterEvents, WorldBeforeEvents

Properties​

before_events​

@property
def before_events(self) -> WorldBeforeEvents:

Synchronous, cancelable event streams.

Related API: WorldBeforeEvents

after_events​

@property
def after_events(self) -> WorldAfterEvents:

Observational event streams.

Related API: WorldAfterEvents

storage​

@property
def storage(self) -> ScriptStorage:

Persistent storage scoped to the current Script identity.

Related API: ScriptStorage

inventory_leases​

@property
def inventory_leases(self) -> InventoryLeaseRegistry:

Unfinished temporary inventory leases owned by the current Script.

Related API: InventoryLeaseRegistry

Methods​

get_dimension​

def get_dimension(self, id: str) -> Dimension:

Resolve a Java Edition dimension identifier or supported alias.

Related API: Dimension

get_all_players​

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

Return every currently connected player.

Related API: Player

get_players​

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

Alias for get_all_players.

Related API: Player

get_player​

def get_player(self, id_or_name: str) -> Optional[Player]:

Find a connected player by UUID or current name.

Related API: Player

send_message​

def send_message(self, message: str) -> None:

Broadcast a chat message to the server.

create_trigger_volume​

def create_trigger_volume(self, *, id: Optional[str]=..., dimension: DimensionInput, volume: BlockVolume, players_only: Literal[True]=..., tick_interval: int=...) -> TriggerVolume:

Create a Script-Owned trigger volume.

Related API: BlockVolume, DimensionInput, TriggerVolume

get_data​

def get_data(self, key: str) -> DataValue:

Read a value from the current Script's persistent storage.

Related API: DataValue

set_data​

def set_data(self, key: str, value: Optional[DataValue]=None) -> None:

Write or remove a value in the current Script's persistent storage.

Related API: DataValue

get_data_keys​

def get_data_keys(self, prefix: Optional[str]='') -> Sequence[str]:

Return persistent keys, optionally restricted to a prefix.