GTPS Cloud Callback Templates

onPlayerCommandCallback(function(world, player, fullCommand)
    -- world = World Object
    -- player = Player Object
    -- fullCommand = command player trigger
    -- return false to disable command on situation
    -- code here
end)

onPlayerDialogCallback(function(world, player, data)
    -- world = World Object
    -- player = Player Object
    -- data = table
    -- data["dialog_name"]: string, dialog name
    -- data["buttonClicked"]: string, button clicked
    -- return true to prevent default behavior, false to allow
    -- code here
end)

onPlayerConsumableCallback(function(world, player, tile, clickedPlayer, itemID)
    -- world = World Object
    -- player = Player Object
    -- tile = Tile Object
    -- clickedPlayer = Player Object (may be nil)
    -- itemID = number (link to Item Object)
    -- return true to prevent default use, false to allow
    -- code here
end)

onTileWrenchCallback(function(world, player, tile)
    -- world = World Object
    -- player = Player Object
    -- tile = Tile Object
    -- return true to prevent default wrench behavior, false to allow
    -- code here
end)

onPlayerPunchPlayerCallback(function(player,world,target_player)
    -- world = World Object
    -- player = Player Object 
    -- target_player = Player Object
end)

onPlayerPunchNPCCallback(function(player,world,target_npc)
    -- world = World Object
    -- player = Player Object 
    -- target_npc = Player Object
end)

onPlayerLoginCallback(function(player)
    -- player = Player Object
    -- code here
end)

onTilePlaceCallback(function(world, player, tile, placingID)
    -- world = World Object
    -- player = Player Object
    -- tile = Tile Object
    -- placingID = number
    -- return true to prevent placement, false to allow
    -- code here
end)

onPlayerTick(function(player)
    -- player = Player Object
    -- called every 1000ms per player
    -- code here
end)

onWorldTick(function(world)
    -- world = World Object
    -- called every 100ms per world
    -- code here
end)

onPlayerFirstTimeLoginCallback(function(player)
    -- player = Player Object
    -- called only on first login
    -- code here
end)

onPlayerEnterWorldCallback(function(world, player)
    -- world = World Object
    -- player = Player Object
    -- code here
end)

onPlayerLeaveWorldCallback(function(world, player)
    -- world = World Object
    -- player = Player Object
    -- code here
end)

onTilePunchCallback(function(world, avatar, tile)
    -- world = World Object
    -- avatar = Player Object
    -- tile = Tile Object
    -- return true to prevent breaking, false to allow default
    -- code here
end)

onPlayerDisconnectCallback(function(player)
    -- player = Player Object
    -- code here
end)

onPlayerDeathCallback(function(world, player, isRespawn)
    -- world = World Object
    -- player = Player Object
    -- isRespawn = boolean
    -- code here
end)

onPlayerDropCallback(function(world, player, itemID, itemCount)
    -- world = World Object
    -- player = Player Object
    -- itemID = number (link to Item Object)
    -- itemCount = number
    -- return true to prevent drop, false to allow
    -- code here
end)

onPlayerPickupItemCallback(function(world, player, itemID, itemCount)
    -- world = World Object
    -- player = Player Object
    -- itemID = number
    -- itemCount = number
    -- return true to prevent pickup, false to allow
    -- code here
end)

onPlayerEquipClothingCallback(function(world, player, itemID)
    -- world = World Object
    -- player = Player Object
    -- itemID = number
    -- return true to prevent equip, false to allow
    -- code here
end)

onPlayerUnequipClothingCallback(function(world, player, itemID)
    -- world = World Object
    -- player = Player Object
    -- itemID = number
    -- return true to prevent unequip, false to allow
    -- code here
end)

onPlayerEnterDoorCallback(function(world, player, targetWorldName, doorID)
    -- world = World Object
    -- player = Player Object
    -- targetWorldName = string
    -- doorID = number
    -- return true to prevent enter, false to allow
    -- code here
end)

onPlayerPlantCallback(function(world, player, tile)
    -- world = World Object
    -- player = Player Object
    -- tile = Tile Object
    -- code here
end)

onPlayerHarvestCallback(function(world, player, tile)
    -- world = World Object
    -- player = Player Object
    -- tile = Tile Object
    -- code here
end)

onPlayerCatchFishCallback(function(world, player, itemID, itemCount)
    -- world = World Object
    -- player = Player Object
    -- itemID = number
    -- itemCount = number
    -- code here
end)

onPlayerCrimeCallback(function(world, player, itemID, itemCount)
    -- code here
end)

onPlayerSurgeryCallback(function(world, player, reward_id, reward_count, target_player)
    -- world = World Object
    -- player = Player Object (the surgeon)
    -- reward_id = number (item ID of reward)
    -- reward_count = number (quantity of reward)
    -- target_player = Player Object (patient) or nil if surgery was on a Surg-E machine
    
    if target_player then
        print(player:getName() .. " performed surgery on " .. target_player:getName())
    else
        print(player:getName() .. " used a Surg-E machine")
    end
end)

onPlayerKillCallback(function(world, player, killedPlayer)
    -- code here
end)

onPlayerProviderCallback(function(world, player, tile, itemID, itemCount)
    -- code here
end)

onPlayerHarmonicCallback(function(world, player, tile, itemID, itemCount)
    -- code here
end)

onPlayerGeigerCallback(function(world, player, itemID, itemCount)
    -- code here
end)

onPlayerCatchGhostCallback(function(world, player, itemID, itemCount)
    -- code here
end)

onPlayerXPCallback(function(world, player, amount)
    -- code here
end)

onPlayerFirePutOutCallback(function(world, player, tile)
    -- code here
end)

onPlayerEarnGrowtokenCallback(function(world, player, itemCount)
    -- code here
end)

onPlayerTrainFishCallback(function(world, player)
    -- called once the player has trained a fish
    -- code here
end)

onPlayerStartopiaCallback(function(world, player, item_id, item_count)
    -- world = World Object
    -- player = Player Object
    -- item_id = number (item received from startopia)
    -- item_count = number (quantity received)
    
    player:onConsoleMessage("You got " .. item_count .. "x Item ID " .. item_id .. " from Startopia!")
end)

onPlayerCookingCallback(function(world, player, item_id, item_count)
    -- world = World Object
    -- player = Player Object
    -- item_id = number (cooked item received)
    -- item_count = number (quantity received)
    
    player:onConsoleMessage("You cooked " .. item_count .. "x Item ID " .. item_id .. "!")
end)

onPlayerDungeonEntitySlainCallback(function(world, player, entity_type)
    -- world = World Object
    -- player = Player Object
    -- entity_type = number (type of dungeon entity killed)
    
    -- Useful for custom dungeon quests
    player:onConsoleMessage("You defeated a dungeon entity!")
end)

onPlayerGemsObtainedCallback(function(world, player, amount)
    -- code here
end)