Nperma Docs

Appearance

Functions ​

Function List

registerLuaCommand ​

Register a new Lua command

Parameters ​

  • registerData
lua
registerLuaCommand(registerData)

addDailyOfferPurchased ​

Adds a daily offer purchased.

Parameters ​

  • userID
  • itemID
lua
addDailyOfferPurchased(userID, itemID)

addSidebarButton ​

Adds a button to the player's sidebar UI using a JSON string.

Parameters ​

  • buttonJson
lua
addSidebarButton(buttonJson)

addSocialPortalButton ​

Adds a button to the social portal.

Parameters ​

  • buttonDef
  • callback
lua
addSocialPortalButton(buttonDef, callback)

addWorldMenuWorld ​

Adds a world to the main menu world list. Priority 1 is before special worlds, 0 is after.

Parameters ​

  • worldID
  • displayName
  • color
  • priority
lua
addWorldMenuWorld(worldID, displayName, color, priority)

createRedeemCode ​

Creates a redeem code dynamically. Returns the code string or empty string on failure.

Parameters ​

  • redeemData
lua
createRedeemCode(redeemData)

getActiveDailyOffers ​

Returns the active daily offers.

lua
getActiveDailyOffers()

getActiveWorlds ​

Returns a table of all currently loaded (active) worlds.

lua
getActiveWorlds()

getAllPlayers ​

Returns a list of all players who have ever logged in.

lua
getAllPlayers()

getAmount ​

Returns the amount.

lua
getAmount()

getBlessingInfo ​

Returns the information/description of a blessing by its ID.

Parameters ​

  • blessing_id
lua
getBlessingInfo(blessing_id)

getBlessingName ​

Returns the name of a blessing by its ID.

Parameters ​

  • blessing_id
lua
getBlessingName(blessing_id)

getBlessingRarity ​

Returns the rarity of a blessing by its ID.

Parameters ​

  • blessing_id
lua
getBlessingRarity(blessing_id)

getCategory ​

Returns the category of the item.

lua
getCategory()

getCurrentDailyEventDescription ​

Returns the current daily event's description.

lua
getCurrentDailyEventDescription()

getCurrentEventDescription ​

Returns the current event's description.

lua
getCurrentEventDescription()

getCurrentRoleDayDescription ​

Returns the current role day's description.

lua
getCurrentRoleDayDescription()

getCurrentServerDailyEvent ​

Returns the current server's daily event.

lua
getCurrentServerDailyEvent()

getDescription ​

Returns the description.

lua
getDescription()

getEcoQuantity ​

Returns the total count of an item in the economy (players + worlds).

Parameters ​

  • itemID
lua
getEcoQuantity(itemID)

getEcoQuantityPlayers ​

Returns the total count of an item held by players.

Parameters ​

  • itemID
lua
getEcoQuantityPlayers(itemID)

getEcoQuantityWorlds ​

Returns the total count of an item placed or stored in worlds.

Parameters ​

  • itemID
lua
getEcoQuantityWorlds(itemID)

getEnumItem ​

Gets an item by its enum name (e.g., "ITEM_DIRT"). Returns an item object.

Parameters ​

  • enumName
lua
getEnumItem(enumName)

getEventOffers ​

Returns the event offers.

lua
getEventOffers()

getExpireTime ​

Returns the Expire Time.

lua
getExpireTime()

getHighestPriorityRole ​

Returns the role object with the highest priority.

lua
getHighestPriorityRole()

getIOTMItem ​

Returns the IOTM item.

lua
getIOTMItem()

getItem ​

Returns the global item data object for a given item ID.

Parameters ​

  • itemID
lua
getItem(itemID)

getItemsCount ​

Returns the total number of items loaded in the server.

lua
getItemsCount()

getItemsDescription ​

Returns the items description.

lua
getItemsDescription()

getJimDailyQuest ​

Returns the Jim Daily Quest object. Contains jimDaily.firstItemID, jimDaily.firstItemCount, etc.

lua
getJimDailyQuest()

getMaxLevel ​

Returns the maximum player level configured on the server.

lua
getMaxLevel()

getNewsBanner ​

Returns the news banner.

lua
getNewsBanner()

getNewsBannerDimensions ​

Returns the news banner dimensions.

lua
getNewsBannerDimensions()

getPlayer ​

Returns the player object for a given user ID, if they are online.

Parameters ​

  • userID
lua
getPlayer(userID)

getPlayerByName ​

Returns the player object for a given name, if they are online.

Parameters ​

  • name
lua
getPlayerByName(name)

getPrice ​

Returns the price of the item.

lua
getPrice()

getRealGTItemsCount ​

Returns the real GT items count.

lua
getRealGTItemsCount()

getRequiredEvent ​

Returns the required event.

lua
getRequiredEvent()

getRoles ​

Returns a table containing all server roles.

lua
getRoles()

getServerCurrentEvent ​

Returns the ID of the current server-wide event.

lua
getServerCurrentEvent()

getServerID ​

Returns server ID.

lua
getServerID()

getServerName ​

Returns the server name.

lua
getServerName()

getServerPlayers ​

Returns a table of all online players on the server.

lua
getServerPlayers()

getStoreItems ​

Returns the store items.

lua
getStoreItems()

getTexture ​

Returns the texture.

lua
getTexture()

getTexturePosX ​

Returns the texture position X.

lua
getTexturePosX()

getTexturePosY ​

Returns the texture position Y.

lua
getTexturePosY()

getTitle ​

Returns the title.

lua
getTitle()

getTodaysDate ​

Returns the Date.

lua
getTodaysDate()

getTodaysEvents ​

Returns the Event of that day.

lua
getTodaysEvents()

getTopPlayerByBalance ​

Returns the top player by balance.

lua
getTopPlayerByBalance()

getTopWorldByVisitors ​

Returns the top world by visitors.

lua
getTopWorldByVisitors()

hideWorldMenuDefaultSpecialWorlds ​

Pass 1 to hide default worlds like LOCKE, 0 to show.

Parameters ​

  • hide
lua
hideWorldMenuDefaultSpecialWorlds(hide)

loadDataFromServer ​

Loads a previously saved Lua table from the server.

Parameters ​

  • key
lua
loadDataFromServer(key)

loadStringFromServer ​

Loads a string value from the server.

Parameters ​

  • key
lua
loadStringFromServer(key)

onPurchaseItem ​

Firing the purchase item event.

Parameters ​

  • player
  • item
  • bool
lua
onPurchaseItem(player, item, bool)

onPurchaseItemReq ​

Firing the purchase item request event.

Parameters ​

  • player
  • itemID
lua
onPurchaseItemReq(player, itemID)

parseText ​

Converts a pipe-delimited string (e.g., "key|value") into a table. Example: local data = parseText("name|John"); print(data["name"]).

Parameters ​

  • text
lua
parseText(text)

registerLuaEvent ​

Registers a custom server-wide event.

Parameters ​

  • eventData
lua
registerLuaEvent(eventData)

registerLuaPlaymod ​

Registers the Lua playmod.

Parameters ​

  • PLAYMODDATA
lua
registerLuaPlaymod(PLAYMODDATA)

reloadScripts ​

Reloads all Lua scripts.

lua
reloadScripts()

removeWorldMenuWorld ​

Removes a world from the main menu list.

Parameters ​

  • worldID
lua
removeWorldMenuWorld(worldID)

saveDataToServer ​

Saves a Lua table to the server with a specific key.

Parameters ​

  • key
  • dataTable
lua
saveDataToServer(key, dataTable)

saveStringToServer ​

Saves a string value to the server.

Parameters ​

  • key
  • value
lua
saveStringToServer(key, value)

setBroadcastWorld ​

Sets the global broadcast world for all players.

Parameters ​

  • worldName
lua
setBroadcastWorld(worldName)

setGemEvent ​

Starts a server-wide gem event. A multiplier of 0 or 1 stops the event.

Parameters ​

  • multiplier
lua
setGemEvent(multiplier)

setXPEvent ​

Starts a server-wide XP event. A multiplier of 0 or 1 stops the event.

Parameters ​

  • multiplier
lua
setXPEvent(multiplier)

worldExists ​

Checks if a world with the given name already exists on the server.

Parameters ​

  • name
lua
worldExists(name)

Released under the MIT License.

Copyright © 2026-present Nperma