Lua API
Lua API reference for Unreal Engine scripting in UnlockedEditor.
Use ue to find Unreal objects, call reflected functions, react to game events, bind input, build UMG interfaces, draw game overlays, call web APIs, capture microphone input, and play audio.
ue and unlocked are aliases. This reference documents API 2.8.0, shipped with runtime 4.0.1.
Quick start
local player = assert(ue.get_player_character())
ue.input.bind("F3", function()
player:Jump()
end)Scripts run in a sandboxed Lua 5.5 environment on the Unreal game thread. See Basics for the lifecycle callbacks and the runtime rules.
UObject and container proxies are weak references. Check :is_valid() before reusing one after map travel or object destruction.
Explore the API
Basics
Lifecycle, logging, and runtime information.
Objects
UObject discovery, reflection, player helpers, and live containers.
Actors
Find, inspect, modify, spawn, and destroy actors.
Components
Find, create, initialize, and destroy actor components.
Assets
Find or load Unreal assets.
Timers
One-shot and repeating callbacks.
Input
Keyboard and mouse chord bindings.
Delegates
Native delegate bindings and Lua event observers.
Widgets
Create and control Unreal UMG widgets.
Graphics
Draw overlays, debug visuals, and object ESPs.
Networking
Make asynchronous HTTP and HTTPS requests.
JSON
Encode request bodies and decode API responses.
Secrets
Read allowed environment keys.
Audio
Play WAVE and raw PCM audio.
Microphone
Record voice input as PCM WAVE data.