delegates.subscribe

Observes matching Unreal UFunction calls with a Lua callback.

Syntax

ue.delegates.subscribe(target: UObjectProxy?, function_name: string, callback: function) -> integer

Parameters

ParameterTypeDescription
targetUObjectProxy?Object to observe, or nil for any object.
function_namestringReceiving UFunction or event name.
callbackfunction(sender, params)Called after Unreal executes the function.

Returns

TypeDescription
integerSubscription ID.

Example

local id = ue.delegates.subscribe(
    player,
    "ReceiveAnyDamage",
    function(sender, params)
        print(params.Damage)
    end
)

Notes

  • Callbacks are read-only observers.
  • Off-game-thread events are ignored.
  • Keep nil target subscriptions narrowly filtered.

On this page