client
198 Lua bindings.
Index
acceptFriendacceptQuestactiveWorldsaddClientaddFriendALREADY_CONNECTEDamountanchoranchorXanchorYarmFishingAUTH_FAILEDAUTHENTICATINGautomationAWAITING_READYbaitbaitNameBANNEDblockIdblockTypebuybytecoinsCANCELLEDcanExpandInventoryCHARACTER_CREATIONclaimAchievementclaimDailyGiftclaimed_levelclaimQuestclaimXpLevelclassclearPathcollectcollectGiftCOMPLETEDcompleted_levelconnectconnectedCONNECTINGconsolecountcreatedAtcurrentcurrent_stepdescriptiondirectiondiscardQuestdisconnectDISCONNECTEDdropdumpWorldTilesemailenterenterPortalenterTutorialERRORErrorsexpandInventoryfinal_targetfindPathfindWorldItemsfishingConfigfishingStatusgemsgetAchievementgetAchievementsgetBankgetClientgetClientsgetPathgetQuestsgetScriptinggrowingTileAtgrowthDurationSecsgrowthEndTimeharvestBlocksharvestExtraBlocksharvestGemsharvestSeedshasItemhasPathBetweenhithitEnemyidIN_WORLDINVALID_WORLDinventoryisAliveisFishingisGravityEnabledisInTutorialisOpenisTutorialDoneisWalkableJOINING_WORLDKICKEDlastErrorleavelevelLOADING_WORLDloggermax_levelMENU_READYminesmixedmovePointmovePositionnamenavigationnethernextSlotCountnextSlotPriceNOT_CONNECTEDNOT_IN_WORLDNOT_STARTEDonopenGiftBoxOTHERownEntrypathfindingPHASE_1PHASE_2PHASE_3PHASE_4pingplaceplanPathplantpointportalspositionquest_typerecentWorldsRECONNECTINGREDIRECTINGrefreshrefreshFloatingChestremoveClientrequirementsresolvePackRewardsrespawnrewardreward_extrareward_gemsreward_xprewardsrodsayscriptingsendsendBatchsendRawsetAutoCollectsetFaceAnimationsetGravitysetIsOnlinesetIsVisiblesetPointsetPositionsetStatussetSubserversetZoomLevelsetZoomValueslotstatusStatusstep_progressstopFishingtargetEntrytargetWorldTIMEOUTtitletrashtutorialTUTORIAL_BUSYTUTORIAL_WORLDtutorialRunningtutorialStagetutorialStateTutorialStatetutorialStateLabelunwearuptimeuseuseridusernamewarpwarpRandomwearwearingworldWORLD_FULLWORLD_NOT_FOUNDworldInfoworldItemsxxpy
acceptFriend
client:acceptFriend(userId) — accept an inbound friend
request. userId is the REQUESTER's id (the one who
originally sent Af). Server replies
ConfirmFriendRequest {FCR=4}.
acceptQuest
(no description yet)
activeWorlds
(no description yet)
addClient
(no description yet)
addFriend
client:addFriend(userId) — send a friend request to the
player whose user-id is given. Server replies with
Af {FRR} (FRR=2 typically = sent).
ALREADY_CONNECTED
(no description yet)
amount
(no description yet)
anchor
(no description yet)
anchorX
(no description yet)
anchorY
(no description yet)
armFishing
(no description yet)
AUTH_FAILED
(no description yet)
AUTHENTICATING
(no description yet)
automation
(no description yet)
AWAITING_READY
(no description yet)
bait
(no description yet)
baitName
(no description yet)
BANNED
(no description yet)
blockId
(no description yet)
blockType
(no description yet)
buy
(no description yet)
bytecoins
(no description yet)
CANCELLED
(no description yet)
canExpandInventory
(no description yet)
CHARACTER_CREATION
(no description yet)
claimAchievement
(no description yet)
claimDailyGift
(no description yet)
claimed_level
(no description yet)
claimQuest
(no description yet)
claimXpLevel
client:claimXpLevel() — claim a pending level-up reward.
Fire when pD reports the bot has crossed a level gate
without auto-claiming. Idempotent — server no-ops if no
reward is pending.
class
(no description yet)
clearPath
(no description yet)
collect
(no description yet)
collectGift
(no description yet)
COMPLETED
(no description yet)
completed_level
(no description yet)
connect
(no description yet)
connected
(no description yet)
CONNECTING
(no description yet)
console
(no description yet)
count
(no description yet)
createdAt
(no description yet)
current
(no description yet)
current_step
(no description yet)
description
(no description yet)
direction
(no description yet)
discardQuest
(no description yet)
disconnect
(no description yet)
DISCONNECTED
(no description yet)
drop
(no description yet)
dumpWorldTiles
(no description yet)
email
(no description yet)
enter
(no description yet)
enterPortal
(no description yet)
enterTutorial
(no description yet)
ERROR
(no description yet)
Errors
(no description yet)
expandInventory
(no description yet)
final_target
(no description yet)
findPath
(no description yet)
findWorldItems
(no description yet)
fishingConfig
(no description yet)
fishingStatus
(no description yet)
gems
(no description yet)
getAchievement
(no description yet)
getAchievements
(no description yet)
getBank
client:getBank(point) — request bank slot listing for the
tile at (point.x, point.y). Server replies GBank with
the slot table; subscribe via client:on("p:GBank", …)
to read the response.
getClient
(no description yet)
getClients
(no description yet)
getPath
(no description yet)
getQuests
(no description yet)
getScripting
(no description yet)
growingTileAt
(no description yet)
growthDurationSecs
(no description yet)
growthEndTime
(no description yet)
harvestBlocks
(no description yet)
harvestExtraBlocks
(no description yet)
harvestGems
(no description yet)
harvestSeeds
(no description yet)
hasItem
(no description yet)
hasPathBetween
(no description yet)
hit
(no description yet)
hitEnemy
(no description yet)
id
(no description yet)
IN_WORLD
(no description yet)
INVALID_WORLD
(no description yet)
inventory
(no description yet)
isAlive
(no description yet)
isFishing
(no description yet)
isGravityEnabled
(no description yet)
isInTutorial
(no description yet)
isOpen
(no description yet)
isTutorialDone
(no description yet)
isWalkable
(no description yet)
JOINING_WORLD
(no description yet)
KICKED
(no description yet)
lastError
(no description yet)
leave
(no description yet)
level
(no description yet)
LOADING_WORLD
(no description yet)
logger
(no description yet)
max_level
(no description yet)
MENU_READY
(no description yet)
mines
(no description yet)
mixed
(no description yet)
movePoint
(no description yet)
movePosition
(no description yet)
name
(no description yet)
navigation
(no description yet)
nether
(no description yet)
nextSlotCount
(no description yet)
nextSlotPrice
(no description yet)
NOT_CONNECTED
(no description yet)
NOT_IN_WORLD
(no description yet)
NOT_STARTED
(no description yet)
on
(no description yet)
openGiftBox
client:openGiftBox(point) — claim a world-placed gift
box at (point.x, point.y). Used for player-dropped
presents and floating-gift tiles.
OTHER
(no description yet)
ownEntry
(no description yet)
pathfinding
(no description yet)
PHASE_1
(no description yet)
PHASE_2
(no description yet)
PHASE_3
(no description yet)
PHASE_4
(no description yet)
ping
(no description yet)
place
(no description yet)
planPath
(no description yet)
plant
(no description yet)
point
(no description yet)
portals
(no description yet)
position
(no description yet)
quest_type
(no description yet)
recentWorlds
(no description yet)
RECONNECTING
(no description yet)
REDIRECTING
(no description yet)
refresh
(no description yet)
refreshFloatingChest
client:refreshFloatingChest() — pull the latest floating-
chest UI state (gem chest, achievement chest). Server
replies with UFIPAT carrying chest contents + cooldowns.
removeClient
(no description yet)
requirements
(no description yet)
resolvePackRewards
(no description yet)
respawn
(no description yet)
reward
(no description yet)
reward_extra
(no description yet)
reward_gems
(no description yet)
reward_xp
(no description yet)
rewards
(no description yet)
rod
(no description yet)
say
(no description yet)
scripting
(no description yet)
send
(no description yet)
sendBatch
(no description yet)
sendRaw
(no description yet)
setAutoCollect
(no description yet)
setFaceAnimation
(no description yet)
setGravity
(no description yet)
setIsOnline
(no description yet)
setIsVisible
(no description yet)
setPoint
(no description yet)
setPosition
(no description yet)
setStatus
(no description yet)
setSubserver
(no description yet)
setZoomLevel
(no description yet)
setZoomValue
(no description yet)
slot
(no description yet)
status
(no description yet)
Status
(no description yet)
step_progress
(no description yet)
stopFishing
(no description yet)
targetEntry
(no description yet)
targetWorld
(no description yet)
TIMEOUT
(no description yet)
title
(no description yet)
trash
(no description yet)
tutorial
(no description yet)
TUTORIAL_BUSY
(no description yet)
TUTORIAL_WORLD
(no description yet)
tutorialRunning
(no description yet)
tutorialStage
(no description yet)
tutorialState
(no description yet)
TutorialState
(no description yet)
tutorialStateLabel
(no description yet)
unwear
(no description yet)
uptime
(no description yet)
use
(no description yet)
userid
(no description yet)
username
(no description yet)
warp
(no description yet)
warpRandom
(no description yet)
wear
(no description yet)
wearing
(no description yet)
world
(no description yet)
WORLD_FULL
(no description yet)
WORLD_NOT_FOUND
(no description yet)
worldInfo
(no description yet)
worldItems
(no description yet)
x
(no description yet)
xp
(no description yet)
y
(no description yet)