IMIsle Modkit
Pages in this area

Natives reference

Every function a script can call, grouped by namespace. Everything lives in the global table modkit, plus the global print.

How to read an entry

Each entry has a signature, a side, a parameter table, the return value and an example.

Optional parameters are in square brackets, player:teleport(x, y, z [, yaw]).

Methods of objects use the colon, player:kick("reason"). Functions of namespaces use the dot, modkit.players.list().

Side

Badge Meaning
Server only in server scripts (server "..." in the manifest)
Client only in client scripts (client "...")
Shared same name and behaviour on both sides

Conventions

  • Positions are Unreal units (centimetres). z is up.
  • Angles are degrees.
  • Steam IDs are strings with 17 digits.
  • A function that acts on a player returns false when the player is gone or has no dinosaur. It does not raise an error.
  • Wrong argument types raise a Lua error. The host logs it with the resource name and keeps running.
  • A player table is a snapshot. Its fields do not change after you got it. The server refreshes its data twice per second.

Pages

Server: player, world, chat, commands, roster, population, garage, ai, nests, zones, bans, whitelist, acl, http, storage, exports, config

Client: game, nui, keys, net

Both: events, timers, resources, json, util, core