Lua Basics

Selvut scripts use Lua syntax: local variables, function callbacks, tables for objects and arrays, and nil for missing values.

local name = "Selvut"
local ticks = 0
local enabled = true
local missing = nil

Use tables for API options:

local message = Setting.text("Message", {
  description = "Message printed by the script.",
  default = "Hello"
})

Script.on("tick", function(event)
  ticks = ticks + 1
end)

Many game-state APIs return nil when the player or world is unavailable:

local pos = Player.position()
if pos == nil then
  Chat.log("No player yet")
end

Lua array-style tables are one-based:

local values = { "A", "B", "C" }
Chat.log(values[1])
Chat.log(Random.pick(values))

⌘I