Skip to content

Scriptum Built-in Commands Editor REPL

Scriptum includes a rich set of built-in commands available in both REPL Mode and Editor Mode. These commands let you bind objects, inspect data, log output, manipulate preferences, and more without leaving the console.

You can call them like regular methods inside your scripts, spells, or even directly in REPL input.

They are designed for quick debugging, rapid data manipulation, and context-aware automation across your development sessions.

Each command is mode-aware: some work only in REPL, some in Editor, and others in both. Invalid usage will trigger an error message automatically.

Available Commands

Command Signature(s) Description Mode
bind bind(obj), bind(obj, "name") Binds a value to a named live variable for reuse via @name. Both
alias alias(obj, "newName") Renames an existing live variable. Both
unbind unbind(@myVar) Removes a live variable from the registry. Both
clearvars clearvars() Removes all bound live variables from the session. REPL
echo echo(value), echo(value, true) Displays a quick overview or deep inspection of a value. REPL
manifest manifest(value) Inspects a value with reflection, including all fields, props, and hierarchy. Editor
clear clear() Clears the current REPL output. REPL
export export(), export("path.txt") Saves the REPL output log to file. REPL
refresh refresh() Recompiles session classes and refreshes context. REPL
doc doc("commandName") Shows documentation for a specific built-in command. REPL
alert alert("message"), alert("msg", arg1), alert("msg", arg1, arg2) Shows a popup dialog. Both
notify notify("message"), notify("message", LogType) Displays a notification banner in Scriptum. Both
beep beep() Plays a notification sound. Both
pause pause() Pauses the Unity Editor. Both
resume resume() Resumes the Unity Editor. Both
usings usings() Displays all using directives available in the current session. REPL
history history() Shows your recent REPL input history. REPL
playerpref playerpref("key"), playerpref("key", value) Get or set a PlayerPref value. REPL
editorpref editorpref("key"), editorpref("key", value) Get or set an EditorPref value. REPL
saveobject saveobject(obj), saveobject(obj, "path.json") Serializes a value to JSON and writes it to file. REPL
help help() Shows a built-in help menu for Scriptum commands. REPL