Script Reference

Repeat the script at the given interval (50–60000 ms). Use in Hotkeys, Shortkeys or Edit Scripts for a route; a waypoint Action runs once and should not use auto.

Run the command only when the expression is true. Expressions support arithmetic, comparisons, &&, || and parentheses.

Run the command only when the expression is false. Uses the same expression syntax as if.

Run an alternative command after a matching if or ifnot when its condition did not pass.

Run the block the specified number of times; COUNT must be from 0 to 100.

Assign a numeric expression to a script-local variable.

Add 1 to a script-local variable.

Subtract 1 from a script-local variable.

Set a script-local variable back to 0.

Pause the current script for the specified time in milliseconds (0–600000), then continue.

End the current script run.

Stop the running script task.

Hide the script label from the Hotkey HUD list.

Set the label shown for this script in the Hotkey HUD list.

Send TEXT as a chat message through the game client.

Send TEXT as a chat message through the game client.

Send the supplied spell words through the game client chat.

Display TEXT in the helper’s Cavebot status output.

Display TEXT in the helper’s Cavebot status output.

Display TEXT in the helper’s Cavebot status output.

Ask the client to auto-walk to the map coordinates X, Y, Z.

Use an inventory item by its numeric item ID.

Use the nearest visible ground item with this ID on the player’s floor, within the current 15 × 11 map view. Uses the map item, not an inventory item. Missing items and invalid arguments report an action error. The client still controls proximity and whether use is allowed.

Use the tile’s top usable item at these coordinates. Missing items, unavailable tiles and invalid arguments report an action error instead of waiting indefinitely. The client still controls proximity and whether use is allowed.

Equivalent coordinate form of UseTile(X, Y, Z).

Use the inventory item ID on your character.

Alias of useOnSelf: use the inventory item ID on your character.

When the Fishing-slot rod is inactive, cast it on the water tile at X, Y, Z without a crosshair. When that slot holds the active rod (ID 6300), use the rod directly to reel in. Automatic Fishing watches bite effect 390 on the selected tile.

Compatibility alias for useFishingRod(): use the current Fishing-slot item on the selected map tile.

Enable automatic Fishing at the selected position. Requires an online game, a saved position and a usable Fishing-slot item.

Stop automatic Fishing and clear the Enable Fishing checkbox. Does not remove saved positions or bait.

Toggle automatic Fishing: start it when off, or stop it when on. The checkbox stays in sync.

Alternative syntax for setfishingon(), setfishingoff() and setfishingtoggle().

Cancel the current attack.

Enable or disable the Targeting module; use 1/on to enable and 0/off to disable.

Resume the Targeting module.

Pause the Targeting module.

Enable or disable Cavebot; use 1/on to enable and 0/off to disable.

Alias of setCavebot: enable or disable Cavebot waypoint following.

Set the Pokémon fight mode: "atk" = Offensive, "bal" = Balanced, "def" = Defensive. Other accepted names: offensive/off/attack, balanced/balance, defensive/defence/defense. Values are case-insensitive. Use names, not 1/2/3. The alias "off" means Offensive, not disabled. Examples: setStance "atk" and setStance("def").

Alias of setStance: set the Pokémon fight mode to Offensive (atk), Balanced (bal), or Defensive (def). Accepts the same named aliases. Example: stance "def".

Use the client’s Talk action on a visible NPC with this name. The game server still applies its own interaction-range check.

Call the selected team slot in the new Pokémon interface. Requires that interface; the helper warns and stops this script in Legacy mode.

Call the primary Pokémon in Legacy mode. Requires Legacy; the helper warns and stops this script in the new interface. Secondary is not supported.

Jump Cavebot to the first waypoint whose custom label matches the given name, without case sensitivity. Function syntax goto("Respawn") is also supported. Create the named waypoint before using it.

Alias of goto: jump to a waypoint with this custom label. Example: gotolabel "Respawn".

Enable ShinyPriority, Targeting or Cavebot. FollowWaypoints is an alias of Cavebot. Enabling an already enabled module leaves it enabled. Command and module names are case-insensitive. Example: seton ShinyPriority.

Disable ShinyPriority, Targeting or Cavebot; FollowWaypoints also selects Cavebot. Disabling an already disabled module leaves it disabled. Example: setoff ShinyPriority.

Switch ShinyPriority, Targeting or Cavebot once each time this command runs; FollowWaypoints also selects Cavebot. Example: settoggle ShinyPriority. Use it in a one-shot Action or shortcut.

Function-style and quoted names are supported by seton, setoff and settoggle. ShinyPriority also accepts shiny priority, shiny-priority and shiny_priority. Examples: setoff("ShinyPriority") and settoggle("Cavebot").

Use the same commands in Cavebot Actions, Hotkeys, Shortkeys and Cavebot Edit Scripts saved with a route. These commands change the named helper module; they do not execute arbitrary Lua. Existing setTargeting and setCavebot commands remain available.

Use seton or setoff in repeating auto scripts and other persistent route scripts. A repeated settoggle changes the state on every iteration instead of keeping a chosen state.

setoff Cavebot also stops future runs of its saved route scripts. Enable Cavebot again through its checkbox, a Hotkey or a Shortkey; a stopped route script cannot enable itself on a later iteration.

Open Edit Scripts in the Cavebot header beside Close, enter one independent persistent script per line, then choose Save with route. Each route keeps its own scripts in the same .cavebot file as its waypoints; no separate profile or global script file is created.

A line without auto uses a 100 ms interval. An explicit auto DELAY prefix accepts 50–60000 ms. Up to 32 scripts and 32000 bytes total are allowed; comment and blank lines are ignored.

Route scripts run only with Cavebot enabled and honor the helper’s global pause. Loading a legacy route without saved scripts clears scripts from the previous route. Empty editor text removes the route’s scripts.

Save with route saves scripts and waypoints together atomically. Cancel leaves the route unchanged. A failed save keeps the editor open and retains its text.

Create a waypoint named Respawn, then add: auto 100 if [$onDead] { gotolabel "Respawn" | wait 200 }. Put the death condition at the beginning of the script line.

Record a UseTile Action at the position selected by Direction: Center uses the player’s tile; North, South, East and West select the adjacent tile. Recording does not use the item. Add a Stand waypoint first when the object requires proximity.

An empty or whitespace-only Action stays in the route for later editing. Cavebot advances past it without stopping or adding the normal Action cooldown. Invalid nonempty code still reports an error.

Cavebot skips a movement waypoint after eight active seconds without an observed position change, or two active minutes of movement oscillation. Combat, loot, catch, revive, global pause and intentional Action waits do not consume the stationary timeout.

Wait until the requested number of eligible hunt targets are within RANGE SQM. MIN is optional; when omitted, the script waits for all targets found in the current scan. The wait has a 5-second timeout; the default range is 3 SQM.

Wait until every available Pokémon move is ready to cast (not on cooldown or otherwise unavailable).

Alias of waitForAllSpells(): wait for every available Pokémon move to be ready.

Alias of waitForAllSpells(): wait for every available Pokémon move to be ready.

Alias of waitForAllSpells(): wait for every available Pokémon move to be ready.

Run a managed hunt cycle: wait for hunt targets, defeat them, process loot/catch, then perform the requested recovery step.

Alias of hunt(): run the managed wait, kill, loot/catch and recovery sequence.

Start or continue attacking eligible nearby Pokémon targets. WITH_LOOT and ATTACK_ALL are optional true/false flags; RANGE is the optional maximum target distance.

Run the kill action with broad target selection enabled, using the helper’s current loot and range settings.

Select move-bar slots for the next combo. Calling with no valid slots clears the configured combo.

Alias of setCombo(): configure the move-bar slots used by the combo.

Alias of setCombo(): configure the move-bar slots used by the combo.

Execute the configured or supplied move-slot combo against the current eligible target.

Alias of killCombo(): execute a move-slot combo.

Alias of killCombo(): execute a move-slot combo.

Process the next eligible corpse in Cavebot’s loot queue.

Use the configured catch item on the next eligible Pokémon corpse, or on CORPSE_ID when supplied.

Start the strict revive workflow only when the helper detects that the Pokémon is dead.

Run the helper’s Pokémon recovery/refresh workflow.

Alias of refreshPokemon(): run the helper’s Pokémon recovery workflow.

Player connection state: 1 when connected to the game, otherwise 0.

A single player-death event delivered once after the trainer is alive again. It describes the trainer, not a dead Pokémon, and does not stay true while the trainer is dead. Put if [$onDead] at the beginning of its route-script line. Route scripts require Cavebot enabled and respect the global pause.

Player’s current absolute HP.

Player’s maximum HP.

Player’s current HP as a percentage. This is the player value in PXG.

Player’s current map X coordinate.

Player’s current map Y coordinate.

Player’s current map floor (Z coordinate).

Targeting module state: 1 when enabled, otherwise 0.

Cavebot state: 1 when enabled, otherwise 0.

Boolean-style presence check for your currently summoned Pokémon (1/0).

1 when your own Pokémon is currently summoned, otherwise 0.

Active summon’s current HP percentage. Returns 0 if no summon is available.

Active summon’s absolute HP value as exposed by the reviewed PXG client panel.

Active summon’s maximum HP value as exposed by the reviewed PXG client panel.

Client creature ID of your active summon; 0 when unavailable.

Active summon’s current map X coordinate; 0 when unavailable.

Active summon’s current map Y coordinate; 0 when unavailable.

Active summon’s current map floor (Z coordinate); 0 when unavailable.

Use the Order item on the top usable map target at X, Y, Z. The summon and Order item must be available.

Equivalent coordinate form using the Position constructor. The summon, Order item and usable map target must be available.

Use the Order item on your own character. The summon and Order item must be available.

Turn your active summon to the requested direction. Requires an active summon.

Tell your active summon to stop moving. Requires an active summon.