Jacob Schmidt 89169f1e84 Update documentation and add new client usage guides

- Revised README.md for the Forge Client Example Addon to clarify its purpose as a template.
- Enhanced MODULE_REFERENCE.md to categorize guides into Server and Extension guides and Client guides.
- Created detailed usage guides for various client addons including Actor, Bank, CAD, Garage, Locker, Notifications, Organization, Phone, and Store.
- Added a Client Common Usage Guide to outline shared browser UI bridge patterns.
- Introduced a Client Main Usage Guide to define the foundational elements for client addons.
- Established authoritative state notes and usage rules across new guides to ensure clarity on server ownership and client responsibilities.

2026-04-18 13:04:01 -05:00

1.0 KiB

Raw Blame History

Forge Client Actor

Overview

The actor addon owns the player interaction menu and client-side actor repository. It initializes actor state from the server, tracks client-visible actor fields, and routes menu actions to other Forge UIs.

Dependencies

forge_client_main
server actor events from forge_server_actor
runtime integrations with bank, CAD, garage, org, phone, store, locker, and notifications addons

Main Components

fnc_initRepository.sqf manages client actor state and server init/save requests.
fnc_openUI.sqf opens RscActorMenu.
fnc_handleUIEvents.sqf handles browser menu actions.

Event Surface

The actor menu can open bank, ATM mode, CAD, garage, virtual garage, org, phone, store, and ACE arsenal interactions. Client post-init also wires player killed and respawn handlers into the server economy flow.

Runtime Notes

Actor state is loaded before dependent systems initialize. When the server sends actor sync data, the repository updates local view state and clears the loading screen.

1.0 KiB Raw Blame History