Functions

Server-side scripts run on the game server (gmp_server). All functions are global - no require is needed.

Characters are identified by ids (pid): ids 0 to getMaxSlots() - 1 are players (one per player slot), ids from getMaxSlots() up are server-side NPCs created with createNpc. Functions with Player in the name (Players) work for both; functions with Npc in the name (NPCs) only for server-side NPCs. Common types and constants are shared with the client side.

EventsCopy Anchor Link

addEventHandlerCopy Anchor Link

addEventHandler(event, handler)

Registers a handler for a server event. Several handlers can be registered for the same event; they are called in the order of registration. Events about characters (onPlayerSpawn, onPlayerDead, onPlayerHit, onPlayerRespawn) are reported for players and for server-side NPCs; the id tells which one it is. A handler of onPlayerChat can return false to stop the message from being shown in the chat.

Custom events sent by clients (triggerServerEvent) use the same function; their handlers get the id of the sending player first, then the arguments.

addEventHandler("onPlayerConnect", function(pid)
  sendMessageToAll(getPlayerName(pid) .. " entered the Colony")
end)

addEventHandler("buyItem", function(pid, item, amount)   -- triggerServerEvent("buyItem", ...) on the client
  giveItem(pid, item, amount)
end)

Returns: boolean - Always true.

removeEventHandlerCopy Anchor Link

removeEventHandler(event, handler)

Removes a handler registered with addEventHandler (the same function value).

Returns: boolean - false when this function was not registered for the event.

triggerClientEventCopy Anchor Link

triggerClientEvent(pid, name, ...)

Sends a custom event to one player's client scripts (addEventHandler(name, ...) on the client). Arguments may be nil, booleans, numbers, strings and tables of those.

triggerClientEvent(pid, "showScore", 10)

Returns: boolean - false when no player is connected on this slot.

triggerClientEventToAllCopy Anchor Link

triggerClientEventToAll(name, ...)

Sends a custom event to the client scripts of every connected player.

Returns: boolean - Always true.

Players and idsCopy Anchor Link

getMaxSlotsCopy Anchor Link

getMaxSlots()

Returns the number of player slots of the server. Player ids are 0 to getMaxSlots() - 1; ids from getMaxSlots() up belong to server-side NPCs.

for pid = 0, getMaxSlots() - 1 do
  if isPlayerConnected(pid) then sendMessage(pid, "Server restart in 5 minutes") end
end

Returns: integer - Number of player slots.

getPlayerCountCopy Anchor Link

getPlayerCount()

Returns the number of connected players.

Returns: integer

isPlayerConnectedCopy Anchor Link

isPlayerConnected(pid)

Tells whether a player is connected on the given slot.

Returns: boolean - false for an empty slot and for NPC ids.

kickPlayerCopy Anchor Link

kickPlayer(pid, reason?)

Disconnects a player from the server.

Returns: boolean - false when no player is connected on this slot.

ChatCopy Anchor Link

sendMessageCopy Anchor Link

sendMessage(pid, text)

Sends a chat message to one player.

Returns: boolean - false when no player is connected on this slot.

sendMessageToAllCopy Anchor Link

sendMessageToAll(text)

Sends a chat message to all connected players.

CommandsCopy Anchor Link

registerCommandCopy Anchor Link

registerCommand(name, handler)

Registers a chat command. When a player types /name ... in the chat, the handler is called with the player id and the rest of the line, and the line is not shown in the chat.

registerCommand("ore", function(pid, args)
  local amount = tonumber(args) or 10
  giveItem(pid, "ItMi_Orenugget", amount)
  sendMessage(pid, "The Ore Barons are watching...")
end)

TimersCopy Anchor Link

setTimerCopy Anchor Link

setTimer(handler, intervalMs, repeating?)

Calls a function after the given time, once or repeatedly.

local announcer = setTimer(function()
  sendMessageToAll("Visit the Old Camp market!")
end, 600000, true)   -- every 10 minutes

Returns: integer - Id of the timer, for killTimer.

killTimerCopy Anchor Link

killTimer(timerId)

Stops a timer started with setTimer.

Returns: boolean - false when no such timer is running.

TypesCopy Anchor Link

ServerEventNameCopy Anchor Link

Names of the server events accepted by addEventHandler. See Events for the handler arguments. Any other name is a custom event sent by a client with triggerServerEvent.