Official resource exports

Every client export published by the official OPEN//77 resource packages, with signatures per package and how to call them safely across resources.

4 min read850 wordsMarkdown

CyberM's native Lua API and resource exports are two separate surfaces. Native methods such as CyberM.vehicles.get are registered by the client or server runtime. The exports below are owned by official Lua resources and add lifecycle isolation, WebUI ownership, or higher-level behavior.

All exports on this page are client exports. Server-authoritative mutation remains in server scripts through the server Lua API, net events, or a package's documented server interface.

Calling an export

The portable cross-resource form is asynchronous:

local promise, reason = CyberM.exports.call("cyberm_notifications", "show", {
  type = "success",
  title = "Garage",
  message = "Vehicle stored."
})
if not promise then error(reason) end

local result = promise:await()
if not result.ok then print(result.error) end

The FiveM-style proxy is also available in a client resource:

exports.cyberm_chat:addMessage({ author = "SYSTEM", message = "Ready" })

Handles returned by UI packages are resource-owned. Another resource cannot update or dismiss them, and they are cleaned automatically when the owning generation stops or reloads.

Export catalogue

`cyberm_appearance`

Export	Signature	Result
`open`	`open(mode?)`	Requests the server-authorized appearance workflow.
`capture`	`capture()`	Current native appearance snapshot.
`isOpen`	`isOpen()`	Whether the appearance UI is active.
`revision`	`revision()`	Last canonical appearance revision.
`characterKey`	`characterKey()`	Durable character key associated with the synchronized appearance.

See the package README at resources/cyberm_appearance/README.md for the transaction lifecycle.

`cyberm_chat`

Export	Signature	Result
`addMessage`	`addMessage(message)`	Adds one structured message to the local chat UI.
`clear`	`clear()`	Clears visible messages.
`addSuggestion`	`addSuggestion(command, help, parameters?)`	Adds or replaces slash-command completion metadata.
`removeSuggestion`	`removeSuggestion(command)`	Removes one completion entry.
`setEnabled`	`setEnabled(enabled)`	Enables/disables chat for the calling resource context.
`isEnabled`	`isEnabled()`	Returns the current enable state.

Message and suggestion schemas are documented in Chat.

`cyberm_death`

Export	Signature	Result
`isDead`	`isDead(playerId?)`	Canonical death state for the local or selected player.
`getState`	`getState(playerId?)`	Canonical life-state snapshot.
`getLocalDeathContext`	`getLocalDeathContext()`	Local death context, with the last package snapshot as fallback.
`all`	`all()`	All currently known player life states.

`cyberm_effects`

Export	Signature	Result
`playVfx`	`playVfx(effect, options?)`	Starts a world VFX owned by the caller.
`playEntityVfx`	`playEntityVfx(effect, options?)`	Starts an entity-attached VFX.
`playSfx`	`playSfx(event, options?)`	Starts an SFX event, optionally spatialized or attached.
`stop`	`stop(handle)`	Stops a caller-owned effect handle.
`catalog`	`catalog()`	Returns the runtime effect catalogue.

See Visual and audio effects and Game data reference.

`cyberm_elevators`

Export	Signature	Result
`get`	`get(id)`	One streamed authoritative elevator snapshot.
`all`	`all()`	All streamed elevator snapshots.
`requestFloor`	`requestFloor(id, floor)`	Requests a `goto` action.
`requestCall`	`requestCall(id, floor)`	Requests a `call` action.

See Elevators. Elevator IDs are opaque even though this compatibility package currently normalizes them before calling the native API.

`cyberm_interactions`

Export	Signature	Result
`create`	`create(definition)`	Creates a caller-owned contextual interaction and returns its handle.
`update`	`update(handle, patch)`	Applies a partial update.
`remove`	`remove(handle)`	Removes one caller-owned interaction.
`setVisible`	`setVisible(handle, visible)`	Convenience visibility update.
`get`	`get(handle)`	Snapshot of one caller-owned interaction.
`all`	`all()`	Snapshots of every interaction owned by the caller.
`clear`	`clear()`	Removes all caller-owned interactions.
`setEnabled`	`setEnabled(enabled)`	Enables/disables rendering and input for the caller.
`isEnabled`	`isEnabled()`	Returns the caller enable state.

Definitions, marker types, choices, distances, entity attachment, and responses are documented in Contextual interactions.

`cyberm_loot`

Export	Signature	Result
`get`	`get(id)`	One streamed canonical loot drop.
`all`	`all()`	Copy of all streamed drops.
`requestPickup`	`requestPickup(id)`	Submits a bounded pickup request to the server.

See Loot. Clients cannot create or award authoritative loot.

`cyberm_markers`

Export	Signature	Result
`create`	`create(definition)`	Creates a native marker and returns its ID.
`update`	`update(id, patch)`	Updates mutable marker fields.
`remove`	`remove(id)`	Removes one marker.
`clear`	`clear()`	Removes resource-owned markers.
`list`	`list()`	Lists current resource-owned markers.

The lower-level method schema is in the generated CyberM.markers.* reference.

`cyberm_nameplates`

Export	Signature	Result
`setEnabled`	`setEnabled(enabled)`	Enables/disables caller-owned overrides.
`isEnabled`	`isEnabled()`	Current enable state.
`set`	`set(playerId, options)`	Sets a nameplate override for one player.
`remove`	`remove(playerId)`	Removes one override.
`clear`	`clear()`	Removes every caller-owned override.

`cyberm_notifications`

Export	Signature	Result
`show`	`show(definition)`	Displays a caller-owned notification and returns its handle.
`update`	`update(handle, patch)`	Updates a visible or queued notification.
`dismiss`	`dismiss(handle)`	Dismisses one caller-owned notification.
`clear`	`clear()`	Dismisses every caller-owned notification.
`list`	`list()`	Snapshots of caller-owned notifications.
`setEnabled`	`setEnabled(enabled)`	Enables/disables notifications for the caller. Disabling also clears them.
`isEnabled`	`isEnabled()`	Returns the caller enable state.

See Notifications for types, positions, duration, progress, actions, replacement, and the server-to-client envelope.

`cyberm_vehicles`

Export	Signature	Result
`get`	`get(id)`	One streamed canonical vehicle snapshot.
`all`	`all()`	All streamed canonical vehicle snapshots.

See Vehicles for server mutation and native presentation methods.

`cyberm_weather`

Export	Signature	Result
`isReady`	`isReady()`	Whether the first authoritative environment snapshot arrived.
`requestSync`	`requestSync()`	Requests an immediate resynchronization.
`getState`	`getState()`	Projected server time and canonical weather state.

See Weather. This package intentionally exposes no client mutation command.

`cyberm_example`

Export	Signature	Result
`hello`	`hello(name?)`	Minimal export example used by the starter package.

This export is instructional and should not be used as a production dependency.

Audit status

This catalogue is generated from every literal exports("name", ...) declaration under the official resources/ tree. It currently covers 59 exports across 13 packages. Dynamic exports are intentionally discouraged because they cannot be audited or completed reliably by tooling.

For agents and LLMs: this page as Markdown · llms.txt · llms-full.txt

Calling an export#

Export catalogue#

cyberm_appearance#

cyberm_chat#

cyberm_death#

cyberm_effects#

cyberm_elevators#

cyberm_interactions#

cyberm_loot#

cyberm_markers#

cyberm_nameplates#

cyberm_notifications#

cyberm_vehicles#

cyberm_weather#

cyberm_example#

Audit status#