fivem.shared.core

..
CallbackProtocol

The wire protocol shared by fivem.client.core.Callbacks and fivem.server.core.Callbacks.

Commands

Console and chat commands, with arguments delivered as a real Haxe Array<String> rather than a raw Lua table.

Deferred

A typed wrapper over FiveM's Lua promises, for turning callback-style APIs into blocking, straight-line code.

EventSubscription

A detachable event handler. Hold onto one if the listener should ever stop firing — otherwise ignore the return value.

Events

FiveM's event bus, with the two-step registration collapsed into one call.

Exports

Resource exports — the supported way for resources written in different languages to call into each other.

Kvp

The resource key/value store — FiveM's built-in persistence.

Resource

Information about the running resource and its neighbours, plus the start/stop lifecycle hooks every resource ends up needing.

ResourceState

The lifecycle states FXServer reports for a resource.

StateBag

A handle to one FiveM state bag, addressed by its bag name.

Thread

Threads, waits and timers, wrapped around FiveM's Citizen scheduler.

TimerHandle

A cancellable handle returned by Thread.setTimeout, Thread.setInterval and Thread.everyFrame.