isMoving
isMoving: (PlayerDomain) -> booleanWhether the local player is walking or running.
The local player: walking, webwalking, vitals, inventory, gear, combat, magic and prayer.
player| Method | Returns | Description |
|---|---|---|
isMoving() | boolean | Whether the local player is walking or running. |
isLoggedIn() | boolean | Whether a character is logged in. |
isAnimating() | boolean | Whether the local player is playing an animation. |
isInteracting() | boolean | Whether the local player has an interaction target. |
isRunEnabled() | boolean | Whether run is toggled on. Says nothing about remaining energy. |
setRunEnabled(boolean) | boolean | Turn run on or off. |
setBoatHeading(number) | boolean | Turn the boat the player is sailing to a compass step. |
isIdle() | boolean | Whether the player is idle enough to be given something to do. |
isInPoh() | boolean | Whether the local player is inside a player-owned house. |
house() | House? | The local player's own house as the client last saw it inside: its portals, jewellery box, pool, altars and travel furniture. Saved per acc… |
currentHitpoints() | number | Current hitpoints, as the orb reads them. |
currentPrayerPoints() | number | Current prayer points, as the orb reads them. |
vitals() | Vitals | Hitpoints, prayer, run energy and special attack energy, as the orbs read them. |
combatLevel() | number | The local player's combat level. |
tile() | WorldPoint? | The tile the local player stands on, in the coordinates of the scene loaded now. Inside an instance this is the instance's tile, the space… |
trueTile() | WorldPoint? | The tile the local player stands on in the real world: inside an instance, the map tile the instance was copied from. |
walkTo(WorldPoint, number?) | boolean | Walk to a tile in the loaded scene, on-screen or not. A tile of the boat you stand on (a deck tile, as getWorldLocation() gives one aboar… |
walkToArea(WorldArea) | boolean | Walk to the cheapest reachable tile in an area. Already being inside it answers true and causes no input. |
stopWalking() | boolean | Cancel a walk by walking to the tile already stood on. |
webwalk() | Webwalk | This plugin's webwalk: long-distance pathing across the world. There is one per plugin, and every call answers it. Raises where no plugin's… |
isTeleblocked() | boolean | Whether the local player is teleblocked. |
wildernessLevel() | number | The local player's Wilderness level, read off the HUD. |
logout() | boolean | Ask the client to log out. |
inventory() | Inventory | The 28-slot inventory. |
combat() | Combat | Attack range and speed, cooldowns, special attack, and attack style. |
magic() | Magic | Spellbook, runes, castability, and casting. |
prayer() | Prayers | Prayerbook, activation, flicking, and quick prayers. |
equipment() | Equipment | Worn gear. |
quests() | Quests | Quest states and progress. |
consumables() | Consumables | Food, potions, and poison cures. |
farming() | Farming | The account's farming patches and the Farming Guild contract, as the client tracks them. |
sailing() | Sailing | Sailing: the boat the player is on, their boats, crew, docks, port tasks, Barracuda Trials and shipwrecks. |
birdhouses() | { BirdhouseStatus } | The four Fossil Island bird house spaces as the client last saw them, saved per account; empty until the player has been there with the cli… |
charges() | ItemCharges | Item charges: fixed by the item id, or counted by the client (jewellery, the chronicle, the ring of endurance) and saved per account. |
buffs() | Buffs | Timers and buffs, tracked whether or not the timers-and-buffs plugin is on. |
dailies() | { Daily } | The daily reminders, in a fixed order, read live from the game's vars. |
slayer() | SlayerTask? | The slayer task, read from the game. |
kingdom() | Kingdom? | The Kingdom of Miscellania's approval and coffer, saved per account, with an estimate of their decay since they were last seen. |
essencePouches() | { EssencePouch } | The five essence pouches as the game has them now, small to colossal: what each holds, what it can hold, and its wear. Empty when logged ou… |
diaries() | Diaries | Achievement diary completion, read from the game's own completion vars. |
isMovingisMoving: (PlayerDomain) -> booleanWhether the local player is walking or running.
isLoggedInisLoggedIn: (PlayerDomain) -> booleanWhether a character is logged in.
Almost every hook should start here: the rest of this domain answers with defaults rather than errors when nobody is logged in.
isAnimatingisAnimating: (PlayerDomain) -> booleanWhether the local player is playing an animation.
isInteractingisInteracting: (PlayerDomain) -> booleanWhether the local player has an interaction target.
isRunEnabledisRunEnabled: (PlayerDomain) -> booleanWhether run is toggled on. Says nothing about remaining energy.
setRunEnabledsetRunEnabled: (PlayerDomain, boolean) -> booleanTurn run on or off.
Asks for a STATE, not a flip, so it will not turn run off because it happened to already be on.
enabledfalse when it is already that.setBoatHeadingsetBoatHeading: (PlayerDomain, number) -> booleanTurn the boat the player is sailing to a compass step.
stepisIdleisIdle: (PlayerDomain) -> booleanWhether the player is idle enough to be given something to do.
Neither animating nor moving. A cheap guard against queueing a second action on top of one already playing out.
isInPohisInPoh: (PlayerDomain) -> booleanWhether the local player is inside a player-owned house.
househouse: (PlayerDomain) -> House?The local player's own house as the client last saw it inside: its portals, jewellery box, pool, altars and travel furniture. Saved per account and refreshed in full on each visit, so removed furniture is noticed; a friend's house is never recorded.
nil when this account's house has never been seen.currentHitpointscurrentHitpoints: (PlayerDomain) -> numberCurrent hitpoints, as the orb reads them.
currentPrayerPointscurrentPrayerPoints: (PlayerDomain) -> numberCurrent prayer points, as the orb reads them.
vitalsvitals: (PlayerDomain) -> VitalsHitpoints, prayer, run energy and special attack energy, as the orbs read them.
combatLevelcombatLevel: (PlayerDomain) -> numberThe local player's combat level.
tiletile: (PlayerDomain) -> WorldPoint?The tile the local player stands on, in the coordinates of the scene loaded now. Inside an instance this is the instance's tile, the space getWorldLocation() answers in; on an ordinary map it is the same tile as trueTile.
nil when logged out.trueTiletrueTile: (PlayerDomain) -> WorldPoint?The tile the local player stands on in the real world: inside an instance, the map tile the instance was copied from.
nil before there is a local player.walkTowalkTo: (PlayerDomain, WorldPoint, number?) -> booleanWalk to a tile in the loaded scene, on-screen or not. A tile of the boat you stand on (a deck tile, as getWorldLocation() gives one aboard) walks on the deck; at the helm no walk is made. For anywhere further, use webwalk.
player:walkTo(WorldPoint.new(3200, 3200, 0))
player:walkTo(bankTile, 3) -- anywhere within 3 tiles will dotiledistancetrue and causes no input, and the walk goes to a reachable tile within it.false when no walk was queued.walkToAreawalkToArea: (PlayerDomain, WorldArea) -> booleanWalk to the cheapest reachable tile in an area. Already being inside it answers true and causes no input.
areafalse when no tile of it can be reached.stopWalkingstopWalking: (PlayerDomain) -> booleanCancel a walk by walking to the tile already stood on.
webwalkwebwalk: (PlayerDomain) -> WebwalkThis plugin's webwalk: long-distance pathing across the world. There is one per plugin, and every call answers it. Raises where no plugin's code is running to own it, as in coroutine.wrap(player.webwalk)(player); the walk's start calls raise there too.
player:webwalk():start(WorldPoint.new(3165, 3487, 0))
if player:webwalk():isWalking() then return endisTeleblockedisTeleblocked: (PlayerDomain) -> booleanWhether the local player is teleblocked.
wildernessLevelwildernessLevel: (PlayerDomain) -> numberThe local player's Wilderness level, read off the HUD.
0 when not in the Wilderness.logoutlogout: (PlayerDomain) -> booleanAsk the client to log out.
inventoryinventory: (PlayerDomain) -> InventoryThe 28-slot inventory.
combatcombat: (PlayerDomain) -> CombatAttack range and speed, cooldowns, special attack, and attack style.
magicmagic: (PlayerDomain) -> MagicSpellbook, runes, castability, and casting.
prayerprayer: (PlayerDomain) -> PrayersPrayerbook, activation, flicking, and quick prayers.
equipmentequipment: (PlayerDomain) -> EquipmentWorn gear.
questsquests: (PlayerDomain) -> QuestsQuest states and progress.
consumablesconsumables: (PlayerDomain) -> ConsumablesFood, potions, and poison cures.
farmingfarming: (PlayerDomain) -> FarmingThe account's farming patches and the Farming Guild contract, as the client tracks them.
sailingsailing: (PlayerDomain) -> SailingSailing: the boat the player is on, their boats, crew, docks, port tasks, Barracuda Trials and shipwrecks.
birdhousesbirdhouses: (PlayerDomain) -> { BirdhouseStatus }The four Fossil Island bird house spaces as the client last saw them, saved per account; empty until the player has been there with the client running.
chargescharges: (PlayerDomain) -> ItemChargesItem charges: fixed by the item id, or counted by the client (jewellery, the chronicle, the ring of endurance) and saved per account.
buffsbuffs: (PlayerDomain) -> BuffsTimers and buffs, tracked whether or not the timers-and-buffs plugin is on.
dailiesdailies: (PlayerDomain) -> { Daily }The daily reminders, in a fixed order, read live from the game's vars.
slayerslayer: (PlayerDomain) -> SlayerTask?The slayer task, read from the game.
nil without a task, or before the client has read it (it does within a tick of a change).kingdomkingdom: (PlayerDomain) -> Kingdom?The Kingdom of Miscellania's approval and coffer, saved per account, with an estimate of their decay since they were last seen.
nil before the client has recorded them for this account.essencePouchesessencePouches: (PlayerDomain) -> { EssencePouch }The five essence pouches as the game has them now, small to colossal: what each holds, what it can hold, and its wear. Empty when logged out.
diariesdiaries: (PlayerDomain) -> DiariesAchievement diary completion, read from the game's own completion vars.