CyberM.events

Runs inside the game process. Reads and presentation are local; anything that changes shared state has to go through the server.

client runtime3 functionsMarkdown

emit

SHARED

CyberM.events.emit(event, [payload])

Fires a local event.

Emits an event on the resource-local client bus and invokes matching local handlers. It never sends a packet; use the network event API for server communication.

Parameters

  • eventstringrequired
  • payloadtableoptional

Returns

  • boolean

Registered in ResourceHost.cpp as LuaTriggerEvent (line 6558).

off

SHARED

CyberM.events.off(event, handler)

Removes a handler registered with on.

Unregisters a local event handler id previously returned by on/AddEventHandler. Handler ids are owned by a resource generation and cannot remove another resource's callback.

Parameters

  • eventstringrequired
  • handlerfunctionrequired

Returns

  • boolean

Registered in ResourceHost.cpp as LuaRemoveEventHandler (line 6557).

on

SHARED

CyberM.events.on(event, handler)

Listens for a local event.

Same as the AddEventHandler global. Events emitted by the plugin — cyberm:pauseKey, cyberm:inspector:on — arrive here.

Parameters

  • eventstringrequired
  • handlerfunctionrequired

Returns

  • handler id

Registered in ResourceHost.cpp as LuaAddEventHandler (line 6556).

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