Trainer’s Field Manual
Every global function and callback for your capture scripts — sorted by type, rendered on an LCD screen, and ready to copy straight into your next route.
Pick a farm mode, a route and a battle plan — the builder writes the Lua and checks every call against this reference before you copy it.
PROCatchem exposes a Lua API for script authors. This Slate-style page documents every Lua global function and callback from the current API description.
These are Lua functions, not HTTP endpoints. The included openapi.yaml is retained as source metadata.
name = "Example Script"
author = "YourName"
description = "Simple PROCatchem script."
function onPathAction()
if getMapName() == "Viridian City" then
moveToGrass()
end
end
function onBattleAction()
attack()
end
PC storage updates are asynchronous. After deposit, withdraw, swap, internal box swap, or release, wait for the server update and re-check PC/team state before issuing the next dependent action.
OpenAPI YAMLBasic exampleNotification example
Every API entry includes a practical Lua scenario, the callback where it belongs, and action/async safety notes.
Signatureresult = name()
Script display name shown in the tool.
Set this metadata once at the top of the Lua file so the Scripts tab displays a recognizable name.
string example: "value"
GET /lua/metadata/name
name = "Viridian Training Route"Signatureresult = author()
Script author displayed in the tool.
Set this metadata once at the top of the Lua file so users know who maintains the script.
string example: "value"
GET /lua/metadata/author
author = "Iron Stark"Signatureresult = description()
Short script description displayed in the tool.
Use this metadata to explain the route, requirements, and intended behavior before the script starts.
string example: "value"
GET /lua/metadata/description
description = "Trains in Viridian Forest and returns to the Pokécenter below 25% HP."SignatureonStart()
Called when the script starts.
Initialize counters and log the starting state when the user starts the script.
void
POST /lua/callbacks/onStart
local encounters = 0
function onStart()
encounters = 0
log("Training script started on " .. getMapName())
endSignatureonStop()
Called when the script stops.
Persist or report final state before the runtime finishes the script.
void
POST /lua/callbacks/onStop
function onStop()
log("Script stopped safely.")
endSignatureonPause()
Called when the script is paused.
Use this callback for status logging or pausing your own timers.
void
POST /lua/callbacks/onPause
function onPause()
log("Lua automation paused.")
endSignatureonResume()
Called when the script resumes.
Re-check game state because the player may have moved or changed the team while paused.
void
POST /lua/callbacks/onResume
function onResume()
log("Lua automation resumed on " .. getMapName())
endSignatureonPathAction()
Called repeatedly while the player is outside battle. Execute at most one path action per frame.
This is the main overworld decision callback. Perform no more than one path action per call.
void
POST /lua/callbacks/onPathAction
function onPathAction()
if getPokemonHealthPercent(1) < 25 then
usePokecenter()
return
end
moveToGrass()
endSignatureonBattleAction()
Called repeatedly while the player is in battle. Execute at most one battle action per frame.
This is the main battle decision callback. Perform no more than one battle action per call.
void
POST /lua/callbacks/onBattleAction
function onBattleAction()
if isOpponentShiny() or not isAlreadyCaught() then
weakAttack()
return
end
attack()
endSignatureonDialogMessage(message)
Called when a dialog message is received.
Inspect NPC text to track quests or diagnose unexpected dialog branches.
| Name | Type | Required | Description |
|---|---|---|---|
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/callbacks/onDialogMessage
function onDialogMessage(message)
if stringContains(message, "badge") then
log("Badge requirement detected: " .. message)
end
endSignatureonBattleMessage(message)
Called when a battle message is received.
Inspect battle text for events that are not exposed as dedicated state helpers.
| Name | Type | Required | Description |
|---|---|---|---|
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/callbacks/onBattleMessage
function onBattleMessage(message)
if stringContains(message, "fainted") then
log("A Pokémon fainted: " .. message)
end
endSignatureonSystemMessage(message)
Called when a system message is received.
Use system messages to confirm server-side actions such as catches, releases, or item usage.
| Name | Type | Required | Description |
|---|---|---|---|
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/callbacks/onSystemMessage
function onSystemMessage(message)
log("SYSTEM: " .. message)
endSignatureonWarningMessage(differentMap, distance)
Called when a warning message is received; distance can be -1 when unavailable.
Record warnings so a long-running script can be diagnosed later.
| Name | Type | Required | Description |
|---|---|---|---|
differentMap | boolean | yes | Value passed to the `differentMap` parameter. |
distance | integer | yes | Value passed to the `distance` parameter. |
void
POST /lua/callbacks/onWarningMessage
function onWarningMessage(message)
logToFile("logs/warnings.txt", message)
endSignatureonLearningMove(moveName, pokemonIndex)
Called when a Pokémon is learning a move.
Choose which move to forget when the game asks a Pokémon to learn a new move.
| Name | Type | Required | Description |
|---|---|---|---|
moveName | string | yes | Exact move name as shown by the game. |
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
void
POST /lua/callbacks/onLearningMove
function onLearningMove(moveName, pokemonIndex)
if moveName == "Thunderbolt" then
forgetAnyMoveExcept("Thunderbolt")
else
forgetMove(1)
end
endSignaturelog(message)
Displays the specified message to the message log.
Write concise diagnostics that identify the current map, Pokémon, or decision branch.
| Name | Type | Required | Description |
|---|---|---|---|
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/core-utilities/log
function onStart()
log("Script started on " .. getMapName())
endSignaturefatal(message)
Displays the specified message to the message log and stop the bot.
Stop immediately when a required precondition is missing and explain how the user can fix it.
| Name | Type | Required | Description |
|---|---|---|---|
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/core-utilities/fatal
function onStart()
if getTeamSize() == 0 then
fatal("A Pokémon team is required before this script can run.")
end
endSignaturelogout(message)
Displays the specified message to the message log and logs out.
Use a guarded condition so the script does not request logout on every frame.
| Name | Type | Required | Description |
|---|---|---|---|
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/core-utilities/logout
function onPathAction()
if getMoney() < 100 then
logout("Stopping: not enough money to continue safely.")
return
end
endSignaturerelog(delay, message)
Logs out and logs back in after the specified number of seconds.
Schedule a reconnect only from a guarded branch, such as recovering from a known server state.
| Name | Type | Required | Description |
|---|---|---|---|
delay | number | yes | Value passed to the `delay` parameter. |
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/core-utilities/relog
function onWarningMessage(differentMap, distance)
if differentMap then
relog(15, "Map synchronization failed; reconnecting.")
end
endSignaturerestart(delay, message)
Start the script.
Restart a script only after detecting a state that cannot be recovered inside the current run.
| Name | Type | Required | Description |
|---|---|---|---|
delay | integer | yes | Value passed to the `delay` parameter. |
message | string | yes | Message text provided by the game or sent by the script. |
void
POST /lua/core-utilities/restart
function onWarningMessage(differentMap, distance)
if distance > 10 then
restart(5, "Player position is too far from the expected route.")
end
endSignatureresult = stringContains(haystack, needle)
Returns true if the string contains the specified part, ignoring the case.
Use case-insensitive message checks to recognize dialog, battle, or system text.
| Name | Type | Required | Description |
|---|---|---|---|
haystack | string | yes | Value passed to the `haystack` parameter. |
needle | string | yes | Value passed to the `needle` parameter. |
boolean example: true
POST /lua/core-utilities/stringcontains
function onDialogMessage(message)
if stringContains(message, "other badges") then
log("This NPC is blocking progress until more badges are earned.")
end
endSignatureplaySound(file)
Returns playing a custom sound.
Use this helper for diagnostics or lifecycle control. Avoid calling restart/logout helpers repeatedly every frame.
| Name | Type | Required | Description |
|---|---|---|---|
file | string | yes | Path relative to the script/tool data directory. |
void
POST /lua/core-utilities/playsound
function onStart()
function onStart()
playSound("logs/script.txt")
end
endSignatureregisterHook(eventName, callback)
Calls the specified function when the specified event occurs.
Register a callback once, usually from `onStart`, rather than registering it every frame.
| Name | Type | Required | Description |
|---|---|---|---|
eventName | string | yes | Value passed to the `eventName` parameter. |
callback | LuaValue | yes | Any Lua value. |
void
POST /lua/core-utilities/registerhook
function onStart()
registerHook("battle", function(message)
log("Battle hook: " .. tostring(message))
end)
endSignatureexecuteSteps(steps, options)
Runs a list of steps (other Lua functions/APIs) as one ordered action. Each step is a function, a { "name", function } pair, or a { name, run, args, continueOnError } table. Honours the one-bot-action-per-frame rule via stopOnAction (default true): it stops at the first step that performs a bot action and returns nextIndex to resume next frame.
Group query/helper work and stop at the first real bot action, then resume from `nextIndex` on a later frame.
| Name | Type | Required | Description |
|---|---|---|---|
steps | array<object> | yes | Ordered Lua functions/step descriptors to execute. |
options | object | no | Optional execution settings table. |
object
POST /lua/workflow/execute-steps
local nextStep = 1
function onPathAction()
local result = executeSteps({
{ "log map", function() log(getMapName()) end },
{ "move", moveToGrass }
}, { stopOnAction = true, logProgress = true, startIndex = nextStep })
nextStep = result.nextIndex or 1
endSignatureresult = getPlayerX()
Returns the X-coordinate of the current cell.
Use this query in overworld logic to choose a safe destination or NPC interaction.
integer example: 1
POST /lua/map-and-npc/getplayerx
function onPathAction()
function onPathAction()
local result = getPlayerX()
log("getPlayerX: " .. tostring(result))
end
log("getPlayerX: " .. tostring(result))
endSignatureresult = getPlayerY()
Returns the Y-coordinate of the current cell.
Use this query in overworld logic to choose a safe destination or NPC interaction.
integer example: 1
POST /lua/map-and-npc/getplayery
function onPathAction()
function onPathAction()
local result = getPlayerY()
log("getPlayerY: " .. tostring(result))
end
log("getPlayerY: " .. tostring(result))
endSignatureresult = getMapName()
Returns the name of the current map.
Use this query in overworld logic to choose a safe destination or NPC interaction.
string example: "value"
POST /lua/map-and-npc/getmapname
function onPathAction()
function onPathAction()
local result = getMapName()
log("getMapName: " .. tostring(result))
end
log("getMapName: " .. tostring(result))
endSignatureresult = getActiveBattlers()
API return an array of all NPCs that can be challenged on the current map. format : {"npcName" = {"x" = x, "y" = y}}
Use this query in overworld logic to choose a safe destination or NPC interaction.
object example: {}
POST /lua/map-and-npc/getactivebattlers
function onPathAction()
function onPathAction()
local result = getActiveBattlers()
log("getActiveBattlers: " .. tostring(result))
end
log("getActiveBattlers: " .. tostring(result))
endSignatureresult = getActiveDigSpots()
API return an array of all usable Dig Spots on the currrent map. format : {index = {"x" = x, "y" = y}}
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getactivedigspots
function onPathAction()
function onPathAction()
local result = getActiveDigSpots()
log("getActiveDigSpots: " .. tostring(result))
end
log("getActiveDigSpots: " .. tostring(result))
endSignatureresult = getActiveHeadbuttTrees()
API return an array of all usable Headbutt trees on the currrent map. format : {index = {"x" = x, "y" = y}}
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getactiveheadbutttrees
function onPathAction()
function onPathAction()
local result = getActiveHeadbuttTrees()
log("getActiveHeadbuttTrees: " .. tostring(result))
end
log("getActiveHeadbuttTrees: " .. tostring(result))
endSignatureresult = getActiveBerryTrees()
API return an array of all harvestable berry trees on the currrent map. format : {index = {"x" = x, "y" = y}}
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getactiveberrytrees
function onPathAction()
function onPathAction()
local result = getActiveBerryTrees()
log("getActiveBerryTrees: " .. tostring(result))
end
log("getActiveBerryTrees: " .. tostring(result))
endSignatureresult = getDiscoverableItems()
API return an array of all discoverable items on the currrent map. format : {index = {"x" = x, "y" = y}}
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getdiscoverableitems
function onPathAction()
function onPathAction()
local result = getDiscoverableItems()
log("getDiscoverableItems: " .. tostring(result))
end
log("getDiscoverableItems: " .. tostring(result))
endSignatureresult = getDiscoverablePokestops()
API return an array of all pokestops on the current map. format : {index = {"x" = x, "y" = y}}
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getdiscoverablepokestops
function onPathAction()
function onPathAction()
local result = getDiscoverablePokestops()
log("getDiscoverablePokestops: " .. tostring(result))
end
log("getDiscoverablePokestops: " .. tostring(result))
endSignatureresult = getDiscoverableAbandonedPokemon()
API return an array of all Abandoned Pokemon on the current map. format : {index = {"x" = x, "y" = y}}
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getdiscoverableabandonedpokemon
function onPathAction()
function onPathAction()
local result = getDiscoverableAbandonedPokemon()
log("getDiscoverableAbandonedPokemon: " .. tostring(result))
end
log("getDiscoverableAbandonedPokemon: " .. tostring(result))
endSignatureresult = getNpcData()
Returns npc data on current map, format : { { "x" = x , "y" = y, "type" = type }, {...}, ... }
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getnpcdata
function onPathAction()
function onPathAction()
local result = getNpcData()
log("getNpcData: " .. tostring(result))
end
log("getNpcData: " .. tostring(result))
endSignatureresult = getMapLinks()
Lua function getMapLinks.
Use this query in overworld logic to choose a safe destination or NPC interaction.
array<object> example: {}
POST /lua/map-and-npc/getmaplinks
function onPathAction()
function onPathAction()
local result = getMapLinks()
log("getMapLinks: " .. tostring(result))
end
log("getMapLinks: " .. tostring(result))
endSignatureresult = getMapWidth()
The number of cells on the current map in the x direction.
Use this query in overworld logic to choose a safe destination or NPC interaction.
integer example: 1
POST /lua/map-and-npc/getmapwidth
function onPathAction()
function onPathAction()
local result = getMapWidth()
log("getMapWidth: " .. tostring(result))
end
log("getMapWidth: " .. tostring(result))
endSignatureresult = getMapHeight()
The number of cells on the current map in the y direction.
Use this query in overworld logic to choose a safe destination or NPC interaction.
integer example: 1
POST /lua/map-and-npc/getmapheight
function onPathAction()
function onPathAction()
local result = getMapHeight()
log("getMapHeight: " .. tostring(result))
end
log("getMapHeight: " .. tostring(result))
endSignatureresult = getCellType(x, y)
Returns the cell type of the specified cell on the current map.
Use this query in overworld logic to choose a safe destination or NPC interaction.
| Name | Type | Required | Description |
|---|---|---|---|
x | integer | yes | Map X coordinate. |
y | integer | yes | Map Y coordinate. |
string example: "value"
POST /lua/map-and-npc/getcelltype
function onPathAction()
function onPathAction()
local result = getCellType(10, 15)
log("getCellType: " .. tostring(result))
end
log("getCellType: " .. tostring(result))
endSignatureresult = isNpcVisible(npcName)
Returns true if there is a visible NPC with the specified name on the map.
Use this query in overworld logic to choose a safe destination or NPC interaction.
| Name | Type | Required | Description |
|---|---|---|---|
npcName | string | yes | Exact or documented NPC name. |
boolean example: true
POST /lua/map-and-npc/isnpcvisible
function onPathAction()
function onPathAction()
local result = isNpcVisible("Nurse Joy")
log("isNpcVisible: " .. tostring(result))
end
log("isNpcVisible: " .. tostring(result))
endSignatureresult = isNpcOnCell(cellX, cellY)
Returns true if there is a visible NPC the specified coordinates.
Use this query in overworld logic to choose a safe destination or NPC interaction.
| Name | Type | Required | Description |
|---|---|---|---|
cellX | integer | yes | Value passed to the `cellX` parameter. |
cellY | integer | yes | Value passed to the `cellY` parameter. |
boolean example: true
POST /lua/map-and-npc/isnpconcell
function onPathAction()
function onPathAction()
local result = isNpcOnCell(10, 15)
log("isNpcOnCell: " .. tostring(result))
end
log("isNpcOnCell: " .. tostring(result))
endSignatureresult = isInArea(text)
Check condition list cell
Use the condition-string syntax expected by the tool to test whether the current coordinates satisfy a route region.
| Name | Type | Required | Description |
|---|---|---|---|
text | string | yes | Value passed to the `text` parameter. |
boolean example: true
POST /lua/map-and-npc/isinarea
function onPathAction()
local insideRoute = isInArea(">=:10->=:15?&&,<=:20-<=:25?&&")
if insideRoute then
moveToGrass()
return
end
endSignatureresult = getAccountName()
Returns current account name.
Use this query as a guard before an action that depends on the current global state.
string example: "value"
POST /lua/general-state/getaccountname
function onPathAction()
function onPathAction()
local result = getAccountName()
log("getAccountName: " .. tostring(result))
end
log("getAccountName: " .. tostring(result))
endSignatureresult = getPokedexOwned()
Returns Owned Entry of the pokedex
Use this query as a guard before an action that depends on the current global state.
integer example: 1
POST /lua/general-state/getpokedexowned
function onPathAction()
function onPathAction()
local result = getPokedexOwned()
log("getPokedexOwned: " .. tostring(result))
end
log("getPokedexOwned: " .. tostring(result))
endSignatureresult = getPokedexSeen()
Returns Seen Entry of the pokedex
Use this query as a guard before an action that depends on the current global state.
integer example: 1
POST /lua/general-state/getpokedexseen
function onPathAction()
function onPathAction()
local result = getPokedexSeen()
log("getPokedexSeen: " .. tostring(result))
end
log("getPokedexSeen: " .. tostring(result))
endSignatureresult = getPokedexEvolved()
Returns Evolved Entry of the pokedex
Use this query as a guard before an action that depends on the current global state.
integer example: 1
POST /lua/general-state/getpokedexevolved
function onPathAction()
function onPathAction()
local result = getPokedexEvolved()
log("getPokedexEvolved: " .. tostring(result))
end
log("getPokedexEvolved: " .. tostring(result))
endSignatureresult = getTeamSize()
Returns the amount of pokémon in the team.
Use this query as a guard before an action that depends on the current global state.
integer example: 1
POST /lua/general-state/getteamsize
function onPathAction()
function onPathAction()
local result = getTeamSize()
log("getTeamSize: " .. tostring(result))
end
log("getTeamSize: " .. tostring(result))
endSignatureresult = isGameScriptActive()
Lua function isGameScriptActive.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isgamescriptactive
function onPathAction()
function onPathAction()
local result = isGameScriptActive()
log("isGameScriptActive: " .. tostring(result))
end
log("isGameScriptActive: " .. tostring(result))
endSignatureresult = isAccountMember()
Returns current account's membership status.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isaccountmember
function onPathAction()
function onPathAction()
local result = isAccountMember()
log("isAccountMember: " .. tostring(result))
end
log("isAccountMember: " .. tostring(result))
endSignatureresult = getRemainingPowerPoints(pokemonIndex, moveName)
Returns the remaining power points of the specified move of the specified pokémon in the team.
Use this query as a guard before an action that depends on the current global state.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
moveName | string | yes | Exact move name as shown by the game. |
integer example: 1
POST /lua/general-state/getremainingpowerpoints
function onPathAction()
function onPathAction()
local result = getRemainingPowerPoints(1, "Tackle")
log("getRemainingPowerPoints: " .. tostring(result))
end
log("getRemainingPowerPoints: " .. tostring(result))
endSignatureresult = isShopOpen()
Returns true if there is a shop opened.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isshopopen
function onPathAction()
function onPathAction()
local result = isShopOpen()
log("isShopOpen: " .. tostring(result))
end
log("isShopOpen: " .. tostring(result))
endSignatureresult = isRelearningMoves()
Returns true if the player is relearning the move of a Pokemon from an NPC.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isrelearningmoves
function onPathAction()
function onPathAction()
local result = isRelearningMoves()
log("isRelearningMoves: " .. tostring(result))
end
log("isRelearningMoves: " .. tostring(result))
endSignatureresult = getMoney()
Returns the amount of money in the inventory.
Use this query as a guard before an action that depends on the current global state.
integer example: 1
POST /lua/general-state/getmoney
function onPathAction()
function onPathAction()
local result = getMoney()
log("getMoney: " .. tostring(result))
end
log("getMoney: " .. tostring(result))
endSignatureresult = isMounted()
Returns true if the player is riding a mount or the bicycle.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/ismounted
function onPathAction()
function onPathAction()
local result = isMounted()
log("isMounted: " .. tostring(result))
end
log("isMounted: " .. tostring(result))
endSignatureresult = isSurfing()
Returns true if the player is surfing
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/issurfing
function onPathAction()
function onPathAction()
local result = isSurfing()
log("isSurfing: " .. tostring(result))
end
log("isSurfing: " .. tostring(result))
endSignatureresult = isPrivateMessageEnabled()
Check if the private message from normal users are blocked.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isprivatemessageenabled
function onPathAction()
function onPathAction()
local result = isPrivateMessageEnabled()
log("isPrivateMessageEnabled: " .. tostring(result))
end
log("isPrivateMessageEnabled: " .. tostring(result))
endSignatureresult = isPartyInspectionEnabled()
Check if party inspections are turned on.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/ispartyinspectionenabled
function onPathAction()
function onPathAction()
local result = isPartyInspectionEnabled()
log("isPartyInspectionEnabled: " .. tostring(result))
end
log("isPartyInspectionEnabled: " .. tostring(result))
endSignatureresult = isNpcInteractionsEnabled()
Returns true if the bot is checking for npc interactions.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isnpcinteractionsenabled
function onPathAction()
function onPathAction()
local result = isNpcInteractionsEnabled()
log("isNpcInteractionsEnabled: " .. tostring(result))
end
log("isNpcInteractionsEnabled: " .. tostring(result))
endSignaturehour, minute = getTime()
Return the current in game hour and minute.
Read both return values when a route should run only during a specific in-game time window.
object example: {"hour": 12, "minute": 34}
POST /lua/general-state/gettime
function onPathAction()
local hour, minute = getTime()
if hour >= 20 or hour < 5 then
log(string.format("Night route active at %02d:%02d", hour, minute))
moveToGrass()
return
end
endSignatureresult = isMorning()
Return true if morning time.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/ismorning
function onPathAction()
function onPathAction()
local result = isMorning()
log("isMorning: " .. tostring(result))
end
log("isMorning: " .. tostring(result))
endSignatureresult = isNoon()
Return true if noon time.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isnoon
function onPathAction()
function onPathAction()
local result = isNoon()
log("isNoon: " .. tostring(result))
end
log("isNoon: " .. tostring(result))
endSignatureresult = isNight()
Return true if night time.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isnight
function onPathAction()
function onPathAction()
local result = isNight()
log("isNight: " .. tostring(result))
end
log("isNight: " .. tostring(result))
endSignatureresult = isOutside()
Return true if the character is outside.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isoutside
function onPathAction()
function onPathAction()
local result = isOutside()
log("isOutside: " .. tostring(result))
end
log("isOutside: " .. tostring(result))
endSignatureresult = isAutoEvolve()
Return the state Auto Evolve
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/isautoevolve
function onPathAction()
function onPathAction()
local result = isAutoEvolve()
log("isAutoEvolve: " .. tostring(result))
end
log("isAutoEvolve: " .. tostring(result))
endSignatureresult = setMount(mount)
Configure the ground mount or bike item that the bot should use while moving on outside ground maps. Pass the exact item name, for example Arcanine Mount or Blue Bicycle. Pass an empty string to clear the configured ground mount. The function only configures the item; the tool uses it automatically before movement when appropriate.
Configure this state deliberately and verify the related query before issuing further movement.
| Name | Type | Required | Description |
|---|---|---|---|
mount | string | yes | Exact mount or bicycle item name; an empty string clears the configuration. |
boolean example: true
POST /lua/general-state/setmount
function onStart()
function onStart()
local result = setMount("Arcanine Mount")
log("Configured setMount.")
end
log("Configured setMount.")
endSignatureresult = disMount()
Disables automatic ground mounting and dismounts the currently active ground mount by toggling the official mount item packet. It affects ground mounts and bicycles only; it does not cancel Surf. The configured ground mount is cleared, so call setMount() again before expecting automatic ground mounting later. Returns true when the configured mount was cleared or a dismount packet was sent, otherwise false when there was nothing to change.
Use this before entering an area where a ground mount is unwanted. It also clears automatic ground-mount configuration.
boolean example: true
POST /lua/general-state/dismount
function onPathAction()
if isMounted() and not isSurfing() then
disMount()
return
end
moveToCell(10, 15)
endSignatureresult = setWaterMount(mount)
Configure an optional water mount item that should be used when the bot needs to start surfing. Call this before a path that may enter water. Most scripts can leave it unset; without a water mount, useSurf() and pathfinding use the normal /surf flow. Pass an empty string to clear the configured water mount.
Configure this state deliberately and verify the related query before issuing further movement.
| Name | Type | Required | Description |
|---|---|---|---|
mount | string | yes | Exact mount or bicycle item name; an empty string clears the configuration. |
boolean example: true
POST /lua/general-state/setwatermount
function onStart()
function onStart()
local result = setWaterMount("Lapras Mount")
log("Configured setWaterMount.")
end
log("Configured setWaterMount.")
endSignatureresult = isCurrentPCBoxRefreshed()
Returns true when the latest requested PC box action has completed or there is no pending PC box refresh. Use this after usePC(), openPCBox(), or refreshPCBox() before reading PC Pokémon data.
Use this query as a guard before an action that depends on the current global state.
boolean example: true
POST /lua/general-state/iscurrentpcboxrefreshed
function onPathAction()
function onPathAction()
local result = isCurrentPCBoxRefreshed()
log("isCurrentPCBoxRefreshed: " .. tostring(result))
end
log("isCurrentPCBoxRefreshed: " .. tostring(result))
endSignatureresult = getServer()
Returns the connected server
Use this query as a guard before an action that depends on the current global state.
string example: "value"
POST /lua/general-state/getserver
function onPathAction()
function onPathAction()
local result = getServer()
log("getServer: " .. tostring(result))
end
log("getServer: " .. tostring(result))
endSignatureresult = getPokemonId(index)
Returns the ID of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonid
function onPathAction()
function onPathAction()
local result = getPokemonId(1)
log("getPokemonId: " .. tostring(result))
end
log("getPokemonId: " .. tostring(result))
endSignatureresult = getPokemonName(index)
Returns the name of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemonname
function onPathAction()
function onPathAction()
local result = getPokemonName(1)
log("getPokemonName: " .. tostring(result))
end
log("getPokemonName: " .. tostring(result))
endSignatureresult = getPokemonHealth(index)
Returns the current health of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonhealth
function onPathAction()
function onPathAction()
local result = getPokemonHealth(1)
log("getPokemonHealth: " .. tostring(result))
end
log("getPokemonHealth: " .. tostring(result))
endSignatureresult = getPokemonHealthPercent(index)
Returns the percentage of remaining health of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonhealthpercent
function onPathAction()
function onPathAction()
local result = getPokemonHealthPercent(1)
log("getPokemonHealthPercent: " .. tostring(result))
end
log("getPokemonHealthPercent: " .. tostring(result))
endSignatureresult = getPokemonMaxHealth(index)
Returns the maximum health of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonmaxhealth
function onPathAction()
function onPathAction()
local result = getPokemonMaxHealth(1)
log("getPokemonMaxHealth: " .. tostring(result))
end
log("getPokemonMaxHealth: " .. tostring(result))
endSignatureresult = getPokemonLevel(index)
Returns the level of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonlevel
function onPathAction()
function onPathAction()
local result = getPokemonLevel(1)
log("getPokemonLevel: " .. tostring(result))
end
log("getPokemonLevel: " .. tostring(result))
endSignatureresult = getPokemonTotalExperience(index)
Returns the experience total of a pokemon level.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemontotalexperience
function onPathAction()
function onPathAction()
local result = getPokemonTotalExperience(1)
log("getPokemonTotalExperience: " .. tostring(result))
end
log("getPokemonTotalExperience: " .. tostring(result))
endSignatureresult = getPokemonRemainingExperience(index)
Returns the remaining experience of a pokemon before next level.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonremainingexperience
function onPathAction()
function onPathAction()
local result = getPokemonRemainingExperience(1)
log("getPokemonRemainingExperience: " .. tostring(result))
end
log("getPokemonRemainingExperience: " .. tostring(result))
endSignatureresult = getPokemonStatus(index)
Returns the status of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemonstatus
function onPathAction()
function onPathAction()
local result = getPokemonStatus(1)
log("getPokemonStatus: " .. tostring(result))
end
log("getPokemonStatus: " .. tostring(result))
endSignatureresult = getPokemonForm(index)
Returns the form of the specified pokémon in the team (0 if no form).
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonform
function onPathAction()
function onPathAction()
local result = getPokemonForm(1)
log("getPokemonForm: " .. tostring(result))
end
log("getPokemonForm: " .. tostring(result))
endSignatureresult = getPokemonHeldItem(index)
Returns the item held by the specified pokemon in the team, null if empty.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemonhelditem
function onPathAction()
function onPathAction()
local result = getPokemonHeldItem(1)
log("getPokemonHeldItem: " .. tostring(result))
end
log("getPokemonHeldItem: " .. tostring(result))
endSignatureresult = getPokemonUniqueId(pokemonUid)
PROCatchem unique ID of the pokemon of the current box matching the ID.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonUid | integer | yes | Stable Pokémon database/unique identifier returned by the corresponding query API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonuniqueid
function onPathAction()
function onPathAction()
local result = getPokemonUniqueId(1)
log("getPokemonUniqueId: " .. tostring(result))
end
log("getPokemonUniqueId: " .. tostring(result))
endSignatureresult = getPokemonMaxPowerPoints(index, moveId)
Max move PP of the pokemon of the current box matching the ID.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
integer example: 1
POST /lua/team-pok-mon/getpokemonmaxpowerpoints
function onPathAction()
function onPathAction()
local result = getPokemonMaxPowerPoints(1, "Tackle")
log("getPokemonMaxPowerPoints: " .. tostring(result))
end
log("getPokemonMaxPowerPoints: " .. tostring(result))
endSignatureresult = isPokemonShiny(index)
Returns the shyniness of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
boolean example: true
POST /lua/team-pok-mon/ispokemonshiny
function onPathAction()
function onPathAction()
local result = isPokemonShiny(1)
log("isPokemonShiny: " .. tostring(result))
end
log("isPokemonShiny: " .. tostring(result))
endSignatureresult = getPokemonMoveName(index, moveId)
Returns the move of the specified pokémon in the team at the specified index.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
string example: "value"
POST /lua/team-pok-mon/getpokemonmovename
function onPathAction()
function onPathAction()
local result = getPokemonMoveName(1, "Tackle")
log("getPokemonMoveName: " .. tostring(result))
end
log("getPokemonMoveName: " .. tostring(result))
endSignatureresult = getPokemonMoveAccuracy(index, moveId)
Returns the move accuracy of the specified pokémon in the team at the specified index.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
integer example: 1
POST /lua/team-pok-mon/getpokemonmoveaccuracy
function onPathAction()
function onPathAction()
local result = getPokemonMoveAccuracy(1, "Tackle")
log("getPokemonMoveAccuracy: " .. tostring(result))
end
log("getPokemonMoveAccuracy: " .. tostring(result))
endSignatureresult = getPokemonMovePower(index, moveId)
Returns the move power of the specified pokémon in the team at the specified index.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
integer example: 1
POST /lua/team-pok-mon/getpokemonmovepower
function onPathAction()
function onPathAction()
local result = getPokemonMovePower(1, "Tackle")
log("getPokemonMovePower: " .. tostring(result))
end
log("getPokemonMovePower: " .. tostring(result))
endSignatureresult = getPokemonMoveType(index, moveId)
Returns the move type of the specified pokémon in the team at the specified index.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
string example: "value"
POST /lua/team-pok-mon/getpokemonmovetype
function onPathAction()
function onPathAction()
local result = getPokemonMoveType(1, "Tackle")
log("getPokemonMoveType: " .. tostring(result))
end
log("getPokemonMoveType: " .. tostring(result))
endSignatureresult = getPokemonMoveDamageType(index, moveId)
Returns the move damage type of the specified pokémon in the team at the specified index.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
string example: "value"
POST /lua/team-pok-mon/getpokemonmovedamagetype
function onPathAction()
function onPathAction()
local result = getPokemonMoveDamageType(1, "Tackle")
log("getPokemonMoveDamageType: " .. tostring(result))
end
log("getPokemonMoveDamageType: " .. tostring(result))
endSignatureresult = getPokemonMoveStatus(index, moveId)
Returns true if the move of the specified pokémon in the team at the specified index can apply a status .
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
boolean example: true
POST /lua/team-pok-mon/getpokemonmovestatus
function onPathAction()
function onPathAction()
local result = getPokemonMoveStatus(1, "Tackle")
log("getPokemonMoveStatus: " .. tostring(result))
end
log("getPokemonMoveStatus: " .. tostring(result))
endSignatureresult = getPokemonNature(index)
Nature of the pokemon of the current box matching the ID.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemonnature
function onPathAction()
function onPathAction()
local result = getPokemonNature(1)
log("getPokemonNature: " .. tostring(result))
end
log("getPokemonNature: " .. tostring(result))
endSignatureresult = getPokemonAbility(index)
Ability of the pokemon of the current box matching the ID.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemonability
function onPathAction()
function onPathAction()
local result = getPokemonAbility(1)
log("getPokemonAbility: " .. tostring(result))
end
log("getPokemonAbility: " .. tostring(result))
endSignatureresult = getPokemonStat(pokemonIndex, statType)
Returns the value for the specified stat of the specified pokémon in the team.
Read a current team stat by its documented stat key.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
integer example: 1
POST /lua/team-pok-mon/getpokemonstat
function onPathAction()
local speed = getPokemonStat(1, "SPE")
log("Lead Pokémon Speed: " .. tostring(speed))
endSignatureresult = getPokemonEffortValue(pokemonIndex, statType)
Returns the effort value for the specified stat of the specified pokémon in the team.
Inspect a team Pokémon EV before deciding whether to keep training that stat.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
integer example: 1
POST /lua/team-pok-mon/getpokemoneffortvalue
function onPathAction()
local attackEV = getPokemonEffortValue(1, "ATK")
if attackEV >= 252 then
log("Attack EV training is complete.")
end
endSignatureresult = getPokemonIndividualValue(pokemonIndex, statType)
Returns the individual value for the specified stat of the specified pokémon in the team.
Inspect a team Pokémon IV when filtering catches or selecting a lead.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
integer example: 1
POST /lua/team-pok-mon/getpokemonindividualvalue
function onPathAction()
local speedIV = getPokemonIndividualValue(1, "SPE")
log("Lead Pokémon Speed IV: " .. tostring(speedIV))
endSignatureresult = getPokemonHappiness(index)
Returns the happiness of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
integer example: 1
POST /lua/team-pok-mon/getpokemonhappiness
function onPathAction()
function onPathAction()
local result = getPokemonHappiness(1)
log("getPokemonHappiness: " .. tostring(result))
end
log("getPokemonHappiness: " .. tostring(result))
endSignatureresult = getPokemonRegion(index)
Returns the region of capture of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemonregion
function onPathAction()
function onPathAction()
local result = getPokemonRegion(1)
log("getPokemonRegion: " .. tostring(result))
end
log("getPokemonRegion: " .. tostring(result))
endSignatureresult = getPokemonOriginalTrainer(index)
Returns the original trainer of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemonoriginaltrainer
function onPathAction()
function onPathAction()
local result = getPokemonOriginalTrainer(1)
log("getPokemonOriginalTrainer: " .. tostring(result))
end
log("getPokemonOriginalTrainer: " .. tostring(result))
endSignatureresult = getPokemonGender(index)
Returns the gender of the specified pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/team-pok-mon/getpokemongender
function onPathAction()
function onPathAction()
local result = getPokemonGender(1)
log("getPokemonGender: " .. tostring(result))
end
log("getPokemonGender: " .. tostring(result))
endSignatureresult = getPokemonType(index)
Returns the type of the specified pokémon in the team as an array of length 2.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
array<string> example: []
POST /lua/team-pok-mon/getpokemontype
function onPathAction()
function onPathAction()
local result = getPokemonType(1)
log("getPokemonType: " .. tostring(result))
end
log("getPokemonType: " .. tostring(result))
endSignatureresult = getDamageMultiplier(attacker, ...)
Returns the multiplier of the damage type between an attacking type and one or two defending types.
Compare one attacking type against the opponent's one or two defending types.
| Name | Type | Required | Description |
|---|---|---|---|
attacker | string | yes | Value passed to the `attacker` parameter. |
defender | array<LuaValue> | yes | Value passed to the `defender` parameter. |
number example: 1.0
POST /lua/team-pok-mon/getdamagemultiplier
function onBattleAction()
local opponentTypes = getOpponentType()
local multiplier = getDamageMultiplier("ELECTRIC", opponentTypes)
if multiplier >= 2 then
useMove("Thunderbolt")
else
attack()
end
endSignatureresult = isPokemonUsable(index)
Returns true if the specified pokémon has is alive and has an offensive attack available.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
boolean example: true
POST /lua/team-pok-mon/ispokemonusable
function onPathAction()
function onPathAction()
local result = isPokemonUsable(1)
log("isPokemonUsable: " .. tostring(result))
end
log("isPokemonUsable: " .. tostring(result))
endSignatureresult = getUsablePokemonCount()
Returns the amount of usable pokémon in the team.
Use this query to make team decisions before selecting a path or battle action.
integer example: 1
POST /lua/team-pok-mon/getusablepokemoncount
function onPathAction()
function onPathAction()
local result = getUsablePokemonCount()
log("getUsablePokemonCount: " .. tostring(result))
end
log("getUsablePokemonCount: " .. tostring(result))
endSignatureresult = hasMove(pokemonIndex, moveName)
Returns true if the specified pokémon has a move with the specified name.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
moveName | string | yes | Exact move name as shown by the game. |
boolean example: true
POST /lua/team-pok-mon/hasmove
function onPathAction()
function onPathAction()
local result = hasMove(1, "Tackle")
log("hasMove: " .. tostring(result))
end
log("hasMove: " .. tostring(result))
endSignatureresult = hasPokemonInTeam(pokemonName)
Returns true if the specified pokémon is present in the team.
Guard routes that require a specific Pokémon in the current team.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonName | string | yes | Value passed to the `pokemonName` parameter. |
boolean example: true
POST /lua/team-pok-mon/haspokemoninteam
function onPathAction()
if not hasPokemonInTeam("Pikachu") then
fatal("Put Pikachu in the team before starting this route.")
return
end
moveToGrass()
endSignatureresult = isTeamSortedByLevelAscending()
Returns true if the team is sorted by level in ascending order.
Use this query to make team decisions before selecting a path or battle action.
boolean example: true
POST /lua/team-pok-mon/isteamsortedbylevelascending
function onPathAction()
function onPathAction()
local result = isTeamSortedByLevelAscending()
log("isTeamSortedByLevelAscending: " .. tostring(result))
end
log("isTeamSortedByLevelAscending: " .. tostring(result))
endSignatureresult = isTeamSortedByLevelDescending()
Returns true if the team is sorted by level in descending order.
Use this query to make team decisions before selecting a path or battle action.
boolean example: true
POST /lua/team-pok-mon/isteamsortedbyleveldescending
function onPathAction()
function onPathAction()
local result = isTeamSortedByLevelDescending()
log("isTeamSortedByLevelDescending: " .. tostring(result))
end
log("isTeamSortedByLevelDescending: " .. tostring(result))
endSignatureresult = isTeamRangeSortedByLevelAscending(fromIndex, toIndex)
Returns true if the specified part of the team is sorted by level in ascending order.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
fromIndex | integer | yes | Value passed to the `fromIndex` parameter. |
toIndex | integer | yes | Value passed to the `toIndex` parameter. |
boolean example: true
POST /lua/team-pok-mon/isteamrangesortedbylevelascending
function onPathAction()
function onPathAction()
local result = isTeamRangeSortedByLevelAscending(10, 10)
log("isTeamRangeSortedByLevelAscending: " .. tostring(result))
end
log("isTeamRangeSortedByLevelAscending: " .. tostring(result))
endSignatureresult = isTeamRangeSortedByLevelDescending(fromIndex, toIndex)
Returns true if the specified part of the team the team is sorted by level in descending order.
Use this query to make team decisions before selecting a path or battle action.
| Name | Type | Required | Description |
|---|---|---|---|
fromIndex | integer | yes | Value passed to the `fromIndex` parameter. |
toIndex | integer | yes | Value passed to the `toIndex` parameter. |
boolean example: true
POST /lua/team-pok-mon/isteamrangesortedbyleveldescending
function onPathAction()
function onPathAction()
local result = isTeamRangeSortedByLevelDescending(10, 10)
log("isTeamRangeSortedByLevelDescending: " .. tostring(result))
end
log("isTeamRangeSortedByLevelDescending: " .. tostring(result))
endSignatureresult = hasItem(itemName)
Returns true if the specified item is in the inventory.
Use this query to guard an item or shop action and avoid sending requests that cannot succeed.
| Name | Type | Required | Description |
|---|---|---|---|
itemName | string | yes | Exact item name as shown in the inventory. |
boolean example: true
POST /lua/items-and-shop/hasitem
function onPathAction()
function onPathAction()
local result = hasItem("Potion")
if result then
log("hasItem condition is true")
end
end
if result then
log("hasItem condition is true")
end
endSignatureresult = getItemQuantity(itemName)
Returns the quantity of the specified item in the inventory.
Use this query to guard an item or shop action and avoid sending requests that cannot succeed.
| Name | Type | Required | Description |
|---|---|---|---|
itemName | string | yes | Exact item name as shown in the inventory. |
integer example: 1
POST /lua/items-and-shop/getitemquantity
function onPathAction()
function onPathAction()
local result = getItemQuantity("Potion")
if result then
log("getItemQuantity condition is true")
end
end
if result then
log("getItemQuantity condition is true")
end
endSignatureresult = hasItemId(itemid)
Returns true if the specified item is in the inventory.
Use this query to guard an item or shop action and avoid sending requests that cannot succeed.
| Name | Type | Required | Description |
|---|---|---|---|
itemid | integer | yes | Value passed to the `itemid` parameter. |
boolean example: true
POST /lua/items-and-shop/hasitemid
function onPathAction()
function onPathAction()
local result = hasItemId("Potion")
if result then
log("hasItemId condition is true")
end
end
if result then
log("hasItemId condition is true")
end
endSignatureresult = getItemQuantityId(itemid)
Returns the quantity of the specified item in the inventory.
Use this query to guard an item or shop action and avoid sending requests that cannot succeed.
| Name | Type | Required | Description |
|---|---|---|---|
itemid | integer | yes | Value passed to the `itemid` parameter. |
integer example: 1
POST /lua/items-and-shop/getitemquantityid
function onPathAction()
function onPathAction()
local result = getItemQuantityId("Potion")
if result then
log("getItemQuantityId condition is true")
end
end
if result then
log("getItemQuantityId condition is true")
end
endSignatureresult = buyItem(itemName, quantity)
Buys the specified item from the opened shop.
Check inventory/shop state first, perform this action once, then return so the server can update state.
| Name | Type | Required | Description |
|---|---|---|---|
itemName | string | yes | Exact item name as shown in the inventory. |
quantity | integer | yes | Value passed to the `quantity` parameter. |
boolean example: true
POST /lua/items-and-shop/buyitem
function onPathAction()
function onPathAction()
local result = buyItem("Potion", 15)
return
end
return
endSignatureresult = hasShopItem(itemName)
Lua function hasShopItem.
Use this query to guard an item or shop action and avoid sending requests that cannot succeed.
| Name | Type | Required | Description |
|---|---|---|---|
itemName | string | yes | Exact item name as shown in the inventory. |
boolean example: true
POST /lua/items-and-shop/hasshopitem
function onPathAction()
function onPathAction()
local result = hasShopItem("Potion")
if result then
log("hasShopItem condition is true")
end
end
if result then
log("hasShopItem condition is true")
end
endSignatureresult = giveItemToPokemon(itemName, pokemonIndex)
Give the specified item on the specified pokemon.
Check inventory/shop state first, perform this action once, then return so the server can update state.
| Name | Type | Required | Description |
|---|---|---|---|
itemName | string | yes | Exact item name as shown in the inventory. |
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
boolean example: true
POST /lua/items-and-shop/giveitemtopokemon
function onPathAction()
function onPathAction()
local result = giveItemToPokemon("Potion", 1)
return
end
return
endSignatureresult = takeItemFromPokemon(index)
Take the held item from the specified pokemon.
Check inventory/shop state first, perform this action once, then return so the server can update state.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
boolean example: true
POST /lua/items-and-shop/takeitemfrompokemon
function onPathAction()
function onPathAction()
local result = takeItemFromPokemon(1)
return
end
return
endSignatureresult = useItem(itemName)
Uses the specified item.
Check inventory/shop state first, perform this action once, then return so the server can update state.
| Name | Type | Required | Description |
|---|---|---|---|
itemName | string | yes | Exact item name as shown in the inventory. |
boolean example: true
POST /lua/items-and-shop/useitem
function onPathAction()
function onPathAction()
local result = useItem("Potion")
return
end
return
endSignatureresult = useItemOnPokemon(itemName, pokemonIndex)
Uses the specified item on the specified pokémon.
Check inventory/shop state first, perform this action once, then return so the server can update state.
| Name | Type | Required | Description |
|---|---|---|---|
itemName | string | yes | Exact item name as shown in the inventory. |
pokemonIndex | integer | yes | One-based Pokémon index in the current team. |
boolean example: true
POST /lua/items-and-shop/useitemonpokemon
function onPathAction()
function onPathAction()
local result = useItemOnPokemon("Potion", 1)
return
end
return
endSignatureresult = getCurrentPCBoxId()
Get the active PC Box.
Read this value only after the PC is open and the selected box is refreshed.
integer example: 1
POST /lua/pc-storage/getcurrentpcboxid
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getCurrentPCBoxId()
log("getCurrentPCBoxId: " .. tostring(result))
end
log("getCurrentPCBoxId: " .. tostring(result))
endSignatureresult = isPCOpen()
Check if the PC is open. Moving close the PC, usePC() opens it.
Read this value only after the PC is open and the selected box is refreshed.
boolean example: true
POST /lua/pc-storage/ispcopen
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = isPCOpen()
log("isPCOpen: " .. tostring(result))
end
log("isPCOpen: " .. tostring(result))
endSignatureresult = getCurrentPCBoxSize()
Returns the number of Pokémon currently cached in the visible PC box. PC boxes can hold up to 30 slots; use this as the safe upper bound for one-based boxPokemonId indexes after the box is refreshed.
Read this value only after the PC is open and the selected box is refreshed.
integer example: 1
POST /lua/pc-storage/getcurrentpcboxsize
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getCurrentPCBoxSize()
log("getCurrentPCBoxSize: " .. tostring(result))
end
log("getCurrentPCBoxSize: " .. tostring(result))
endSignatureresult = getPCBoxCount()
Return the number of non-empty boxes in the PC
Read this value only after the PC is open and the selected box is refreshed.
integer example: 1
POST /lua/pc-storage/getpcboxcount
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPCBoxCount()
log("getPCBoxCount: " .. tostring(result))
end
log("getPCBoxCount: " .. tostring(result))
endSignatureresult = getPCPokemonCount()
Returns the latest known total Pokémon count for the current PC storage view. The value is read from server PC metadata when available and should not be inferred from internal slot IDs.
Read this value only after the PC is open and the selected box is refreshed.
integer example: 1
POST /lua/pc-storage/getpcpokemoncount
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPCPokemonCount()
log("getPCPokemonCount: " .. tostring(result))
end
log("getPCPokemonCount: " .. tostring(result))
endSignatureresult = getPokemonIdFromPC(boxId, boxPokemonId)
Pokedex ID of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonidfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonIdFromPC(1, 1)
log("getPokemonIdFromPC: " .. tostring(result))
end
log("getPokemonIdFromPC: " .. tostring(result))
endSignatureresult = getPokemonNameFromPC(boxId, boxPokemonId)
Name of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemonnamefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonNameFromPC(1, 1)
log("getPokemonNameFromPC: " .. tostring(result))
end
log("getPokemonNameFromPC: " .. tostring(result))
endSignatureresult = getPokemonHealthFromPC(boxId, boxPokemonId)
Current HP of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonhealthfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonHealthFromPC(1, 1)
log("getPokemonHealthFromPC: " .. tostring(result))
end
log("getPokemonHealthFromPC: " .. tostring(result))
endSignatureresult = getPokemonHealthPercentFromPC(boxId, boxPokemonId)
Returns the percentage of remaining health of the specified pokémon in the team.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonhealthpercentfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonHealthPercentFromPC(1, 1)
log("getPokemonHealthPercentFromPC: " .. tostring(result))
end
log("getPokemonHealthPercentFromPC: " .. tostring(result))
endSignatureresult = getPokemonMaxHealthFromPC(boxId, boxPokemonId)
Max HP of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonmaxhealthfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMaxHealthFromPC(1, 1)
log("getPokemonMaxHealthFromPC: " .. tostring(result))
end
log("getPokemonMaxHealthFromPC: " .. tostring(result))
endSignatureresult = getPokemonLevelFromPC(boxId, boxPokemonId)
Level of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonlevelfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonLevelFromPC(1, 1)
log("getPokemonLevelFromPC: " .. tostring(result))
end
log("getPokemonLevelFromPC: " .. tostring(result))
endSignatureresult = getPokemonTotalExperienceFromPC(boxId, boxPokemonId)
Total of experience cost of a level for the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemontotalexperiencefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonTotalExperienceFromPC(1, 1)
log("getPokemonTotalExperienceFromPC: " .. tostring(result))
end
log("getPokemonTotalExperienceFromPC: " .. tostring(result))
endSignatureresult = getPokemonRemainingExperienceFromPC(boxId, boxPokemonId)
Remaining experience before the next level of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonremainingexperiencefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonRemainingExperienceFromPC(1, 1)
log("getPokemonRemainingExperienceFromPC: " .. tostring(result))
end
log("getPokemonRemainingExperienceFromPC: " .. tostring(result))
endSignatureresult = getPokemonStatusFromPC(boxId, boxPokemonId)
Status of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemonstatusfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonStatusFromPC(1, 1)
log("getPokemonStatusFromPC: " .. tostring(result))
end
log("getPokemonStatusFromPC: " .. tostring(result))
endSignatureresult = getPokemonTypeFromPC(boxId, boxPokemonId)
Type of the pokemon of the current box matching the ID as an array of length 2.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
array<string> example: []
POST /lua/pc-storage/getpokemontypefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonTypeFromPC(1, 1)
log("getPokemonTypeFromPC: " .. tostring(result))
end
log("getPokemonTypeFromPC: " .. tostring(result))
endSignatureresult = getPokemonHeldItemFromPC(boxId, boxPokemonId)
Returns the item held by the specified pokemon in the PC, null if empty.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemonhelditemfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonHeldItemFromPC(1, 1)
log("getPokemonHeldItemFromPC: " .. tostring(result))
end
log("getPokemonHeldItemFromPC: " .. tostring(result))
endSignatureresult = getPokemonUniqueIdFromPC(boxId, boxPokemonId)
PROCatchem custom unique ID of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonuniqueidfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonUniqueIdFromPC(1, 1)
log("getPokemonUniqueIdFromPC: " .. tostring(result))
end
log("getPokemonUniqueIdFromPC: " .. tostring(result))
endSignatureresult = getPokemonRemainingPowerPointsFromPC(boxId, boxPokemonId, moveId)
Current move PP of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
integer example: 1
POST /lua/pc-storage/getpokemonremainingpowerpointsfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonRemainingPowerPointsFromPC(1, 1, "Tackle")
log("getPokemonRemainingPowerPointsFromPC: " .. tostring(result))
end
log("getPokemonRemainingPowerPointsFromPC: " .. tostring(result))
endSignatureresult = getPokemonMaxPowerPointsFromPC(boxId, boxPokemonId, moveId)
Max move PP of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
integer example: 1
POST /lua/pc-storage/getpokemonmaxpowerpointsfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMaxPowerPointsFromPC(1, 1, "Tackle")
log("getPokemonMaxPowerPointsFromPC: " .. tostring(result))
end
log("getPokemonMaxPowerPointsFromPC: " .. tostring(result))
endSignatureresult = isPokemonFromPCShiny(boxId, boxPokemonId)
Shyniness of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
boolean example: true
POST /lua/pc-storage/ispokemonfrompcshiny
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = isPokemonFromPCShiny(1, 1)
log("isPokemonFromPCShiny: " .. tostring(result))
end
log("isPokemonFromPCShiny: " .. tostring(result))
endSignatureresult = getPokemonMoveNameFromPC(boxId, boxPokemonId, moveId)
Move of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
string example: "value"
POST /lua/pc-storage/getpokemonmovenamefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMoveNameFromPC(1, 1, "Tackle")
log("getPokemonMoveNameFromPC: " .. tostring(result))
end
log("getPokemonMoveNameFromPC: " .. tostring(result))
endSignatureresult = getPokemonMoveAccuracyFromPC(boxId, boxPokemonId, moveId)
Returns the move accuracy of the specified pokémon in the box at the specified index.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
integer example: 1
POST /lua/pc-storage/getpokemonmoveaccuracyfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMoveAccuracyFromPC(1, 1, "Tackle")
log("getPokemonMoveAccuracyFromPC: " .. tostring(result))
end
log("getPokemonMoveAccuracyFromPC: " .. tostring(result))
endSignatureresult = getPokemonMovePowerFromPC(boxId, boxPokemonId, moveId)
Returns the move power of the specified pokémon in the box at the specified index.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
integer example: 1
POST /lua/pc-storage/getpokemonmovepowerfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMovePowerFromPC(1, 1, "Tackle")
log("getPokemonMovePowerFromPC: " .. tostring(result))
end
log("getPokemonMovePowerFromPC: " .. tostring(result))
endSignatureresult = getPokemonMoveTypeFromPC(boxId, boxPokemonId, moveId)
Returns the move type of the specified pokémon in the box at the specified index.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
string example: "value"
POST /lua/pc-storage/getpokemonmovetypefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMoveTypeFromPC(1, 1, "Tackle")
log("getPokemonMoveTypeFromPC: " .. tostring(result))
end
log("getPokemonMoveTypeFromPC: " .. tostring(result))
endSignatureresult = getPokemonMoveDamageTypeFromPC(boxId, boxPokemonId, moveId)
Returns the move damage type of the specified pokémon in the box at the specified index.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
string example: "value"
POST /lua/pc-storage/getpokemonmovedamagetypefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMoveDamageTypeFromPC(1, 1, "Tackle")
log("getPokemonMoveDamageTypeFromPC: " .. tostring(result))
end
log("getPokemonMoveDamageTypeFromPC: " .. tostring(result))
endSignatureresult = getPokemonMoveStatusFromPC(boxId, boxPokemonId, moveId)
Returns true if the move of the specified pokémon in the box at the specified index can apply a status .
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
moveId | integer | yes | Value passed to the `moveId` parameter. |
boolean example: true
POST /lua/pc-storage/getpokemonmovestatusfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonMoveStatusFromPC(1, 1, "Tackle")
log("getPokemonMoveStatusFromPC: " .. tostring(result))
end
log("getPokemonMoveStatusFromPC: " .. tostring(result))
endSignatureresult = getPokemonNatureFromPC(boxId, boxPokemonId)
Nature of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemonnaturefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonNatureFromPC(1, 1)
log("getPokemonNatureFromPC: " .. tostring(result))
end
log("getPokemonNatureFromPC: " .. tostring(result))
endSignatureresult = getPokemonAbilityFromPC(boxId, boxPokemonId)
Ability of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemonabilityfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonAbilityFromPC(1, 1)
log("getPokemonAbilityFromPC: " .. tostring(result))
end
log("getPokemonAbilityFromPC: " .. tostring(result))
endSignatureresult = getPokemonStatFromPC(boxId, boxPokemonId, statType)
Returns the value for the specified stat of the specified pokémon in the PC.
Open and refresh the PC before reading a stored Pokémon stat.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
integer example: 1
POST /lua/pc-storage/getpokemonstatfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local speed = getPokemonStatFromPC(1, 1, "SPE")
log("Box 1 slot 1 Speed: " .. tostring(speed))
endSignatureresult = getPokemonEffortValueFromPC(boxId, boxPokemonId, statType)
Returns the effort value for the specified stat of the specified pokémon in the PC.
Read EVs from a refreshed PC entry before selecting a Pokémon to withdraw.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
integer example: 1
POST /lua/pc-storage/getpokemoneffortvaluefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local attackEV = getPokemonEffortValueFromPC(1, 1, "ATK")
log("Stored Pokémon Attack EV: " .. tostring(attackEV))
endSignatureresult = getPokemonIndividualValueFromPC(boxId, boxPokemonId, statType)
Returns the individual value for the specified stat of the specified pokémon in the PC.
Read IVs from a refreshed PC entry when filtering stored catches.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
integer example: 1
POST /lua/pc-storage/getpokemonindividualvaluefrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local speedIV = getPokemonIndividualValueFromPC(1, 1, "SPE")
log("Stored Pokémon Speed IV: " .. tostring(speedIV))
endSignatureresult = getPokemonHappinessFromPC(boxId, boxPokemonId)
Happiness of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonhappinessfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonHappinessFromPC(1, 1)
log("getPokemonHappinessFromPC: " .. tostring(result))
end
log("getPokemonHappinessFromPC: " .. tostring(result))
endSignatureresult = getPokemonRegionFromPC(boxId, boxPokemonId)
Region of capture of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemonregionfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonRegionFromPC(1, 1)
log("getPokemonRegionFromPC: " .. tostring(result))
end
log("getPokemonRegionFromPC: " .. tostring(result))
endSignatureresult = getPokemonOriginalTrainerFromPC(boxId, boxPokemonId)
Original trainer of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemonoriginaltrainerfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonOriginalTrainerFromPC(1, 1)
log("getPokemonOriginalTrainerFromPC: " .. tostring(result))
end
log("getPokemonOriginalTrainerFromPC: " .. tostring(result))
endSignatureresult = getPokemonGenderFromPC(boxId, boxPokemonId)
Gender of the pokemon of the current box matching the ID.
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
string example: "value"
POST /lua/pc-storage/getpokemongenderfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonGenderFromPC(1, 1)
log("getPokemonGenderFromPC: " .. tostring(result))
end
log("getPokemonGenderFromPC: " .. tostring(result))
endSignatureresult = getPokemonFormFromPC(boxId, boxPokemonId)
Form of the pokémon in the current box matching the ID. (0 if no form)
Read this value only after the PC is open and the selected box is refreshed.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
integer example: 1
POST /lua/pc-storage/getpokemonformfrompc
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
function inspectPC()
if not isPCOpen() or not isCurrentPCBoxRefreshed() then
return
end
local result = getPokemonFormFromPC(1, 1)
log("getPokemonFormFromPC: " .. tostring(result))
end
log("getPokemonFormFromPC: " .. tostring(result))
endSignatureresult = usePC()
Move next to the map PC when needed, open Pokémon Storage, and request the current PC box. The PC opens using the official storage flow and remains open until closed by movement or another PC action. Use isCurrentPCBoxRefreshed() before relying on the refreshed box contents.
PC actions are asynchronous. Issue one operation, return, and wait for the next server refresh before making a dependent change.
boolean example: true
POST /lua/pc-storage/usepc
function onPathAction()
if not isPCOpen() then
usePC()
return
end
function onPathAction()
if not isPCOpen() then
usePC()
return
end
local result = usePC()
return
end
return
endSignatureresult = openPCBox(boxId)
Open or refresh a PC box by its one-based box number. The visible box order uses one-based boxPokemonId indexes, while the tool internally tracks server database IDs and PC slot IDs. Wait for isCurrentPCBoxRefreshed() before reading the box immediately after opening it.
PC actions are asynchronous. Issue one operation, return, and wait for the next server refresh before making a dependent change.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boolean example: true
POST /lua/pc-storage/openpcbox
function onPathAction()
if not isPCOpen() then
usePC()
return
end
function onPathAction()
if not isPCOpen() then
usePC()
return
end
local result = openPCBox(1)
return
end
return
endSignatureresult = depositPokemonToPC(teamPokemonId)
Send the Pokémon at the one-based team index into the currently open PC box. The tool resolves the selected team Pokémon to its server database ID and waits for the server PC delta update instead of forcing an immediate full refresh. Re-check team/PC state before issuing a dependent action.
PC actions are asynchronous. Issue one operation, return, and wait for the next server refresh before making a dependent change.
| Name | Type | Required | Description |
|---|---|---|---|
teamPokemonId | integer | yes | Value passed to the `teamPokemonId` parameter. |
boolean example: true
POST /lua/pc-storage/depositpokemontopc
function onPathAction()
if not isPCOpen() then
usePC()
return
end
function onPathAction()
if not isPCOpen() then
usePC()
return
end
local result = depositPokemonToPC(2)
return
end
return
endSignatureresult = withdrawPokemonFromPC(boxId, boxPokemonId)
Move the Pokémon at the one-based PC box index into the team. The tool resolves the selected PC Pokémon to its server database ID and waits for the normal team update plus PC delta remove response. The target boxId should match the visible/refreshed PC box.
PC actions are asynchronous. Issue one operation, return, and wait for the next server refresh before making a dependent change.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
boolean example: true
POST /lua/pc-storage/withdrawpokemonfrompc
function onPathAction()
if not isPCOpen() then
usePC()
return
end
function onPathAction()
if not isPCOpen() then
usePC()
return
end
local result = withdrawPokemonFromPC(1, 1)
return
end
return
endSignatureresult = swapPokemonFromPC(boxId, boxPokemonId, teamPokemonId)
Swap the Pokémon at the one-based team index with the Pokémon at the one-based index in the selected PC box. The tool sends the official database-ID swap packet and applies the server PC delta update, so the PC Pokémon can be at any position in the box, including the first slot.
PC actions are asynchronous. Issue one operation, return, and wait for the next server refresh before making a dependent change.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
teamPokemonId | integer | yes | Value passed to the `teamPokemonId` parameter. |
boolean example: true
POST /lua/pc-storage/swappokemonfrompc
function onPathAction()
if not isPCOpen() then
usePC()
return
end
function onPathAction()
if not isPCOpen() then
usePC()
return
end
local result = swapPokemonFromPC(1, 1, 2)
return
end
return
endSignatureresult = swapPokemonWithinPC(boxId, firstBoxPokemonId, secondBoxPokemonId)
Swap two Pokémon positions inside the same visible PC box. Both PC indexes are one-based. The server returns a position-pair delta, and the tool updates the cached PC slot order without refreshing the full box.
PC actions are asynchronous. Issue one operation, return, and wait for the next server refresh before making a dependent change.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
firstBoxPokemonId | integer | yes | Value passed to the `firstBoxPokemonId` parameter. |
secondBoxPokemonId | integer | yes | Value passed to the `secondBoxPokemonId` parameter. |
boolean example: true
POST /lua/pc-storage/swappokemonwithinpc
function onPathAction()
if not isPCOpen() then
usePC()
return
end
function onPathAction()
if not isPCOpen() then
usePC()
return
end
local result = swapPokemonWithinPC(1, 1, 2)
return
end
return
endSignatureresult = releasePokemonFromPC(boxId, boxPokemonId)
Permanently release/delete the Pokémon at the one-based index in the selected PC box. This cannot be undone. The tool resolves the Pokémon database ID, sends the official release packet, and waits for the server PC delta remove update.
Release only after opening the correct box and validating the target. The operation is permanent and asynchronous.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boxPokemonId | integer | yes | One-based Pokémon position inside the selected PC box. |
boolean example: true
POST /lua/pc-storage/releasepokemonfrompc
function onPathAction()
if not isPCOpen() then
usePC()
return
end
if not isCurrentPCBoxRefreshed() then
refreshPCBox()
return
end
if getPokemonNameFromPC(1, 1) == "Rattata" then
releasePokemonFromPC(1, 1)
return
end
endSignatureresult = refreshPCBox(boxId)
Request a refresh for the specified PC box. The response can be a full box snapshot, a metadata-only update, or a delta update. Use isCurrentPCBoxRefreshed() before reading the refreshed contents immediately after this call.
PC actions are asynchronous. Issue one operation, return, and wait for the next server refresh before making a dependent change.
| Name | Type | Required | Description |
|---|---|---|---|
boxId | integer | yes | One-based PC box number. |
boolean example: true
POST /lua/pc-storage/refreshpcbox
function onPathAction()
if not isPCOpen() then
usePC()
return
end
function onPathAction()
if not isPCOpen() then
usePC()
return
end
local result = refreshPCBox(1)
return
end
return
endSignatureresult = isOpponentShiny()
Returns true if the opponent pokémon is shiny.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
boolean example: true
POST /lua/battle-state/isopponentshiny
function onBattleAction()
function onBattleAction()
local result = isOpponentShiny()
log("isOpponentShiny: " .. tostring(result))
attack()
end
log("isOpponentShiny: " .. tostring(result))
attack()
endSignatureresult = isAlreadyCaught()
Returns true if the opponent pokémon has already been caught and has a pokédex entry.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
boolean example: true
POST /lua/battle-state/isalreadycaught
function onBattleAction()
function onBattleAction()
local result = isAlreadyCaught()
log("isAlreadyCaught: " .. tostring(result))
attack()
end
log("isAlreadyCaught: " .. tostring(result))
attack()
endSignatureresult = isWildBattle()
Returns true if the current battle is against a wild pokémon.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
boolean example: true
POST /lua/battle-state/iswildbattle
function onBattleAction()
function onBattleAction()
local result = isWildBattle()
log("isWildBattle: " .. tostring(result))
attack()
end
log("isWildBattle: " .. tostring(result))
attack()
endSignatureresult = getActivePokemonNumber()
Returns the index of the active team pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
integer example: 1
POST /lua/battle-state/getactivepokemonnumber
function onBattleAction()
function onBattleAction()
local result = getActivePokemonNumber()
log("getActivePokemonNumber: " .. tostring(result))
attack()
end
log("getActivePokemonNumber: " .. tostring(result))
attack()
endSignatureresult = getOpponentId()
Returns the id of the opponent pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
integer example: 1
POST /lua/battle-state/getopponentid
function onBattleAction()
function onBattleAction()
local result = getOpponentId()
log("getOpponentId: " .. tostring(result))
attack()
end
log("getOpponentId: " .. tostring(result))
attack()
endSignatureresult = getOpponentName()
Returns the name of the opponent pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
string example: "value"
POST /lua/battle-state/getopponentname
function onBattleAction()
function onBattleAction()
local result = getOpponentName()
log("getOpponentName: " .. tostring(result))
attack()
end
log("getOpponentName: " .. tostring(result))
attack()
endSignatureresult = getOpponentHealth()
Returns the current health of the opponent pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
integer example: 1
POST /lua/battle-state/getopponenthealth
function onBattleAction()
function onBattleAction()
local result = getOpponentHealth()
log("getOpponentHealth: " .. tostring(result))
attack()
end
log("getOpponentHealth: " .. tostring(result))
attack()
endSignatureresult = getOpponentMaxHealth()
Returns the maximum health of the opponent pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
integer example: 1
POST /lua/battle-state/getopponentmaxhealth
function onBattleAction()
function onBattleAction()
local result = getOpponentMaxHealth()
log("getOpponentMaxHealth: " .. tostring(result))
attack()
end
log("getOpponentMaxHealth: " .. tostring(result))
attack()
endSignatureresult = getOpponentHealthPercent()
Returns the percentage of remaining health of the opponent pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
integer example: 1
POST /lua/battle-state/getopponenthealthpercent
function onBattleAction()
function onBattleAction()
local result = getOpponentHealthPercent()
log("getOpponentHealthPercent: " .. tostring(result))
attack()
end
log("getOpponentHealthPercent: " .. tostring(result))
attack()
endSignatureresult = getOpponentLevel()
Returns the level of the opponent pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
integer example: 1
POST /lua/battle-state/getopponentlevel
function onBattleAction()
function onBattleAction()
local result = getOpponentLevel()
log("getOpponentLevel: " .. tostring(result))
attack()
end
log("getOpponentLevel: " .. tostring(result))
attack()
endSignatureresult = getOpponentStatus()
Returns the status of the opponent pokémon in the current battle.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
string example: "value"
POST /lua/battle-state/getopponentstatus
function onBattleAction()
function onBattleAction()
local result = getOpponentStatus()
log("getOpponentStatus: " .. tostring(result))
attack()
end
log("getOpponentStatus: " .. tostring(result))
attack()
endSignatureresult = getOpponentForm()
Returns the form of the opponent pokémon in the current battle (0 if no form).
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
integer example: 1
POST /lua/battle-state/getopponentform
function onBattleAction()
function onBattleAction()
local result = getOpponentForm()
log("getOpponentForm: " .. tostring(result))
attack()
end
log("getOpponentForm: " .. tostring(result))
attack()
endSignatureresult = getOpponentGender()
Returns the gender of the current opponent Pokémon. The result is "M" for male, "F" for female, or an empty string for genderless/unknown. This function is valid only during battle; calling it outside battle triggers the same fatal Lua error contract as the other getOpponent... helpers.
Use this during battle when behavior depends on gender-specific moves, abilities, or encounter rules.
string example: "M"
POST /lua/battle-state/getopponentgender
function onBattleAction()
local gender = getOpponentGender()
if gender == "M" then
log("Male opponent detected.")
elseif gender == "F" then
log("Female opponent detected.")
else
log("Genderless or unknown opponent.")
end
attack()
endSignatureresult = getBattleTurn()
Returns the latest battle turn number confirmed by the server through the BT:n battle marker. The value is monotonic for the current battle: duplicate or out-of-order lower markers do not move the turn backwards. 0 means the battle exists but no valid BT:n marker has been received yet. This function is valid only during battle; calling it outside battle follows the tool's fatal Lua error contract.
Use the server-backed turn number when a script needs different behavior on the first turn or after several turns. Unlike counting onBattleAction() calls, this remains aligned with server battle progression when a move continues automatically, a forced switch occurs, or one player command spans multiple server turns.
integer 0 before the first valid BT:n marker; otherwise the latest server-confirmed turn number.
POST /lua/battle-state/getbattleturn
function onBattleAction()
local turn = getBattleTurn()
if turn == 1 then
log("First server-confirmed battle turn.")
useMove("Thunder Wave")
return
end
log("Current battle turn: " .. tostring(turn))
attack()
endSignatureresult = isOpponentEffortValue(statType)
Returns true if the opponent is only giving the specified effort value.
Use a documented stat key to verify that the opponent gives only the EV you are training.
| Name | Type | Required | Description |
|---|---|---|---|
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
boolean example: true
POST /lua/battle-state/isopponenteffortvalue
function onBattleAction()
if isOpponentEffortValue("ATK") then
attack()
else
run()
end
endSignatureresult = getOpponentEffortValue(statType)
Returns the amount of a particular EV given by the opponent.
Read the exact EV yield of the current opponent for one stat.
| Name | Type | Required | Description |
|---|---|---|---|
statType | string | yes | Stat name: `HP`, `ATK`, `DEF`, `SPATK`, `SPDEF`, or `SPD` (speed). The long forms `HEALTH`, `ATTACK`, `DEFENCE`/`DEFENSE`, `SPATTACK`, `SPDEFENCE`/`SPDEFENSE` and `SPEED` also work; anything else stops the script. |
integer example: 1
POST /lua/battle-state/getopponenteffortvalue
function onBattleAction()
local attackYield = getOpponentEffortValue("ATK")
log("Opponent Attack EV yield: " .. tostring(attackYield))
attack()
endSignatureresult = getOpponentType()
Returns the type of the opponent pokémon in the current battle as an array of length 2.
Call this only from battle logic. It is a query and can be combined with one battle action in the same callback.
array<string> example: []
POST /lua/battle-state/getopponenttype
function onBattleAction()
function onBattleAction()
local result = getOpponentType()
log("getOpponentType: " .. tostring(result))
attack()
end
log("getOpponentType: " .. tostring(result))
attack()
endSignatureresult = moveToCell(x, y)
Moves to the specified coordinates.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
x | integer | yes | Map X coordinate. |
y | integer | yes | Map Y coordinate. |
boolean example: true
POST /lua/path-actions/movetocell
function onPathAction()
function onPathAction()
local result = moveToCell(10, 15)
return
end
return
endSignatureresult = moveToListCell(list, "")
Moves to the specified list coordinates.
Provide comma-separated `x-y` cell lists. The optional second list can represent cells to avoid or an alternate set used by the path helper.
| Name | Type | Required | Description |
|---|---|---|---|
list | string | yes | Value passed to the `list` parameter. |
"" | string | yes | Value passed to the `""` parameter. |
boolean example: true
POST /lua/path-actions/movetolistcell
function onPathAction()
local preferred = "10-15,11-15,12-15"
local alternate = "10-16,11-16,12-16"
moveToListCell(preferred, alternate)
return
endSignatureresult = moveToMap(mapName)
Moves to the nearest cell teleporting to the specified map.
This legacy function is retired. Walk to the destination map link with `moveToCell()` instead.
| Name | Type | Required | Description |
|---|---|---|---|
mapName | string | yes | Value passed to the `mapName` parameter. |
boolean example: true
POST /lua/path-actions/movetomap
function onPathAction()
-- moveToMap("Viridian City") is retired.
-- Walk onto the known map-link cell instead.
moveToCell(25, 42)
return
endSignatureresult = moveToRectangle(...)
Moves to a random accessible cell of the specified rectangle.
Pass four coordinates: minimum X/Y followed by maximum X/Y. The tool chooses a random accessible cell inside the rectangle.
| Name | Type | Required | Description |
|---|---|---|---|
arg1 | array<LuaValue> | yes | Value passed to the `arg1` parameter. |
boolean example: true
POST /lua/path-actions/movetorectangle
function onPathAction()
moveToRectangle(10, 15, 14, 19)
return
endSignatureresult = moveToNormalGround()
Move randomly avoiding water and links.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/movetonormalground
function onPathAction()
function onPathAction()
local result = moveToNormalGround()
return
end
return
endSignatureresult = moveToGrass()
Moves to the nearest grass patch then move randomly inside it.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/movetograss
function onPathAction()
function onPathAction()
local result = moveToGrass()
return
end
return
endSignatureresult = moveToWater()
Moves to the nearest water area then move randomly inside it.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/movetowater
function onPathAction()
function onPathAction()
local result = moveToWater()
return
end
return
endSignatureresult = moveNearExit(mapName)
Moves near the cell teleporting to the specified map.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
mapName | string | yes | Value passed to the `mapName` parameter. |
boolean example: true
POST /lua/path-actions/movenearexit
function onPathAction()
function onPathAction()
local result = moveNearExit("Viridian City")
return
end
return
endSignatureresult = talkToNpc(npcName)
Moves then talk to NPC specified by its name.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
npcName | string | yes | Exact or documented NPC name. |
boolean example: true
POST /lua/path-actions/talktonpc
function onPathAction()
function onPathAction()
local result = talkToNpc("Nurse Joy")
return
end
return
endSignatureresult = talkToNpcOnCell(cellX, cellY)
Moves then talk to NPC located on the specified cell.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
cellX | integer | yes | Value passed to the `cellX` parameter. |
cellY | integer | yes | Value passed to the `cellY` parameter. |
boolean example: true
POST /lua/path-actions/talktonpconcell
function onPathAction()
function onPathAction()
local result = talkToNpcOnCell(10, 15)
return
end
return
endSignatureresult = usePokecenter()
Moves to the Nurse Joy then talk to the cell below her.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/usepokecenter
function onPathAction()
function onPathAction()
local result = usePokecenter()
return
end
return
endSignatureresult = swapPokemon(index1, index2)
Swaps the two pokémon specified by their position in the team.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
index1 | integer | yes | Value passed to the `index1` parameter. |
index2 | integer | yes | Value passed to the `index2` parameter. |
boolean example: true
POST /lua/path-actions/swappokemon
function onPathAction()
function onPathAction()
local result = swapPokemon(1, 1)
return
end
return
endSignatureresult = swapPokemonWithLeader(pokemonName)
Swaps the first pokémon with the specified name with the leader of the team.
Move the named Pokémon to the lead slot before continuing the route.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonName | string | yes | Value passed to the `pokemonName` parameter. |
boolean example: true
POST /lua/path-actions/swappokemonwithleader
function onPathAction()
if getPokemonName(1) ~= "Pikachu" then
swapPokemonWithLeader("Pikachu")
return
end
moveToGrass()
endSignatureresult = sortTeamByLevelAscending()
Sorts the pokémon in the team by level in ascending order, one pokémon at a time.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/sortteambylevelascending
function onPathAction()
function onPathAction()
local result = sortTeamByLevelAscending()
return
end
return
endSignatureresult = sortTeamByLevelDescending()
Sorts the pokémon in the team by level in descending order, one pokémon at a time.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/sortteambyleveldescending
function onPathAction()
function onPathAction()
local result = sortTeamByLevelDescending()
return
end
return
endSignatureresult = sortTeamRangeByLevelAscending(fromIndex, toIndex)
Sorts the specified part of the team by level in ascending order, one pokémon at a time.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
fromIndex | integer | yes | Value passed to the `fromIndex` parameter. |
toIndex | integer | yes | Value passed to the `toIndex` parameter. |
boolean example: true
POST /lua/path-actions/sortteamrangebylevelascending
function onPathAction()
function onPathAction()
local result = sortTeamRangeByLevelAscending(10, 10)
return
end
return
endSignatureresult = sortTeamRangeByLevelDescending(fromIndex, toIndex)
Sorts the specified part of the team by level in descending order, one pokémon at a time.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
fromIndex | integer | yes | Value passed to the `fromIndex` parameter. |
toIndex | integer | yes | Value passed to the `toIndex` parameter. |
boolean example: true
POST /lua/path-actions/sortteamrangebyleveldescending
function onPathAction()
function onPathAction()
local result = sortTeamRangeByLevelDescending(10, 10)
return
end
return
endSignatureresult = relearnMove(moveName)
Relearn a move from the move relearner NPC.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
moveName | string | yes | Exact move name as shown by the game. |
boolean example: true
POST /lua/path-actions/relearnmove
function onPathAction()
function onPathAction()
local result = relearnMove("Tackle")
return
end
return
endSignatureresult = releasePokemonFromTeam(pokemonUid)
Releases the specified pokemon in the team.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
pokemonUid | integer | yes | Stable Pokémon database/unique identifier returned by the corresponding query API. |
boolean example: true
POST /lua/path-actions/releasepokemonfromteam
function onPathAction()
function onPathAction()
local result = releasePokemonFromTeam(1)
return
end
return
endSignatureresult = enablePrivateMessage()
Enable private messages from users.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/enableprivatemessage
function onPathAction()
function onPathAction()
local result = enablePrivateMessage()
return
end
return
endSignatureresult = disablePrivateMessage()
Disable private messages from users.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/disableprivatemessage
function onPathAction()
function onPathAction()
local result = disablePrivateMessage()
return
end
return
endSignatureresult = enablePartyInspection()
Enable party inspection from users.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/enablepartyinspection
function onPathAction()
function onPathAction()
local result = enablePartyInspection()
return
end
return
endSignatureresult = disablePartyInspection()
Disable party inspection from users.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/disablepartyinspection
function onPathAction()
function onPathAction()
local result = disablePartyInspection()
return
end
return
endSignatureresult = enableAutoEvolve()
Enable auto evolve on Pkm Catchem client.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/enableautoevolve
function onPathAction()
function onPathAction()
local result = enableAutoEvolve()
return
end
return
endSignatureresult = disableAutoEvolve()
Disable auto evolve on Pkm Catchem client.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/disableautoevolve
function onPathAction()
function onPathAction()
local result = disableAutoEvolve()
return
end
return
endSignatureresult = enableNpcInteractions()
Enables npc interactions.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/enablenpcinteractions
function onPathAction()
function onPathAction()
local result = enableNpcInteractions()
return
end
return
endSignatureresult = disableNpcInteractions()
Disables npc interactions.
Use this in `onPathAction()` and return immediately so only one overworld action is issued in the frame.
boolean example: true
POST /lua/path-actions/disablenpcinteractions
function onPathAction()
function onPathAction()
local result = disableNpcInteractions()
return
end
return
endSignaturepushDialogAnswer(answerValue)
Adds the specified answer to the answer queue. It will be used in the next dialog.
Queue the expected answer before interacting with the NPC that will open the dialog.
| Name | Type | Required | Description |
|---|---|---|---|
answerValue | LuaValue | yes | Any Lua value. |
void
POST /lua/dialog-functions/pushdialoganswer
function onPathAction()
pushDialogAnswer("Yes")
talkToNpc("Nurse Joy")
endSignatureresult = attack()
Uses the most effective offensive move available.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
boolean example: true
POST /lua/battle-actions/attack
function onBattleAction()
function onBattleAction()
local result = attack()
return
end
return
endSignatureresult = weakAttack()
Uses the least effective offensive move available.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
boolean example: true
POST /lua/battle-actions/weakattack
function onBattleAction()
function onBattleAction()
local result = weakAttack()
return
end
return
endSignatureresult = run()
Tries to escape from the current wild battle.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
boolean example: true
POST /lua/battle-actions/run
function onBattleAction()
function onBattleAction()
local result = run()
return
end
return
endSignatureresult = sendUsablePokemon()
Sends the first usable pokemon different from the active one.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
boolean example: true
POST /lua/battle-actions/sendusablepokemon
function onBattleAction()
function onBattleAction()
local result = sendUsablePokemon()
return
end
return
endSignatureresult = sendAnyPokemon()
Sends the first available pokemon different from the active one.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
boolean example: true
POST /lua/battle-actions/sendanypokemon
function onBattleAction()
function onBattleAction()
local result = sendAnyPokemon()
return
end
return
endSignatureresult = sendPokemon(index)
Sends the specified pokemon to battle.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
boolean example: true
POST /lua/battle-actions/sendpokemon
function onBattleAction()
function onBattleAction()
local result = sendPokemon(1)
return
end
return
endSignatureresult = useMove(moveName)
Uses the specified move in the current battle if available.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
| Name | Type | Required | Description |
|---|---|---|---|
moveName | string | yes | Exact move name as shown by the game. |
boolean example: true
POST /lua/battle-actions/usemove
function onBattleAction()
function onBattleAction()
local result = useMove("Tackle")
return
end
return
endSignatureresult = useAnyMove()
Uses the first available move or struggle if out of PP.
Choose this action in `onBattleAction()` and return immediately so only one battle action is sent in the frame.
boolean example: true
POST /lua/battle-actions/useanymove
function onBattleAction()
function onBattleAction()
local result = useAnyMove()
return
end
return
endSignatureresult = setAfk(value)
Sets afk timeout for BOT
Set this during startup or when changing modes, rather than writing it every frame.
| Name | Type | Required | Description |
|---|---|---|---|
value | integer | yes | Value to store or send. |
boolean example: true
POST /lua/bot-configuration/setafk
function onStart()
function onStart()
local result = setAfk(1)
end
endSignatureresult = setAfkTimeout(value)
Sets afk timeout for BOT
Set this during startup or when changing modes, rather than writing it every frame.
| Name | Type | Required | Description |
|---|---|---|---|
value | integer | yes | Value to store or send. |
boolean example: true
POST /lua/bot-configuration/setafktimeout
function onStart()
function onStart()
local result = setAfkTimeout(1)
end
endSignatureresult = forgetMove(moveName)
Forgets the specified move, if existing, in order to learn a new one.
Call this from `onLearningMove()` and choose exactly one move-learning action.
| Name | Type | Required | Description |
|---|---|---|---|
moveName | string | yes | Exact move name as shown by the game. |
boolean example: true
POST /lua/move-learning-actions/forgetmove
function onLearningMove(moveName, pokemonIndex)
function onLearningMove(moveName, pokemonIndex)
local result = forgetMove("Tackle")
end
endSignatureresult = forgetAnyMoveExcept(...)
Forgets the first move that is not one of the specified moves.
Pass move names that must be preserved. The tool forgets the first current move not in that list.
| Name | Type | Required | Description |
|---|---|---|---|
moveNames | array<LuaValue> | yes | Value passed to the `moveNames` parameter. |
boolean example: true
POST /lua/move-learning-actions/forgetanymoveexcept
function onLearningMove(moveName, pokemonIndex)
forgetAnyMoveExcept("Thunderbolt", "Volt Tackle")
endSignaturesetOption(index, value)
Sets the option at a particular index, or creates it if it doesn't exist
Define or update script options during startup so the user can configure behavior from the UI.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
value | boolean | yes | Value to store or send. |
void
POST /lua/custom-options/setoption
function onStart()
function onStart()
setOption(1, true)
end
endSignatureresult = getOption(index)
Gets the option at a particular index, or creates it if it doesn't exist
Read the user-selected option when deciding what action the script should take.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
boolean example: true
POST /lua/custom-options/getoption
function onPathAction()
function onPathAction()
local result = getOption(1)
log("getOption: " .. tostring(result))
end
log("getOption: " .. tostring(result))
endSignaturesetOptionName(index, content)
Sets the name of the option at a particular index, or creates it if it doesn't exist
Give a boolean option a user-facing label during script startup.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
content | string | yes | Value passed to the `content` parameter. |
void
POST /lua/custom-options/setoptionname
function onStart()
setOption(1, true)
setOptionName(1, "Catch uncaught Pokémon")
endSignaturesetOptionDescription(index, content)
Sets the tooltip description of the option at a particular index, or creates it if it doesn't exist
Explain exactly what a boolean option changes so the user can configure the script safely.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
content | string | yes | Value passed to the `content` parameter. |
void
POST /lua/custom-options/setoptiondescription
function onStart()
setOptionDescription(1, "When enabled, the script weakens and catches species not yet owned.")
endSignatureremoveOption(index)
Removes the slider option at the specified index
Define or update script options during startup so the user can configure behavior from the UI.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
void
POST /lua/custom-options/removeoption
function onStart()
function onStart()
removeOption(1)
end
endSignaturesetTextOption(index, content)
Sets the text of the TextOption at a particular index, or creates it if it doesn't exist
Create a text option with a meaningful default value.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
content | string | yes | Value passed to the `content` parameter. |
void
POST /lua/custom-options/settextoption
function onStart()
setTextOption(1, "Pikachu")
setTextOptionName(1, "Target Pokémon")
endSignatureresult = getTextOption(index)
Returns the text content of the TextOption at a particular index, or an empty string if it doesn't exist
Read the user-selected option when deciding what action the script should take.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
string example: "value"
POST /lua/custom-options/gettextoption
function onPathAction()
function onPathAction()
local result = getTextOption(1)
log("getTextOption: " .. tostring(result))
end
log("getTextOption: " .. tostring(result))
endSignaturesetTextOptionName(index, content)
Sets the name of the TextOption at a particular index, or creates it if it doesn't exist
Give a text option a concise user-facing label.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
content | string | yes | Value passed to the `content` parameter. |
void
POST /lua/custom-options/settextoptionname
function onStart()
setTextOptionName(1, "Target Pokémon")
endSignaturesetTextOptionDescription(index, content)
Sets the tooltip description of the TextOption at a particular index, or creates it if it doesn't exist
Describe the accepted text format and provide an example.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
content | string | yes | Value passed to the `content` parameter. |
void
POST /lua/custom-options/settextoptiondescription
function onStart()
setTextOptionDescription(1, "Exact species name, for example Pikachu or Eevee.")
endSignatureremoveTextOption(index)
Removes the text option at the specified index
Define or update script options during startup so the user can configure behavior from the UI.
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | yes | One-based index in the current team or option list, depending on the API. |
void
POST /lua/custom-options/removetextoption
function onStart()
function onStart()
removeTextOption(1)
end
endSignaturewriteToFile(filename, text, false)
Writes a string to file overwrite is an optional parameter, and will append the line(s) if absent
Persist a small state snapshot. Set the third argument to `true` to overwrite or `false` to append.
| Name | Type | Required | Description |
|---|---|---|---|
filename | string | yes | Value passed to the `filename` parameter. |
text | string | yes | Value passed to the `text` parameter. |
false | boolean | yes | Value passed to the `false` parameter. |
void
POST /lua/file-apis/writetofile
function onStop()
writeToFile("state/last-map.txt", getMapName(), true)
endSignaturelogToFile(file, text, false)
Writes a string, a number, or a table of strings and/or numbers to file overwrite is an optional parameter, and will append the line(s) if absent
Append structured diagnostic values without relying only on the visible message log.
| Name | Type | Required | Description |
|---|---|---|---|
file | string | yes | Path relative to the script/tool data directory. |
text | LuaValue | yes | Any Lua value. |
false | boolean | yes | Value passed to the `false` parameter. |
void
POST /lua/file-apis/logtofile
function onWarningMessage(differentMap, distance)
logToFile("logs/warnings.txt", {
map = getMapName(),
differentMap = differentMap,
distance = distance
}, false)
endSignatureresult = readLinesFromFile(file)
Returns a table of every line in file
Use script-local files for small persistent state or diagnostics. Handle missing/empty data before indexing returned lines.
| Name | Type | Required | Description |
|---|---|---|---|
file | string | yes | Path relative to the script/tool data directory. |
array<string> example: []
POST /lua/file-apis/readlinesfromfile
function onStart()
function onStart()
local result = readLinesFromFile("logs/script.txt")
if result ~= nil then
log("File API completed.")
end
end
if result ~= nil then
log("File API completed.")
end
endSignatureresult = tradeGiveMoney(username, money)
Used to trade money With Parameters Username and Money
Use only inside the intended trade flow and validate the recipient and amount.
| Name | Type | Required | Description |
|---|---|---|---|
username | string | yes | Value passed to the `username` parameter. |
money | integer | yes | Value passed to the `money` parameter. |
boolean example: true
POST /lua/file-apis/tradegivemoney
function prepareTrade()
local ok = tradeGiveMoney("TrustedPlayer", 15000)
log("Money offer prepared: " .. tostring(ok))
endSignatureresult = tradeAcceptMoney()
Lua function tradeAcceptMoney.
Use script-local files for small persistent state or diagnostics. Handle missing/empty data before indexing returned lines.
boolean example: true
POST /lua/file-apis/tradeacceptmoney
function onStart()
function onStart()
local result = tradeAcceptMoney()
if result ~= nil then
log("File API completed.")
end
end
if result ~= nil then
log("File API completed.")
end
endSignatureresult = closeChannel(name)
Close channel chat by name
Close a channel by its visible name when the script no longer needs it.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | Name of the option, hook, variable, or resource. |
boolean example: true
POST /lua/chat/closechannel
function onStart()
local closed = closeChannel("Trade")
log("Trade channel closed: " .. tostring(closed))
endSignatureresult = sendNotification(templateName)
Send a configured notification template by name or id. Built-in variables such as {player}, {map}, {x}, {y}, {account}, {server}, {bot}, {time}, {date}, and {datetime} are filled automatically when available. The template's configured target controls whether it goes to personal Discord, the built-in PROCatchem Discord channel, Telegram, or all enabled channels. Returns false only when notifications are disabled or the template cannot be found; network delivery is asynchronous.
Send notifications only for meaningful events to avoid duplicate alerts from callbacks that run repeatedly.
| Name | Type | Required | Description |
|---|---|---|---|
templateName | string | yes | Template display name or stable template id. |
boolean example: true
POST /lua/notifications/sendnotification
function onSystemMessage(message)
if stringContains(message, "Caught") then
function onSystemMessage(message)
if stringContains(message, "Caught") then
local ok = sendNotification("Shiny found")
end
end
end
endSignatureresult = sendNotificationWith(templateName, values)
Send a configured notification template and override/add template variables using a Lua table. Table keys should match template variables without braces. Per-call values override built-ins, runtime variables set by setNotifyVar, global variables, and template defaults.
Send notifications only for meaningful events to avoid duplicate alerts from callbacks that run repeatedly.
| Name | Type | Required | Description |
|---|---|---|---|
templateName | string | yes | Template display name or stable template id. |
values | NotificationVariables | yes | Lua table containing template variables. |
boolean example: true
POST /lua/notifications/sendnotificationwith
function onSystemMessage(message)
if stringContains(message, "Caught") then
function onSystemMessage(message)
if stringContains(message, "Caught") then
local ok = sendNotificationWith("Shiny found", { pokemon = "Gyarados", level = "30" })
end
end
end
endSignatureresult = sendNotificationTo(templateName, target)
Send a configured notification template while overriding its delivery target for this one call. Accepted targets are personal, discord, procatchem, telegram, and all. all falls back to the template's configured target, which defaults to all enabled channels.
Send notifications only for meaningful events to avoid duplicate alerts from callbacks that run repeatedly.
| Name | Type | Required | Description |
|---|---|---|---|
templateName | string | yes | Template display name or stable template id. |
target | NotificationTarget | yes | Notification delivery target. |
boolean example: true
POST /lua/notifications/sendnotificationto
function onSystemMessage(message)
if stringContains(message, "Caught") then
function onSystemMessage(message)
if stringContains(message, "Caught") then
local ok = sendNotificationTo("Bot stopped", "personal")
end
end
end
endSignatureresult = sendNotificationWithTo(templateName, values, target)
Send a configured notification template, pass template variables, and override the delivery target for this one call. This is the most explicit notification helper for scripts that need to route different alerts to different channels.
Send notifications only for meaningful events to avoid duplicate alerts from callbacks that run repeatedly.
| Name | Type | Required | Description |
|---|---|---|---|
templateName | string | yes | Template display name or stable template id. |
values | NotificationVariables | yes | Lua table containing template variables. |
target | NotificationTarget | yes | Notification delivery target. |
boolean example: true
POST /lua/notifications/sendnotificationwithto
function onSystemMessage(message)
if stringContains(message, "Caught") then
function onSystemMessage(message)
if stringContains(message, "Caught") then
local ok = sendNotificationWithTo("Shiny found", { pokemon = "Gyarados", level = "30" }, "procatchem")
end
end
end
endSignatureresult = notify(message)
Send a quick plain-text notification without using a configured template. Use this for simple alerts where you do not need title/body formatting or template variables. Returns immediately after queueing the asynchronous send.
Send notifications only for meaningful events to avoid duplicate alerts from callbacks that run repeatedly.
| Name | Type | Required | Description |
|---|---|---|---|
message | string | yes | Plain text message to send. |
boolean example: true
POST /lua/notifications/notify
function onSystemMessage(message)
if stringContains(message, "Caught") then
function onSystemMessage(message)
if stringContains(message, "Caught") then
local ok = notify("PROCatchem: script reached Cerulean City.")
end
end
end
endSignaturesetNotifyVar(name, value)
Set a runtime notification variable. The variable can be used in any template as {name} until it is overwritten or cleared with clearNotifyVars(). Values are converted to strings.
Send notifications only for meaningful events to avoid duplicate alerts from callbacks that run repeatedly.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | Variable name without braces. |
value | LuaValue | yes | Value to store or send. |
void
POST /lua/notifications/setnotifyvar
function onSystemMessage(message)
if stringContains(message, "Caught") then
function onSystemMessage(message)
if stringContains(message, "Caught") then
setNotifyVar("hunt", "Shiny Magikarp")
end
end
end
endSignatureclearNotifyVars()
Clear all runtime notification variables previously set with setNotifyVar. Built-in variables and configured template/default variables are not removed.
Send notifications only for meaningful events to avoid duplicate alerts from callbacks that run repeatedly.
void
POST /lua/notifications/clearnotifyvars
function onSystemMessage(message)
if stringContains(message, "Caught") then
function onSystemMessage(message)
if stringContains(message, "Caught") then
clearNotifyVars()
end
end
end
endSignatureresult = useSurf()
Start surfing from the current position. If setWaterMount() configured a water mount, the tool uses that mount item; otherwise it sends the normal /surf action. Pathfinding also calls this automatically when a route transitions from ground to water.
Call this at the shoreline when a scripted route needs to enter water. Pathfinding may also trigger it automatically.
boolean example: true
POST /lua/legacy-special-actions/usesurf
function onPathAction()
if not isSurfing() then
useSurf()
return
end
moveToWater()
end