forge/arma/server/docs/api-reference.md

1.4 KiB

Forge Server API Reference

The Forge server extension exposes domain-oriented commands through callExtension. Persistent data is stored through the configured SurrealDB connection and schema modules.

Core Commands

"forge_server" callExtension ["version", []];
"forge_server" callExtension ["status", []];
"forge_server" callExtension ["surreal:status", []];

status and surreal:status return initializing, connected, or failed.

Domain Commands

Game systems should call the domain APIs instead of raw database operations:

  • actor:*
  • bank:*
  • garage:*
  • locker:*
  • org:*
  • phone:*
  • store:*
  • task:*
  • cad:*
  • icom:*
  • owned:garage:*
  • owned:locker:*
  • transport:*

Large request and response payloads are routed through the transport layer when needed by forge_server_addons_extension_fnc_extCall.

Module Guides