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

28 lines
914 B
Markdown

# Forge Client Locker
## Overview
The locker addon manages client repositories for personal locker state and
virtual arsenal unlock state. It also integrates with ACE Arsenal display
behavior.
## Dependencies
- `forge_client_main`
- ACE Arsenal
- server locker events from `forge_server_locker`
## Main Components
- `fnc_initRepository.sqf` manages locker state, container open/close behavior,
and server sync requests.
- `fnc_initVARepository.sqf` manages virtual arsenal state.
## Runtime Behavior
- Requests locker and virtual arsenal state after actor load.
- Syncs server responses into client repositories.
- Sends locker override data to the server when a managed locker container is
closed.
- Hides selected ACE Arsenal controls when the arsenal display opens.
## Notes
The client repository is display/input state. The server locker addon and
extension own saved locker and virtual arsenal data.