All natives

Replaces the group when it exists. Members stay.

The same check as a method is player:hasPermission(permission).

Counts every AI controlled character in the world, including the game's own AI.

Destroys every AI controlled character in the world, the game's own AI included. The game spawns new AI afterwards as usual.

A brain describes how an animal senses, moves, picks targets, fights, flees, behaves in a group and when it disappears. An animal with a brain keeps its body, its pathfinding and i

Defining a name again replaces the brain. Animals that already run on it use the new values from their next think step.

Removes a brain that a script defined. When brains.json holds a brain of the same name, that one takes over and the animals keep running. When only the file has the name, the file

Loads brains.json and spawns.json again right away. A file with broken JSON is skipped with a log line and the brains and spawners from before stay. A brain in the file with an unk

The home point is the place where the animal stands at that moment. Change it with setHome.

An animal without a brain gives a short table with id, species, health, maxHealth, x, y, z. Test info.brain to tell the two apart.

Sends the animal to a point. The state is scripted until it arrives or 120 seconds passed. After that the brain decides again. gait is "walk", "trot" or "sprint", default is the br

The animal follows the target and keeps distance (default 600). It walks when it is close, trots when it falls behind and sprints when it is far behind. The state stays scripted un

Forces chase on this target, whatever the brain's targets and aggression say. A forced chase ignores the leash, memorySeconds and fleeHealth. It ends when the target is dead or gon

The animal runs away from a target or from a point. seconds defaults to the brain's fleeSeconds.

The animal stops and stands still, in the state scripted. Without seconds it holds until release or another command.

Ends scripted. The brain decides again.

Moves the home point of one animal. roamRadius replaces the brain's movement.roamRadius for this animal.

A spawner fills up in groups of pack.size of its brain, one group per second. Each group spawns at a random point inside radius. That point is the home of the group, and its animal

The plugin looks for new wild animals every 10 seconds. A wild animal that got a brain has a handle from then on and shows up in modkit.ai.list.

Shows a chat line to every player.

Chat line to one player. See player:message.

Fires when a player sends a chat message that is not a registered command.

Fires for every line that starts with / or !, and for the game's own chat command call. It fires before the command table is searched, for known and unknown commands.

Registers a command that players run with /name or !name in the chat, or with name in the F8 console of the launcher client.

Removes a command of the calling resource.

See also the chat commands guide.

Writes one log line with the resource name in front. The values are converted with tostring and joined with two spaces.

Log line: [myresource] WARN no webhook configured

Several handlers per name are allowed. They run in the order they were added. An error in one handler is logged and does not stop the others.

Removing a handler while its event is being dispatched is safe. The running dispatch still finishes with the old list.

Fires an event on the same side, in every loaded resource including your own. Use it to let resources talk to each other. The arguments are copied through JSON, so only strings, nu

Sends an event to the server scripts. The server handler receives the sender's player table first, then the arguments. Nothing is sent while the script link is down.

Sends an event to the client scripts of every player.

Raises an error when the resource is not running, the export does not exist, or the exported function fails. The message of the inner error is part of the new one. Use pcall when t

The call walks through all game objects. Use it on a timer of a few seconds, not every tick.

Projects a world position onto the screen with the engine's ProjectWorldLocationToScreen.

Lists the parameters that the material instances of one slot override, walking up the parent chain.

Sets a vector parameter. The first call on a slot creates a dynamic material instance for it.

Loads an image from your resource and sets it as a texture parameter. The image is decoded once per file and then reused.

The function returns right after step 0. Use the garageRestored event to know when it finished.

All three accept a player table in place of the Steam ID.

Puts a dinosaur into a player's garage, for shops and rewards. The player does not have to be online.

The callback gets one table.

Short forms of request. postJson encodes value with modkit.json.encode and sets Content-Type: application/json.

Rules.

Invalid JSON raises a Lua error. Wrap the call in pcall when the text comes from a player or a file that may be damaged.

Removes a binding.

For automatic cleanup of blocked species see modkit.population.setEggCleanup.

Opens a page and returns a browser object. The page covers the whole screen. It is click-through until you give it focus.

Turns the mouse cursor on or off. Pages only receive input while the cursor is on.

Shows the game's own notification on this client. It calls ClientShowNotification on the local player controller, the same function the server uses for player:notify.

Shows a chat line to this player only.

Shows the game's own notification to this player (ClientShowNotification).

Shows the game's announcement banner to this player (Client_ProcessIncomingAnnouncement).

Writes a line into the F8 console of this player. Does nothing while the script link of that player is down. The F8 console is off by default, ISLEMODKIT_CONSOLE=1 in the environme

Sends an event to the client scripts of this player. Does nothing while the script link of that player is down. See the events guide for the argument rules.

Kicks the player from the game server and closes the script link.

Moves the player's dinosaur. Without yaw it calls K2_SetActorLocation. With yaw it calls K2_SetActorLocationAndRotation and keeps pitch and roll. There is no collision sweep and no

Reads the rotation of the dinosaur at the moment of the call.

Sets one stat of the dinosaur and forces a network update so the client sees it at once.

Kills the dinosaur on the server. It sets health to zero and calls the game's SpecialDeathFromServer.

Changes the colors and pattern slots of the dinosaur. All players see the result. The skins guide explains zones and color formats.

Sets health to the maximum, clears venom and heals fractures of legs, body and head.

Everything heal does, plus hunger, thirst, stamina and blood to their maximum, locked damage to zero and the three diet values filled.

Takes health away. When the health would reach zero the player is killed the same way as with player:kill().

Twice per second the server sets the health back to the maximum and clears locked damage. It is a fast heal, not true invulnerability. A single hit that takes more than the full he

Refills the stamina twice per second while it is on. Lasts until you switch it off or the server restarts.

Reads values that are not part of the player snapshot. This asks the game directly, so call it when you need it and not for every player every second.

The values are the internal mutation names of the game. Read them from a dinosaur that has the mutation.

The server adds the names to the unlocked list, writes parent and elder slots at once and the four active slots half a second later, because the game drops active slots that are wr

All three return nil or false without a dinosaur.

Growth speed of one player. 2 grows twice as fast, 0.5 half as fast. freezeGrowth(true) stops growth. The setting belongs to the Steam ID, it is applied again after every respawn a

Scales the visible mesh of the dinosaur, 0.1 to 100. Hitboxes and the camera stay as they are. The scale is lost on respawn.

Turns the player into another species on the spot. The server spawns the new dinosaur 3 m above the old one, moves the Steam ID over, lets the controller possess it and destroys th

Writes a state onto the dinosaur the player plays now. The species must match state.species. It runs the same four steps as a garage restore, see garage. The event stateApplied(pla

Adds the player to the ban list and kicks them. hours of 0 or nothing means forever.

Switching it off puts every cooked species back on the select screen.

Short forms of setRule(species, { enabled = true }) and setRule(species, { enabled = false }). A cap that was set before stays.

Both return nothing blocked while the lock is not active.

An exempt player gets the full list about half a second after opening the select screen. The list is not saved, set it again after a server restart.

With true the server destroys the nests of blocked species every 5 seconds while the lock is active. That closes the way around the lock through eggs. The search walks all game obj

Evaluates the rules now instead of waiting for the next check.

Reads a file from the folder of the calling resource on the server's disk.

Writes a file into the folder of the calling resource. The content goes to <path>.tmp first and then replaces the target, so a crash during the write keeps the old file.

Returns a file that the server delivered for the calling resource. The client keeps these files in memory, there is no disk access.

Hides a species. Works for base game species and for your own entries. The name is compared without case.

Every field is optional except host. A missing field has its default. Distances are Unreal units (100 per metre), times are seconds, shares go from 0 to 1, angles are degrees.

Loads every species.json again right away. A file with broken JSON is skipped with a log line, and the definition from before stays. A bad value in a file is replaced by its defaul

Defines a species for as long as the server runs. Nothing is written to disk. The model and the animations must already be in a pak under client-mods, named after the species. An u

Gives the player the species, or removes it with nil. When the player plays another species than the host right now, the server first turns them into the host with player:setSpecie

The player table also carries customSpecies with the same value.

Hands the store to the writer thread now instead of after the two second wait.

Runs fn once after ms milliseconds.

Runs fn every ms milliseconds until it is cleared. With ms = 0 it runs on every timer check.

Stops a timeout or an interval. Unknown ids are ignored. A timer can clear itself from inside its function.

Same as distance without the height.

Players who are already on the server stay when you switch it on.

The server size comes from sv_maxplayers in server.cfg. With 40 slots and 2 reserved, player number 39 and 40 must be on the reserved list. The plugin does not change the player li

Same behaviour as the whitelist functions, for the reserved list.

The value is the sky actor's TimeOfDayIsle divided by 100. 1200 in the game is noon, which is 12.0 here.

The day keeps running from the new time. There is no function to freeze the time yet.

The numbers are the raw values of Ultra Dynamic Weather.

This scans every object in the game. Call it once in a command, not in a timer.

Calls the Change Weather function of the weather actor.

Shows the game's announcement banner to every player.

Shows the game's notification to every player.

Switches to the first weather preset whose name contains clear. seconds is the transition time, default 30.

Runs through a list of weather presets and starts again at the end. The cycle replaces a cycle that is already running. It starts with the first step within one second.

Calls the game mode's SetBrightness for the night. 1 is the game's default, higher is brighter. nil goes back to 1. The server sends the value again every 30 seconds so that player

Growth speed for every player who has no own setting from player:setGrowthMultiplier. 1 is normal. The value is not saved, set it when your resource starts.

Spawns a static mesh actor that every player sees.

Same as spawnMesh for a blueprint actor class, /Game/.../BP_Name.BP_Name_C.

The table has the fields you passed to add.