Jacob Schmidt 9d789440e0 Enhance documentation and functionality across various server addons
- Updated README.md files for extension, garage, locker, main, organization, phone, store, and task addons to provide clearer overviews, dependencies, main components, and usage notes.
- Improved task module documentation to clarify timer semantics and server task flows, ensuring accurate usage of time limits.
- Adjusted default values for task time limits and IED timers to enforce positive countdown requirements.
- Added new CAD addon for dispatch coordination, including its overview, dependencies, main components, and event handling.
2026-04-18 11:55:19 -05:00

1.2 KiB

Forge Server Actor

Overview

The actor addon is the server-side bridge for player identity and character state. It keeps Arma-facing actor snapshots in SQF while durable and hot actor state are owned by the Rust extension.

Actor records include UID, name, loadout, position, direction, stance, rank, life state, phone number, email, organization, and holster state.

Dependencies

  • forge_server_main
  • forge_server_common
  • forge_server_extension at runtime for actor extension calls
  • forge_client_actor for response RPCs

Main Components

  • fnc_initActorStore.sqf initializes ActorModel and ActorStore.
  • ActorModel provides defaults, player snapshot conversion, migration, and validation.
  • ActorStore wraps extension hot-state calls and exposes event-facing actor operations.

Runtime Behavior

  • Missing persistent actors can be created from live player snapshots.
  • Hot actor reads are migrated and hydrated before use.
  • saveHotState in the main addon snapshots and saves actor state on player disconnect and mission end.

Event Surface

The addon handles server events for actor init, get, set, multi-set, save, and remove requests, then replies to the requesting player through client actor RPCs.