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.
34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
# Forge Client Organization
|
|
|
|
## Overview
|
|
The organization addon provides the client organization portal UI and bridge for
|
|
organization hydrate, registration, membership, invitations, credit lines,
|
|
leave/disband actions, assets, fleet, and treasury display.
|
|
|
|
## Dependencies
|
|
- `forge_client_common`
|
|
- `forge_client_main`
|
|
- server organization events from `forge_server_org`
|
|
- notifications for user feedback
|
|
|
|
## Main Components
|
|
- `fnc_initRepository.sqf` caches organization portal state.
|
|
- `fnc_initUIBridge.sqf` sends browser requests to server org RPCs and pushes
|
|
hydrate/sync events back to the browser.
|
|
- `fnc_handleUIEvents.sqf` handles `org::*` browser events.
|
|
- `fnc_openUI.sqf` opens `RscOrg`.
|
|
|
|
## Browser Events
|
|
- `org::login::request`
|
|
- `org::create::request`
|
|
- `org::disband::request`
|
|
- `org::leave::request`
|
|
- `org::credit::request`
|
|
- `org::invite::request`
|
|
- `org::invite::accept`
|
|
- `org::invite::decline`
|
|
|
|
## Runtime Notes
|
|
The client portal is a view/controller. Organization state, funds, reputation,
|
|
credit lines, assets, fleet, and membership are authoritative on the server.
|