BLOXAR Lua API

Block scripts in BLOXAR are written in Lua and run in an isolated virtual machine (fengari) — each script has its own separate state, and scripts cannot see each other's variables directly. Blocks can communicate with each other only through the explicit engine functions described in this document, or through events (emit/on).

🚀 First script

1. Open the project in Studio Mode.
2. In the Explorer panel, select a block, click ➕ and add 📜 Script.
3. Click the script — the code editor will open.
4. Write Lua code and click Save & Close.
5. Click Publish to publish the world to the server.

Minimal example

function onTick(dt)
    if isKeyDown('e') then
        say('Hello from the script!')
    end
end

onTick(dt) is the only function the engine calls automatically, every frame, with dt being the time in seconds since the previous frame. All other code inside the script is written around it.

🧬 Block variables

These functions are available only inside a script attached to a block — they return data of precisely this block, without requiring a UUID.

⚡ Events

-- Button block
on('door_toggle')
function onEvent_door_toggle(data)
    say('The door received a signal from ' .. data.from)
end

function onTick(dt)
    if isKeyDown('e') then
        emit('door_toggle', 'state', 'open')
    end
end

❤️ Player health and position

⌨️ Input

🎥 Camera

🌍 Time of day and gravity

🧱 Blocks

Each function takes or returns a uuid — the unique ID of a block (you can get it via getBlockUUID() for your own block, findBlockByName() for someone else's, or as the result of spawnBlock()).

Search

Reading properties

Modification

Creation / removal

📡 Raycast

🎒 Inventory and score

setGlobalVar('score', (getGlobalVar('score') or 0) + 10)
say('Score: ' .. getGlobalVar('score'))

👥 Multiplayer

Read-only — other players are controlled by the server directly.

🔊 Sound and chat

⏱ Timers

wait(2, function()
    say('2 seconds have passed')
end)

🖥️ UI and dialogs

📊 Data tables

Most API functions return a string (easier to marshal into Lua), but for lists of objects there are versions that return a real Lua table.

for i, p in ipairs(getOtherPlayersTable()) do
    print(p.nickname, p.x, p.y, p.z)
end

🎬 Animations

🧮 Math and utilities

💡 Ready-made examples (Copy & Paste)

Light car (get in with E)

local carId = nil
local seated = false
local eWasDown = false
local speed = 6.0
local turnSpeed = 2.2
local enterRadius = 2.5
local rotY = 0

function onTick(dt)
    if carId == nil then carId = getBlockUUID() end
    local cx, cy, cz = getBlockX(), getBlockY(), getBlockZ()
    local eDown = isKeyDown('e')
    local ePressed = eDown and not eWasDown
    eWasDown = eDown

    if not seated then
        if ePressed and distanceToPlayer(cx, cy, cz) < enterRadius then
            seated = true
            say('Got behind the wheel')
        end
        return
    end

    if ePressed then
        seated = false
        say('Got out of the car')
        setPlayerPosition(cx + 2, cy + 1, cz)
        return
    end

    if isKeyDown('a') then rotY = rotY + turnSpeed * dt end
    if isKeyDown('d') then rotY = rotY - turnSpeed * dt end

    local moveDir = 0
    if isKeyDown('w') then moveDir = 1 end
    if isKeyDown('s') then moveDir = -1 end

    local nx, nz = cx, cz
    if moveDir ~= 0 then
        nx = cx + math.sin(rotY) * speed * dt * moveDir
        nz = cz + math.cos(rotY) * speed * dt * moveDir
    end

    setBlockPosition(carId, nx, cy, nz)
    setBlockRotation(carId, 0, rotY, 0)
    setPlayerPosition(nx, cy + 1.0, nz)
    setPlayerRotationY(rotY)
end

Spike trap (damage on touch)

local cooldown = 0

function onTick(dt)
    cooldown = math.max(0, cooldown - dt)
    local x, y, z = getBlockX(), getBlockY(), getBlockZ()
    if distanceToPlayer(x, y, z) < 1.2 and cooldown <= 0 then
        cooldown = 1.5
        damagePlayer(20)
        playSound('land', 1)
    end
end

Interactive button

local activated = false

function onTick(dt)
    local x, y, z = getBlockX(), getBlockY(), getBlockZ()
    if distanceToPlayer(x, y, z) < 3 and not activated then
        if isKeyDown('e') then
            activated = true
            playSound('jump', 1)
            setBlockColor(getBlockUUID(), 0x2EE6A6)
            announce('Button activated!')
        end
    end
end

Portal with a delay

local used = false

function onPlayerEnter(who)
    if used then return end
    used = true
    say(who .. ' activated the portal')
    wait(1, function()
        setPlayerPosition(0, 5, 0)
        used = false
    end)
end