LUX API documentation

Getting started

Every .lua file in the scripts folder is loaded when you type /reload in game. Protected rotations you bought from us are .luxr files and go in the same folder.

C:\Users\Public\LUX\scripts

• The launcher has an Open scripts folder link that opens it.
• There is no entry file and nothing to register by name. Put a .lua file in the folder and type /reload.
• To start, copy example_rotation.lua into the folder, edit it and type /reload. The full example is at the end of this page.
• One file per job is a good habit: spell data in one file, a rotation in another.

Take a local copy at the top of each file: local API = LUX.API. Spell arguments are spell ids or names. Unit arguments are standard unit tokens such as "target", "player" or "focus". If you leave the unit out, "target" is used unless stated otherwise.

Reading the game

Distance and facing

These need LUX's object information. When it is not available they return nil, false or an empty list, so always handle that case.

Turning the character and choosing targets are options the player can switch on in the General tab. A rotation does not need to do it. If it wants facing while it runs, it calls API.RequestFacing() inside Run().

Actions

Always cast through API.Cast. Calling game functions to cast directly will not work.

Registering a rotation

API.RegisterRotation({
    name  = "my_rotation",   -- unique name
    class = "ROGUE",         -- class token
    spec  = 1,               -- spec index, or nil for any spec
    Run   = function() ... end,
})

• Run is called many times per second while the rotation is on. Keep it light: check, decide, cast once, return.
• An exact spec wins over nil. The General tab has a switch button when two rotations match.
• An optional Mounted = function() ... end is called instead of Run while the player is mounted.

Options

Options appear as a tab for the matching class in the /lux window and are saved per character.

API.DefineOptions("my_rotation", "My Rotation", "ROGUE", {
    API.Section("Offense"),
    API.Check("MYuseCooldowns", "Use cooldowns", true),
    API.Slider("MYminEnergy", "Minimum energy", 40, 0, 100, 5),
    API.Cycle("MYopener", "Opener", 1, { { v = 1, t = "Ambush" }, { v = 2, t = "Cheap Shot" } }),
    API.Input("MYnote", "Note", ""),
    API.Text("Anything you want to tell the player."),
})

local energy = API.Option("MYminEnergy")   -- read it inside Run(), every time

• Builders: Check, Slider, Cycle, Input, Section, Text.
• API.Option(key) returns the live value. API.OnOptionChange(fn) is called with (key, value).
• Use a short unique prefix for your option keys so they never clash with other rotations.
• Read options inside Run() instead of storing them once, so changes apply immediately.

Logging and misc

The chat level is a setting on the General tab (quiet by default). /lux log [n] shows the last n log lines.

Complete example

A small combo-point rotation. Save it to script\user\ and list it in _user.lua.

local API = LUX.API

local SINISTER_STRIKE = "Sinister Strike"
local EVISCERATE      = "Eviscerate"

API.DefineOptions("example_rogue", "Example", "ROGUE", {
    API.Section("Finishers"),
    API.Check("EXfinisher", "Use finishers", true),
    API.Slider("EXminCP", "Minimum combo points for a finisher", 5, 3, 7, 1),
})

local ptype = Enum.PowerType

local function Run()
    if not API.Exists("target") or not API.IsEnemy("target") or API.IsDead("target") then return end
    if API.GCD() > 0 or API.Casting() then return end

    local cp = API.Power(ptype.ComboPoints) or 0

    if API.Option("EXfinisher") and cp >= API.Option("EXminCP") and API.Usable(EVISCERATE) then
        API.Cast(EVISCERATE, "target")
        return
    end

    if API.Usable(SINISTER_STRIKE) then
        API.Cast(SINISTER_STRIKE, "target")
    end
end

API.RegisterRotation({ name = "example_rogue", class = "ROGUE", spec = nil, Run = Run })

Tips and troubleshooting

• Check cheap conditions first (target, GCD, casting), then decide, then cast once and return.
• Use API.GCD(), API.Cooldown() and API.Usable() as gates so you do not cast the same spell every tick.
• Use API.LogOnce inside Run(); a plain API.Log repeats every tick.
• Spell ids are safer than names when a spell has several ranks or translations.
• A broken script shows in chat as [LUX] [LUX-SCRIPT] pack/<file>.lua: syntax error: <message>(a typo in the file) or runtime error: <message> (it failed while running). Fix the file and type /reload. Protected rotations show rotation in place of the file name.
• The rotation never casts: it is not switched on, no rotation matches your class and spec, or the target does not pass your guards.