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

2.5 KiB

Raw Blame History

Client Bank Usage Guide

The client bank addon opens the bank and ATM browser UI, forwards banking requests to the server bank addon, and pushes account updates back into the browser.

Open Bank UI

Open full bank mode:

call forge_client_bank_fnc_openUI;

Open ATM mode:

[true] call forge_client_bank_fnc_openUI;

The open function creates RscBank, sets the bridge mode to bank or atm, loads ui/_site/index.html, and routes browser events through forge_client_bank_fnc_handleUIEvents.

Bridge and Repository

forge_client_bank_fnc_initRepository tracks account load and cached account state.

forge_client_bank_fnc_initUIBridge owns:

active browser control tracking
bank/ATM mode
browser ready handling
account hydrate and sync responses
deposit, withdrawal, transfer, earnings deposit, credit repayment, and PIN requests
browser notice delivery

Browser Events

Event	Client behavior
`bank::ready`	Mark browser ready and request hydrate from the server.
`bank::refresh`	Request fresh bank hydrate data.
`bank::deposit::request`	Forward deposit amount to the server.
`bank::withdraw::request`	Forward withdrawal amount to the server.
`bank::transfer::request`	Forward target, source field, and amount.
`bank::depositEarnings::request`	Request earnings deposit.
`bank::repayCreditLine::request`	Request credit-line repayment.
`bank::pin::request`	Forward PIN validation request.
`bank::close`	Dispose bridge screen state and close the display.

Browser Response Events

The bridge sends:

Event	Purpose
`bank::hydrate`	Full session/account payload.
`bank::sync`	Account patch or sync data.
`bank::notice`	UI-visible notice payload.

Request Flow

Example deposit flow:

Browser sends bank::deposit::request with an amount.
Client bridge calls the server bank request event.
Server bank addon validates the request and calls bank hot-state logic.
Server response is caught by the client post-init event handlers.
Client bridge sends bank::sync or bank::notice back to the browser.

Authoritative State

Balances, PIN authorization, transfers, checkout charges, credit lines, and persistence are server-owned. The client should only display account data and request mutations through server events.

2.5 KiB Raw Blame History