Player
Properties
Section titled “Properties”Type: Bot
alive Getter
Section titled “alive ”Whether the player is alive.
Type: boolean
cell Getter
Section titled “cell ”The cell the player is in, in the map.
Type: string
className Getter
Section titled “className ”The name of the player’s equipped class.
Type: string
factions Getter
Section titled “factions ”The player’s faction data.
Type: Faction[]
gold Getter
Section titled “gold ”The player’s gold.
Type: number
hp Getter
Section titled “hp ”The health of the player.
Type: number
hpPercentage Getter
Section titled “hpPercentage ”The health percentage of the player.
Type: number
level Getter
Section titled “level ”The level of the player.
Type: number
maxHp Getter
Section titled “maxHp ”The maximum health of the player.
Type: number
maxMp Getter
Section titled “maxMp ”The maximum mana of the player.
Type: number
mp Getter
Section titled “mp ”The mana of the player.
Type: number
mpPercentage Getter
Section titled “mpPercentage ”The percentage of mana the player has.
Type: number
pad Getter
Section titled “pad ”The pad the player is in, in the map.
Type: string
position Getter
Section titled “position ”The player’s current position.
Type: [number, number]
state Getter
Section titled “state ”The state of the player.
Type: EntityState
Methods
Section titled “Methods”Whether the player is AFK.
Returns: boolean
isBoostActive
Section titled “isBoostActive”Checks if the player has an active boost.
| Parameter | Type | Description |
|---|---|---|
| type | BoostType | The type of boost to check. |
Returns: boolean
isInCombat
Section titled “isInCombat”Whether the player is in combat.
Returns: boolean
isLoaded
Section titled “isLoaded”Whether the player has fully loaded in.
Returns: boolean
isMember
Section titled “isMember”Whether the player has an active membership.
Returns: boolean
isReady
Section titled “isReady”Comprehensive check to determine if the player is ready.
Returns: boolean
walkTo
Section titled “walkTo”Walks to a position on the map.
| Parameter | Type | Optional | Default | Description |
|---|---|---|---|---|
| x | string | number | The x coordinate to walk to. | ||
| y | string | number | The y coordinate to walk to. | ||
| walkSpeed | string | number? | ✓ | The speed to walk at. |
Returns: void