89169f1e84
- 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.
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
# Forge Client Garage
|
|
|
|
## Overview
|
|
The garage addon provides player vehicle storage UI, vehicle store/retrieve
|
|
actions, and virtual garage state on the client.
|
|
|
|
## Dependencies
|
|
- `forge_client_common`
|
|
- `forge_client_main`
|
|
- server garage events from `forge_server_garage`
|
|
- notifications for action feedback
|
|
|
|
## Main Components
|
|
- `fnc_initRepository.sqf` manages player garage view state.
|
|
- `fnc_initVGRepository.sqf` manages virtual garage view state.
|
|
- `fnc_initHelperService.sqf` resolves vehicle names, hit points, and payload
|
|
details.
|
|
- `fnc_initContextService.sqf` gathers nearby/current vehicle context.
|
|
- `fnc_initPayloadService.sqf` builds browser hydrate payloads.
|
|
- `fnc_initActionService.sqf` sends store/retrieve requests and handles action
|
|
responses.
|
|
- `fnc_initUIBridge.sqf` pushes hydrate/sync events to the browser.
|
|
- `fnc_openUI.sqf` opens `RscGarage`.
|
|
- `fnc_openVG.sqf` opens the Arma garage-style virtual garage view.
|
|
|
|
## Browser Events
|
|
- `garage::ready`
|
|
- `garage::refresh`
|
|
- `garage::vehicle::retrieve::request`
|
|
- `garage::vehicle::store::request`
|
|
- `garage::close`
|
|
|
|
## Runtime Notes
|
|
The client builds vehicle context and sends requests. The server garage addon
|
|
and extension own stored vehicle state.
|