Skip to content

Player

const Player: object

boosts: object

Registrations and config last until the session closes, after scripts end.

configure: (changes) => Effect<BoostConfig, never, never>

Changes only the given fields and returns the config as stored.

Partial<BoostConfig>

Effect<BoostConfig, never, never>

getConfig: () => Effect<BoostConfig, never, never>

Effect<BoostConfig, never, never>

getRegistered: () => Effect<readonly ItemQuery[], never, never>

Effect<readonly ItemQuery[], never, never>

isActive: (kind) => Effect<boolean, never, never>

Boost

Effect<boolean, never, never>

register: (items) => Effect<void, never, never>

Uses a registered item from the inventory whenever its kind of boost isn’t active. Items of the same kind are used in the order they were registered.

readonly ItemQuery[]

Effect<void, never, never>

unregister: (items) => Effect<void, never, never>

readonly ItemQuery[]

Effect<void, never, never>

unregisterAll: () => Effect<void, never, never>

Effect<void, never, never>

getAura: (name) => Effect<Aura | null, never, never>

string

Effect<Aura | null, never, never>

getAuras: () => Effect<readonly Aura[], never, never>

Effect<readonly Aura[], never, never>

getCell: () => Effect<string | null, never, never>

Effect<string | null, never, never>

getCharId: () => Effect<number, never, never>

Effect<number, never, never>

getClassName: () => Effect<string | null, never, never>

Effect<string | null, never, never>

getFactions: () => Effect<readonly Faction[], never, never>

Effect<readonly Faction[], never, never>

getGold: () => Effect<number, never, never>

Effect<number, never, never>

getHp: () => Effect<number, never, never>

Effect<number, never, never>

getLevel: () => Effect<number, never, never>

Effect<number, never, never>

getMap: () => Effect<string | null, never, never>

Effect<string | null, never, never>

getMaxHp: () => Effect<number, never, never>

Effect<number, never, never>

getMaxMp: () => Effect<number, never, never>

Effect<number, never, never>

getMp: () => Effect<number, never, never>

Effect<number, never, never>

getPad: () => Effect<string | null, never, never>

Effect<string | null, never, never>

getPosition: () => Effect<Position | null, never, never>

Effect<Position | null, never, never>

getState: () => Effect<State | null, never, never>

Effect<State | null, never, never>

getUserId: () => Effect<number, never, never>

Effect<number, never, never>

goToPlayer: (username) => Effect<boolean, never, never>

Joins the player’s room and cell, wherever they are. Waits to respawn and leaves combat first.

string

Effect<boolean, never, never>

hasAura: (name) => Effect<boolean, never, never>

string

Effect<boolean, never, never>

isAfk: () => Effect<boolean, never, never>

Effect<boolean, never, never>

isAlive: () => Effect<boolean, never, never>

Effect<boolean, never, never>

isMember: () => Effect<boolean, never, never>

Effect<boolean, never, never>

isReady: () => Effect<boolean, never, never>

Effect<boolean, never, never>

joinMap: (map, options) => Effect<boolean, never, never>

Waits to respawn and leaves combat before joining another map.

string

CellOptions = {}

Effect<boolean, never, never>

jumpToCell: (cell, options) => Effect<boolean, never, never>

string

PadOptions = {}

Effect<boolean, never, never>

outfits: object

equip: (name, options) => Effect<boolean, never, never>

string

OutfitOptions = {}

Effect<boolean, never, never>

getNames: () => Effect<readonly string[], never, never>

Effect<readonly string[], never, never>

wear: (name, options) => Effect<boolean, never, never>

string

OutfitOptions = {}

Effect<boolean, never, never>

rest: (options) => Effect<boolean, never, never>

RestOptions = {}

Effect<boolean, never, never>

walkTo: (x, y, options) => Effect<boolean, never, never>

number

number

WalkOptions = {}

Effect<boolean, never, never>