Player
constPlayer:object
Type Declaration
Section titled “Type Declaration”boosts
Section titled “boosts”boosts:
object
Registrations and config last until the session closes, after scripts end.
boosts.configure
Section titled “boosts.configure”configure: (
changes) =>Effect<BoostConfig,never,never>
Changes only the given fields and returns the config as stored.
Parameters
Section titled “Parameters”changes
Section titled “changes”Partial<BoostConfig>
Returns
Section titled “Returns”Effect<BoostConfig, never, never>
boosts.getConfig
Section titled “boosts.getConfig”getConfig: () =>
Effect<BoostConfig,never,never>
Returns
Section titled “Returns”Effect<BoostConfig, never, never>
boosts.getRegistered
Section titled “boosts.getRegistered”getRegistered: () =>
Effect<readonlyItemQuery[],never,never>
Returns
Section titled “Returns”Effect<readonly ItemQuery[], never, never>
boosts.isActive
Section titled “boosts.isActive”isActive: (
kind) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Effect<boolean, never, never>
boosts.register
Section titled “boosts.register”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.
Parameters
Section titled “Parameters”readonly ItemQuery[]
Returns
Section titled “Returns”Effect<void, never, never>
boosts.unregister
Section titled “boosts.unregister”unregister: (
items) =>Effect<void,never,never>
Parameters
Section titled “Parameters”readonly ItemQuery[]
Returns
Section titled “Returns”Effect<void, never, never>
boosts.unregisterAll
Section titled “boosts.unregisterAll”unregisterAll: () =>
Effect<void,never,never>
Returns
Section titled “Returns”Effect<void, never, never>
getAura
Section titled “getAura”getAura: (
name) =>Effect<Aura|null,never,never>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Effect<Aura | null, never, never>
getAuras
Section titled “getAuras”getAuras: () =>
Effect<readonlyAura[],never,never>
Returns
Section titled “Returns”Effect<readonly Aura[], never, never>
getCell
Section titled “getCell”getCell: () =>
Effect<string|null,never,never>
Returns
Section titled “Returns”Effect<string | null, never, never>
getCharId
Section titled “getCharId”getCharId: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
getClassName
Section titled “getClassName”getClassName: () =>
Effect<string|null,never,never>
Returns
Section titled “Returns”Effect<string | null, never, never>
getFactions
Section titled “getFactions”getFactions: () =>
Effect<readonlyFaction[],never,never>
Returns
Section titled “Returns”Effect<readonly Faction[], never, never>
getGold
Section titled “getGold”getGold: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
getHp: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
getLevel
Section titled “getLevel”getLevel: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
getMap
Section titled “getMap”getMap: () =>
Effect<string|null,never,never>
Returns
Section titled “Returns”Effect<string | null, never, never>
getMaxHp
Section titled “getMaxHp”getMaxHp: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
getMaxMp
Section titled “getMaxMp”getMaxMp: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
getMp: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
getPad
Section titled “getPad”getPad: () =>
Effect<string|null,never,never>
Returns
Section titled “Returns”Effect<string | null, never, never>
getPosition
Section titled “getPosition”getPosition: () =>
Effect<Position|null,never,never>
Returns
Section titled “Returns”Effect<Position | null, never, never>
getState
Section titled “getState”getState: () =>
Effect<State|null,never,never>
Returns
Section titled “Returns”Effect<State | null, never, never>
getUserId
Section titled “getUserId”getUserId: () =>
Effect<number,never,never>
Returns
Section titled “Returns”Effect<number, never, never>
goToPlayer
Section titled “goToPlayer”goToPlayer: (
username) =>Effect<boolean,never,never>
Joins the player’s room and cell, wherever they are. Waits to respawn and leaves combat first.
Parameters
Section titled “Parameters”username
Section titled “username”string
Returns
Section titled “Returns”Effect<boolean, never, never>
hasAura
Section titled “hasAura”hasAura: (
name) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Effect<boolean, never, never>
isAfk: () =>
Effect<boolean,never,never>
Returns
Section titled “Returns”Effect<boolean, never, never>
isAlive
Section titled “isAlive”isAlive: () =>
Effect<boolean,never,never>
Returns
Section titled “Returns”Effect<boolean, never, never>
isMember
Section titled “isMember”isMember: () =>
Effect<boolean,never,never>
Returns
Section titled “Returns”Effect<boolean, never, never>
isReady
Section titled “isReady”isReady: () =>
Effect<boolean,never,never>
Returns
Section titled “Returns”Effect<boolean, never, never>
joinMap
Section titled “joinMap”joinMap: (
map,options) =>Effect<boolean,never,never>
Waits to respawn and leaves combat before joining another map.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”CellOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
jumpToCell
Section titled “jumpToCell”jumpToCell: (
cell,options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”PadOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
outfits
Section titled “outfits”outfits:
object
outfits.equip
Section titled “outfits.equip”equip: (
name,options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”OutfitOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
outfits.getNames
Section titled “outfits.getNames”getNames: () =>
Effect<readonlystring[],never,never>
Returns
Section titled “Returns”Effect<readonly string[], never, never>
outfits.wear
Section titled “outfits.wear”wear: (
name,options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”OutfitOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
rest: (
options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”options?
Section titled “options?”RestOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
walkTo
Section titled “walkTo”walkTo: (
x,y,options) =>Effect<boolean,never,never>
Parameters
Section titled “Parameters”number
number
options?
Section titled “options?”WalkOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>