CyberM.session

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

client runtime3 functionsMarkdown

CyberM.session.loadPristine()

Loads the local development world from CyberM's bundled pristine save.

No network session is armed by this operation.

Returns

  • true on success, otherwise false
  • reason

Registered in ResourceHost.cpp as LuaSessionLoadPristine (line 6596).

CyberM.session.openSettings()

Opens the game's own settings screen without exposing the pause menu.

Requests the client-side CyberM settings interface. It only changes local presentation and does not modify server configuration or another player's settings.

Returns

  • true on success, otherwise false
  • reason

Registered in ResourceHost.cpp as LuaSessionOpenSettings (line 6595).

CyberM.session.setMenuReady(ready)

Declares that this resource is able to serve the pause menu.

The escape key is only intercepted while this is true. A resource that fails to start therefore leaves the game's own menu reachable, rather than stranding the player with none.

Parameters

  • readybooleanrequired

Returns

  • boolean

Registered in ResourceHost.cpp as LuaSessionMenuReady (line 6597).

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