API reference
Permissions
A mod lists what it needs under "permissions" in mod.json. Low risk permissions are granted by declaring them. Medium and high risk permissions are shown to the player, who must allow them before the mod runs; a mod asking for more later is asked again. See Security and permissions.
| Permission | Risk | Lets a mod | From |
|---|---|---|---|
audio | low | Sound. Play its own sounds and music. | Engine |
building | low | Creations. See the blocks in creations, what you have selected, and add buttons to the building toolbar. | Building |
building.edit | medium | Change block settings. Change the settings of blocks on creations you own, as if you had used the block's panel. | Building |
building.kinetics | medium | Make parts turn. Give blocks axles and gear teeth, mesh them and drive them, on a server you host. A mod could make creations' parts spin on their own. | Building |
building.limits | high | Raise part limits. Let engines, motors and other parts be set beyond their normal ratings — for every player on a server you host. Creations can become far more powerful than the game is balanced for. | Building |
building.overlap | medium | Place blocks inside blocks. Move blocks into positions that overlap other blocks, on a server you host. | Building |
building.physics | medium | Push creations. Apply forces to moving creations, on a server you host. | Building |
camera | medium | Camera. Move the camera or change what it sees. | Engine |
devtools | low | Developer console commands. Add its own commands to the developer console. | Developer tools |
http:<domain> | high | Internet access. Send and receive data from a website over HTTPS. The site is named in the prompt, and it will see your IP address. | Scripting core |
input | medium | Keys and buttons. React to keys you press. It can only see the keys it asked for by name, never everything you type. | Engine |
net | low | Network messages. Exchange messages with the same mod running on the server or on other players' games. | Scripting core |
players | low | Player list. See who is playing, their names and where they are. | Scripting core |
players.teleport | medium | Teleport players. Move players to another place in the world. Only works on the server you host. | Scripting core |
scenes | medium | Maps. Add its own maps and ask the game to load one. | Engine |
ui | low | Interface. Show its own windows, panels and buttons. | Engine |
ui.game | medium | Change the game's interface. Add to, change or hide parts of the game's own screens. Everything it changes is put back when the mod is turned off. | Engine |
video | low | Video. Play video files it ships with. | Engine |
world | medium | Objects in the world. Create, move and remove objects in the world. | Engine |