UgCore.Events

Shared Runs in your resource.

On

UgCore.Events.On(name, handler) -> id

string

required

Event name. Use UgCore.Enums.Events values for core events.

fun(...)

required

Called with the event arguments.

integer

Pass to Off to remove the handler.

ug-core:* events are dropped unless ug-core triggered them. Dropped events log at Debug.

Once

UgCore.Events.Once(name, handler) -> id

Like On, but the handler runs at most once. A dropped spoofed event does not use it up.

Off

UgCore.Events.Off(id) -> removed

boolean

false for unknown or already removed ids.

Emit

UgCore.Events.Emit(name, ...)

string

required

MUST start with your resource name, such as my-shop:Purchased. Raises otherwise.

Uses a local event: every resource on the same side receives it.

Example

local id = UgCore.Events.On(UgCore.Enums.Events.Lifecycle.Changed, function(newState, oldState)
    UgCore.Logger.Info('ug-core: %s -> %s', oldState, newState)
end)

UgCore.Events.Emit('my-shop:Opened', source)

See every core event in the Events reference.

Overview

Core

Networking and security

Modules

Reference

On

Once

Off

Emit

Example

​On

​Once

​Off

​Emit

​Example

On

Once

Off

Emit

Example