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.
29 lines
905 B
Markdown
29 lines
905 B
Markdown
# Forge Client Store
|
|
|
|
## Overview
|
|
The store addon provides the client storefront UI for catalog browsing,
|
|
category loading, payment-source display, cart handling, and checkout requests.
|
|
|
|
## Dependencies
|
|
- `forge_client_common`
|
|
- `forge_client_main`
|
|
- server store events from `forge_server_store`
|
|
- bank/org/locker/garage server state through checkout results
|
|
|
|
## Main Components
|
|
- `fnc_initUIBridge.sqf` handles browser readiness, category requests, checkout
|
|
requests, and server responses.
|
|
- `fnc_handleUIEvents.sqf` handles `store::*` browser events.
|
|
- `fnc_openUI.sqf` opens `RscStore`.
|
|
|
|
## Browser Events
|
|
- `store::ready`
|
|
- `store::category::request`
|
|
- `store::checkout::request`
|
|
- `store::close`
|
|
|
|
## Runtime Notes
|
|
The client never calculates authoritative checkout results. The server store
|
|
addon and extension validate prices, charge payment sources, grant assets, and
|
|
return patches for the UI.
|