Nperma Docs

Appearance

Callback Event ​

Callback Event

onAutoSaveRequest ​

Triggered periodically by the server to request data saving. Use saveDataToServer here.

lua
onAutoSaveRequest(function()
  -- code here
end)

onDiscordMessageCreateCallback ​

Triggered when a message is created in a linked Discord channel.

Parameters ​

  • event
lua
onDiscordMessageCreateCallback(function(event)
  -- code here
end)

onEventChangedCallback ​

Triggered when the server-wide event changes.

Parameters ​

  • newEventID
  • oldEventID
lua
onEventChangedCallback(function(newEventID, oldEventID)
  -- code here
end)

onPlayerActionCallback ​

A generic callback for various player actions, often from UI buttons. data["action"] contains the action name.

Parameters ​

  • world
  • player
  • data
lua
onPlayerActionCallback(function(world, player, data)
  -- code here
end)

onPlayerAddFriendCallback ​

Triggered when a player adds another player as a friend.

Parameters ​

  • world
  • player
  • addedPlayer
lua
onPlayerAddFriendCallback(function(world, player, addedPlayer)
  -- code here
end)

onPlayerBoostClaimCallback ​

Triggered when a player claims a boost.

Parameters ​

  • player
lua
onPlayerBoostClaimCallback(function(player)
  -- code here
end)

onPlayerCatchFishCallback ​

Triggered when a player catches a fish.

Parameters ​

  • world
  • player
  • itemID
  • itemCount
lua
onPlayerCatchFishCallback(function(world, player, itemID, itemCount)
  -- code here
end)

onPlayerCatchGhostCallback ​

Triggered when a player catches a ghost.

Parameters ​

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

onPlayerCommandCallback ​

Handles the execution of custom slash commands. Return true if you handle the command.

Parameters ​

  • world
  • player
  • fullCommand
lua
onPlayerCommandCallback(function(world, player, fullCommand)
  -- code here
end)

onPlayerConsumableCallback ​

Triggered when a player uses a consumable item.

Parameters ​

  • world
  • player
  • tile
  • clickedPlayer
  • itemID
lua
onPlayerConsumableCallback(function(world, player, tile, clickedPlayer, itemID)
  -- code here
end)

onPlayerConvertItemCallback ​

Triggered when a player double-taps specific items to convert them (e.g., 100 WLs to 1 DL). Return true to prevent default behavior.

Parameters ​

  • world
  • player
  • item_id
lua
onPlayerConvertItemCallback(function(world, player, item_id)
  -- code here
end)

onPlayerCrimeCallback ​

Related to moderation actions or "crimes".

Parameters ​

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

onPlayerDeathCallback ​

Triggered when a player dies or respawns. isRespawn is true if the player is respawning.

Parameters ​

  • world
  • player
  • isRespawn
lua
onPlayerDeathCallback(function(world, player, isRespawn)
  -- code here
end)

onPlayerDialogCallback ​

Handles player interactions with dialogs. The data table contains dialog_name and buttonClicked.

Parameters ​

  • world
  • player
  • data
lua
onPlayerDialogCallback(function(world, player, data)
  -- code here
end)

onPlayerDisconnectCallback ​

Triggered when a player disconnects from the server.

Parameters ​

  • player
lua
onPlayerDisconnectCallback(function(player)
  -- code here
end)

onPlayerDNACallback ​

Triggered when a player uses a DNA Combiner.

Parameters ​

  • world
  • player
  • resultID
  • resultAmount
lua
onPlayerDNACallback(function(world, player, resultID, resultAmount)
  -- code here
end)

onPlayerDropCallback ​

Triggered when a player drops an item. Return true to prevent the drop.

Parameters ​

  • world
  • player
  • itemID
  • itemCount
lua
onPlayerDropCallback(function(world, player, itemID, itemCount)
  -- code here
end)

onPlayerEarnGrowtokenCallback ​

Triggered when a player earns a Growtoken.

Parameters ​

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

onPlayerEnterDoorCallback ​

Triggered when a player enters a door. Return true to prevent entry.

Parameters ​

  • world
  • player
  • targetWorldName
  • doorID
lua
onPlayerEnterDoorCallback(function(world, player, targetWorldName, doorID)
  -- code here
end)

onPlayerEnterWorldCallback ​

Triggered when a player successfully enters a world.

Parameters ​

  • world
  • player
lua
onPlayerEnterWorldCallback(function(world, player)
  -- code here
end)

onPlayerEquipClothingCallback ​

Triggered when a player tries to equip an item. Return true to prevent equipping.

Parameters ​

  • world
  • player
  • itemID
lua
onPlayerEquipClothingCallback(function(world, player, itemID)
  -- code here
end)

onPlayerEquippedClothingCallback ​

Called AFTER a player successfully equips an item.

Parameters ​

  • world
  • player
  • item_id
lua
onPlayerEquippedClothingCallback(function(world, player, item_id)
  -- code here
end)

onPlayerFirePutOutCallback ​

Triggered when a player extinguishes a fire.

Parameters ​

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

onPlayerFirstTimeLoginCallback ​

Triggered only on a player's very first login to the server.

Parameters ​

  • player
lua
onPlayerFirstTimeLoginCallback(function(player)
  -- code here
end)

onPlayerGeigerCallback ​

Triggered when a player finds something with a Geiger counter.

Parameters ​

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

onPlayerGemsObtainedCallback ​

Triggered when a player obtains gems through various actions.

Parameters ​

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

onPlayerHarmonicCallback ​

Related to harmonic crystals.

Parameters ​

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

onPlayerHarvestCallback ​

Triggered when a player harvests a tree.

Parameters ​

  • world
  • player
  • tile
lua
onPlayerHarvestCallback(function(world, player, tile)
  -- code here
end)

onPlayerKillCallback ​

Triggered when a player kills another player (e.g., in a PVP world).

Parameters ​

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

onPlayerLeaveWorldCallback ​

Triggered when a player leaves a world.

Parameters ​

  • world
  • player
lua
onPlayerLeaveWorldCallback(function(world, player)
  -- code here
end)

onPlayerLevelUPCallback ​

Triggered when a player levels up.

Parameters ​

  • world
  • player
  • levelReached
lua
onPlayerLevelUPCallback(function(world, player, levelReached)
  -- code here
end)

onPlayerLoginCallback ​

Triggered when a player logs into the server.

Parameters ​

  • player
lua
onPlayerLoginCallback(function(player)
  -- code here
end)

onPlayerPickupItemCallback ​

Triggered when a player picks up an item. Return true to prevent the pickup.

Parameters ​

  • world
  • player
  • itemID
  • itemCount
lua
onPlayerPickupItemCallback(function(world, player, itemID, itemCount)
  -- code here
end)

onPlayerPlantCallback ​

Triggered when a player plants a seed.

Parameters ​

  • world
  • player
  • tile
lua
onPlayerPlantCallback(function(world, player, tile)
  -- code here
end)

onPlayerProviderCallback ​

Triggered when a player receives items from a provider block.

Parameters ​

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

onPlayerPunchNPCCallback ​

Triggered when a player punches an NPC.

Parameters ​

  • world
  • player
  • npc_player
lua
onPlayerPunchNPCCallback(function(world, player, npc_player)
  -- code here
end)

onPlayerPunchPlayerCallback ​

Triggered when a player punches another player.

Parameters ​

  • world
  • player
  • second_player
lua
onPlayerPunchPlayerCallback(function(world, player, second_player)
  -- code here
end)

onPlayerRawPacketCallback ​

A very low-level callback for handling raw network packets from a player. Advanced use only.

Parameters ​

  • player
  • data
lua
onPlayerRawPacketCallback(function(player, data)
  -- code here
end)

onPlayerRecycleCallback ​

Triggered when a player recycles an item. Return true to prevent recycling.

Parameters ​

  • world
  • player
  • item_id
  • item_amount
  • gems_earned
lua
onPlayerRecycleCallback(function(world, player, item_id, item_amount, gems_earned)
  -- code here
end)

onPlayerRegisterCallback ​

Triggered when a player registers a new account. Useful for giving starter packs.

Parameters ​

  • world
  • player
lua
onPlayerRegisterCallback(function(world, player)
  -- code here
end)

onPlayerSurgeryCallback ​

Triggered during a surgery action. targetPlayer is the player receiving surgery (can be nil).

Parameters ​

  • world
  • player
  • itemID
  • itemCount
  • targetPlayer
lua
onPlayerSurgeryCallback(function(world, player, itemID, itemCount, targetPlayer)
  -- code here
end)

onPlayerTick ​

Called every 1000ms for each online player.

Parameters ​

  • player
lua
onPlayerTick(function(player)
  -- code here
end)

onPlayerTradeCallback ​

Triggered upon a successful trade. items1 and items2 are tables of traded items.

Parameters ​

  • world
  • player1
  • player2
  • items1
  • items2
lua
onPlayerTradeCallback(function(world, player1, player2, items1, items2)
  -- code here
end)

onPlayerTrainFishCallback ​

Called once a player has trained a fish.

Parameters ​

  • world
  • player
lua
onPlayerTrainFishCallback(function(world, player)
  -- code here
end)

onPlayerTrashCallback ​

Triggered when a player trashes an item. Return true to prevent trashing.

Parameters ​

  • world
  • player
  • item_id
  • item_amount
lua
onPlayerTrashCallback(function(world, player, item_id, item_amount)
  -- code here
end)

onPlayerUnequipClothingCallback ​

Triggered when a player tries to unequip an item. Return true to prevent unequipping.

Parameters ​

  • world
  • player
  • itemID
lua
onPlayerUnequipClothingCallback(function(world, player, itemID)
  -- code here
end)

onPlayerUnequippedClothingCallback ​

Called AFTER a player successfully unequips an item.

Parameters ​

  • world
  • player
  • item_id
lua
onPlayerUnequippedClothingCallback(function(world, player, item_id)
  -- code here
end)

onPlayerVariantCallback ​

A low-level callback for handling various client packets (variants). Advanced use only.

Parameters ​

  • player
  • variant
  • delay
  • netID
lua
onPlayerVariantCallback(function(player, variant, delay, netID)
  -- code here
end)

onPlayerWrenchCallback ​

Triggered when a player wrenches another player or NPC. You can check wrenchingPlayer:getType() to see if it's an NPC (e.g., type 25 for Lua-spawned NPCs).

Parameters ​

  • world
  • player
  • wrenchingPlayer
lua
onPlayerWrenchCallback(function(world, player, wrenchingPlayer)
  -- code here
end)

onPlayerXPCallback ​

Triggered when a player gains experience points.

Parameters ​

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

onTick ​

Called every 100ms on the server globally.

lua
onTick(function()
  -- code here
end)

onTileBreakCallback ​

A generic callback for when any tile is broken.

Parameters ​

  • world
  • player
  • tile
lua
onTileBreakCallback(function(world, player, tile)
  -- code here
end)

onTilePlaceCallback ​

Triggered when a player places a tile. Return true to prevent placement.

Parameters ​

  • world
  • player
  • tile
  • placingID
lua
onTilePlaceCallback(function(world, player, tile, placingID)
  -- code here
end)

onTilePunchCallback ​

Triggered when a player punches a tile. Return true to prevent the default break action.

Parameters ​

  • world
  • avatar
  • tile
lua
onTilePunchCallback(function(world, avatar, tile)
  -- code here
end)

onTileWrenchCallback ​

Triggered when a player wrenches a tile.

Parameters ​

  • world
  • player
  • tile
lua
onTileWrenchCallback(function(world, player, tile)
  -- code here
end)

onWorldLoaded ​

Called once a world is loaded into memory.

Parameters ​

  • world
lua
onWorldLoaded(function(world)
  -- code here
end)

onWorldOffloaded ​

Called once a world is removed from memory.

Parameters ​

  • world
lua
onWorldOffloaded(function(world)
  -- code here
end)

onWorldTick ​

Called every 100ms for each active world.

Parameters ​

  • world
lua
onWorldTick(function(world)
  -- code here
end)

Released under the MIT License.

Copyright © 2026-present Nperma