Engine

The Engine provides three global logging helpers available in every Lua script. Each of them targets a different part of the UI and is intended for a different use-case.


log(message: string)

Send a standard UI log message (top-left overlay).

Syntax

log("message")

Description

Adds a styled notification log to the engine’s top-left UI log feed. These logs appear with the same formatting as other engine notifications (fade-out timers, colors, etc.).

Use this for:

  • Showing player/script status

  • Informative messages the user should see

  • Non-spammy logs meant for gameplay HUD

Parameters

Name
Type
Description

message

string

The text that appears in the UI log panel.

Examples

log("Script initialized.")
log("Speed boost activated!")

Overlay Output

[LUA] Script initialized.
[LUA] Speed boost activated!

log_error(message: string)

Send an error message to the UI log panel.

Syntax

log_error("message")

Description

Same as log(), but marked as an error, shown with an error style, prefixing the message with [LUA][ERR].

Use this for:

  • Script mistakes

  • Missing data

  • Important failures that should be visible to users

Parameters

Name
Type
Description

message

string

Error text to show in the UI log feed.

Examples

log_error("Failed to load config!")
log_error("Invalid teleport target!")

Overlay Output

[LUA][ERR] Failed to load config!
[LUA][ERR] Invalid teleport target!

log_console(message: string)

Append text to the debug console (persistent until cleared).

Syntax

log_console("message")

Description

Writes text directly into the script debugging console, where messages accumulate continuously. This console is separate from the UI log panel and is intended purely for development and live debugging.

Use this for:

  • Repeated updates inside loops

  • Value tracing

  • Spammy or high-frequency debug output

  • Printing raw data structures

  • Debug logs you don’t want appearing in the UI overlay

Unlike log() and log_error(), console output does not fade or disappear — it continues to append until the user manually clears the console.

Parameters

Name
Type
Description

message

string

Text to append to the debug console.

Examples

log_console("Tick: " .. tick)
log_console("Entity pos = " .. tostring(vec))

Console Output

[LUA] Tick: 4521
[LUA] Entity pos = (1024, 88, 12)

Notes

  • Best for development/debug use.

  • Not shown in the UI overlay.

  • Does not fade; accumulates until cleared.

  • Perfect for live script debugging.

Last updated