UObjectProxy

Weak proxy for a reflected Unreal UObject.

UObject values are exposed as weak proxies. They do not keep Unreal objects alive.

Methods

MethodDescription
:is_valid()Whether the Unreal object still exists.
:name()Object name.
:path()Full object path.
:class()UClass as another UObjectProxy.
:get(property)Read a reflected property.
:set(property, value)Write a reflected property.
:call(function_name, params?)Call a UFunction with named parameters.
:properties()List reflected properties.
:functions()List reflected functions.
:help(function_name)Describe a UFunction signature.

Properties and functions

local player = assert(ue.actors.proxy("Player"))

if player:is_valid() then
    player.Health = player.Health + 25
    player:Jump()
end

Property access maps to :get and :set. Exact UFunctions use natural positional calls. Pure out parameters are returned after the UFunction return value.

Notes

  • Enum inputs accept short names, qualified names, or numeric values.
  • If a reflected member collides with a proxy method, use :get, :set, or :call.
  • Recheck :is_valid() after map travel or actor destruction.

On this page