UgCore.Hooks

Server Proxied to ug-core. See the Hooks guide and the Hooks reference.

Register

UgCore.Hooks.Register(name, handler, options?) -> id

UgHookName

required

A value of UgCore.Enums.Hooks, such as 'Accounts:BeforeRemove'.

fun(payload): boolean | table | nil

required

Return false to cancel. Return a table to replace the payload for the next handlers. Return nothing to let it pass.

integer

Lower runs first. Defaults to 0.

integer

Pass to Unregister.

Hooks of a resource are removed when it stops. A failing handler is logged and skipped.

Unregister

UgCore.Hooks.Unregister(id) -> removed

Example

UgCore.Hooks.Register(UgCore.Enums.Hooks.Accounts.BeforeRemove, function(payload)
    if payload.account == 'bank' and payload.amount > 100000 then
        return false
    end
end, { priority = 10 })

Your handler gets a copy of the payload. Return the changed table so ug-core sees your changes.

⌘I

Overview

Core

Networking and security

Modules

Reference

Register

Unregister

Example

​Register

​Unregister

​Example

Register

Unregister

Example