Nebrix Lua API Documentation

Introduction

Nebrix uses Lua 5.4 as its scripting language. This API is designed to feel familiar to developers from other game engines while providing powerful features for creating 3D games.

Quick Start

Here's a simple example to get you started:

-- Create a red part
local part = Instance.new("Part", workspace)
part.Position = Vector3.new(0, 10, 0)
part.Color = Color3.fromRGB(255, 0, 0)
part.Size = Vector3.new(4, 1, 2)

-- Add physics
part.Anchored = false
part:ApplyImpulse(Vector3.new(0, 50, 0))

-- Update loop (called every frame)
function onUpdate(dt)
    part:Rotate(Vector3.new(0, 1, 0))
end

Vector3

Represents a 3D vector with X, Y, and Z components.

local position = Vector3.new(10, 5, 0)
local up = Vector3.new(0, 1, 0)

Constants

• Vector3.zero — Shorthand for Vector3.new(0, 0, 0)
• Vector3.one — Shorthand for Vector3.new(1, 1, 1)

Properties

Vector2

Represents a 2D vector with X and Y components. Used for GUI positioning and sizing.

local guiPos = Vector2.new(100, 50)

• Vector2.zero — Equals Vector2.new(0, 0)
• Vector2.one — Equals Vector2.new(1, 1)

Color3

Represents an RGB color with values from 0 to 1 (or 0–255 with fromRGB).

local white = Color3.new(1, 1, 1)
local black = Color3.new(0, 0, 0)

local red = Color3.fromRGB(255, 0, 0)
local blue = Color3.fromRGB(0, 100, 255)

local cyan = Color3.fromHSV(0.5, 1, 1)

Properties

• R or r — Red component (0–1)
• G or g — Green component (0–1)
• B or b — Blue component (0–1)

Instance

Base class for all objects in Nebrix.

local part = Instance.new("Part", workspace)
local model = Instance.new("Model", workspace)
local frame = Instance.new("Frame", game.PlayerGui)

Properties

Methods

if part:IsA("Part") then
    print("This is a part!")
end

local head = character:FindFirstChild("Head")

for i, child in pairs(workspace:GetChildren()) do
    print(child.Name)
end

Part

A 3D physical object with shape, position, and physics properties. Supported types: Part, Sphere, Cylinder, Wedge.

Properties

local part = Instance.new("Part", workspace)
part.Position = Vector3.new(0, 10, 0)
part.Size = Vector3.new(4, 1, 2)
part.Color = Color3.fromRGB(100, 150, 255)
part.Transparency = 0.5
part.Anchored = false
part.CanCollide = true
part.Mass = 10

Physics Methods

part:SetPosition(Vector3.new(10, 5, 0))

part:Translate(Vector3.new(0, 5, 0))

part:SetRotation(Vector3.new(0, 45, 0))

part:LookAt(Vector3.new(10, 0, 10))

part:ApplyImpulse(Vector3.new(0, 100, 0))

function onUpdate(dt)
    part:ApplyForce(Vector3.new(0, 50, 0))
end

part:AddVelocity(Vector3.new(5, 0, 0))

local vel = part:GetVelocity()
print("Speed:", vel.Y)

if part:IsGrounded() then
    print("On ground!")
end

local forward = part:GetForwardVector()
part:Translate(forward)

Model & Folder

Containers for organizing multiple objects in the game hierarchy.

local car = Instance.new("Model", workspace)
car.Name = "Car"

local body = Instance.new("Part", car)
body.Name = "Body"
body.Size = Vector3.new(4, 2, 6)

local wheel = Instance.new("Cylinder", car)
wheel.Name = "Wheel"

GUI Elements

Create in-game user interfaces with Frame, TextLabel, and TextButton.

Frame

local frame = Instance.new("Frame", game.PlayerGui)
frame.Size = Vector2.new(200, 100)
frame.Position = Vector2.new(50, 50)
frame.BackgroundColor3 = Color3.fromRGB(50, 50, 50)

TextLabel

local label = Instance.new("TextLabel", frame)
label.Text = "Hello Nebrix!"
label.Size = Vector2.new(200, 50)
label.Position = Vector2.new(0, 0)

TextButton

local button = Instance.new("TextButton", frame)
button.Text = "Click Me"
button.Size = Vector2.new(150, 40)

button.Clicked = function()
    print("Button was clicked!")
end

GUI Properties

game

The root of the game hierarchy. Use it to access services and global containers.

local workspace = game:GetService("Workspace")
local lighting = game:GetService("Lighting")
local gui = game:GetService("PlayerGui")

Direct Properties

• game.Workspace — The 3D world container
• game.Lighting — Lighting and atmosphere settings
• game.ScriptService — Container for scripts
• game.PlayerGui — Container for GUI elements

Workspace

The 3D world where all parts and models exist. Accessible via workspace or game.Workspace.

-- Both of these work:
local part = Instance.new("Part", workspace)
local part2 = Instance.new("Part", game.Workspace)

Lighting

Controls the lighting, atmosphere, and time of day in your game.

Properties

local lighting = game.Lighting
lighting.TimeOfDay = 18.5
lighting.Brightness = 2
lighting.Ambient = Color3.fromRGB(150, 100, 100)
lighting.FogStart = 50
lighting.FogEnd = 500
lighting.FogColor = Color3.fromRGB(200, 200, 220)

function onUpdate(dt)
    local lighting = game.Lighting
    lighting:SetTimeOfDay(lighting.TimeOfDay + dt * 0.1)
    if lighting.TimeOfDay > 24 then
        lighting.TimeOfDay = 0
    end
end

Math Extensions

Extended math functions beyond the standard Lua math library.

local speed = math.clamp(speed, 0, 100)

local pos = math.lerp(0, 100, 0.5) -- Returns 50

local dir = math.sign(-5) -- Returns -1

local rounded = math.round(4.7) -- Returns 5

local speed = math.randomFloat(1.0, 5.0)

local n = math.map(50, 0, 100, 0, 1) -- Returns 0.5

local dist = math.distance(
    Vector3.new(0, 0, 0),
    Vector3.new(10, 0, 0)
) -- Returns 10

Table Extensions

Additional table manipulation functions.

local fruits = {"apple", "banana", "orange"}
local i = table.find(fruits, "banana") -- Returns 2

local count = table.getn({1, 2, 3, 4}) -- Returns 4

local list = {1, 2, 3}
table.clear(list) -- list is now {}

local copy = table.clone({a = 1, b = 2})

local merged = table.merge({a=1}, {b=2}) -- {a=1, b=2}

local deck = {1, 2, 3, 4, 5}
table.shuffle(deck)

String Extensions

Additional string manipulation functions.

local parts = string.split("a,b,c", ",") -- {"a","b","c"}

string.trim("  hello  ") -- "hello"

string.startswith("player_1", "player_") -- true

string.endswith("game.lua", ".lua") -- true

string.replace("Hello World", "World", "Nebrix")
-- "Hello Nebrix"

Task Library

Functions for managing asynchronous tasks and timing.

Global Functions

print("Hello, Nebrix!")
print("Position:", part.Position)

function onUpdate(dt)
    part.Rotation = part.Rotation + Vector3.new(0, 90 * dt, 0)
end

Global Variables

• script — Reference to the current script object
• workspace — Shorthand for game.Workspace

Complete Examples

Spinning Part

local part = Instance.new("Part", workspace)
part.Position = Vector3.new(0, 10, 0)
part.Color = Color3.fromRGB(255, 100, 100)
part.Anchored = true

function onUpdate(dt)
    part.Rotation = part.Rotation + Vector3.new(0, 45 * dt, 0)
end

Bouncing Ball

local ball = Instance.new("Sphere", workspace)
ball.Position = Vector3.new(0, 50, 0)
ball.Size = Vector3.new(2, 2, 2)
ball.Color = Color3.fromRGB(100, 150, 255)
ball.Anchored = false
ball.CanCollide = true

function onUpdate(dt)
    if ball:IsGrounded() then
        local vel = ball:GetVelocity()
        if vel.Y < 0 then
            ball:ApplyImpulse(Vector3.new(0, 80, 0))
        end
    end
end

Simple Button Counter

local count = 0

local frame = Instance.new("Frame", game.PlayerGui)
frame.Size = Vector2.new(200, 100)
frame.Position = Vector2.new(10, 10)
frame.BackgroundColor3 = Color3.fromRGB(40, 40, 40)

local label = Instance.new("TextLabel", frame)
label.Size = Vector2.new(200, 50)
label.Text = "Count: 0"

local button = Instance.new("TextButton", frame)
button.Size = Vector2.new(200, 40)
button.Position = Vector2.new(0, 55)
button.Text = "Click Me!"
button.BackgroundColor3 = Color3.fromRGB(225, 29, 72)

button.Clicked = function()
    count = count + 1
    label.Text = "Count: " .. count
end

Day/Night Cycle

local lighting = game.Lighting
lighting.TimeOfDay = 12

function onUpdate(dt)
    lighting.TimeOfDay = lighting.TimeOfDay + dt * 0.1
    if lighting.TimeOfDay >= 24 then
        lighting.TimeOfDay = 0
    end

    local time = lighting.TimeOfDay
    if time > 6 and time < 18 then
        lighting.Brightness = 2
    else
        lighting.Brightness = 0.3
    end
end