Players

Players are the characters controlled by people, they are used to explore the world, interact with other entities, and hold information about what they have collected and accomplished so far.

Finding players

Most code will already have access to the player in question, in the situations where one player needs to find or reference another player they can be searched for in the worlds list of Players.

You can search for a player by name, index, Tile or Zone:

val player = Players.indexed(42) // Get player at an index
val player = Players.find("Cow31337Killer") // Get a specific player by name
val playersUnder = Players.at(Tile(3200, 3200)) // Get all players under a tile
val playersNearby = Players.at(Zone(402, 403)) // Get all players in 8x8 area

Adding players

You can subscribe to new players being spawned with:

playerSpawn {
    message("Welcome to Void.")
}

Removing players

Again for most situations removing players is already handled, player.logout() is enough for other scenarios.

You can subscribe to removed players with:

playerDespawn {
    cancelQuickPrayers()
}

Player options

Scripts can subscribe to player options with:

playerOperate("Req Assist") { }

Player save data