Skip to main content

Interface: World

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

Properties​

afterEvents​

readonly afterEvents: WorldAfterEvents

Observational event streams.

beforeEvents​

readonly beforeEvents: WorldBeforeEvents

Synchronous, cancelable event streams.

inventoryLeases​

readonly inventoryLeases: InventoryLeaseRegistry

Unfinished temporary inventory leases owned by the current Script.

storage​

readonly storage: ScriptStorage

Persistent storage scoped to the current Script identity.

Methods​

createTriggerVolume()​

createTriggerVolume(options): TriggerVolume

Creates a Script-Owned trigger volume.

Parameters​

options​

TriggerVolumeOptions

Returns​

TriggerVolume

getAllPlayers()​

getAllPlayers(): readonly Player[]

Returns every currently connected player.

Returns​

readonly Player[]

getData()​

getData(key): DataValue

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

Parameters​

key​

string

Returns​

DataValue

getDataKeys()​

getDataKeys(prefix?): readonly string[]

Returns persistent keys, optionally restricted to a prefix.

Parameters​

prefix?​

string | null

Returns​

readonly string[]

getDimension()​

getDimension(id): Dimension

Resolves a Java Edition dimension identifier or supported alias.

Parameters​

id​

string

Returns​

Dimension

getPlayer()​

getPlayer(idOrName): Player | null

Finds a connected player by UUID or current name.

Parameters​

idOrName​

string

Returns​

Player | null

getPlayers()​

getPlayers(): readonly Player[]

Alias for World.getAllPlayers.

Returns​

readonly Player[]

sendMessage()​

sendMessage(message): void

Broadcasts a chat message to the server.

Parameters​

message​

string

Returns​

void

setData()​

setData(key, value?): void

Writes or removes a value in the current Script's persistent storage.

Parameters​

key​

string

value?​

DataValue

Returns​

void