Jacob Schmidt
ff7ff0c4e5
## Summary This finishes the org credit line workflow so it behaves like reserved treasury-backed credit instead of a simple member allowance. ## What changed - reserve org funds immediately when a credit line is assigned - track credit lines with: - approved amount - available amount - outstanding principal - interest rate - amount due - consume reserved credit during store checkout without charging org funds a second time - add credit line repayment through the bank app - sync richer credit line state into org and bank payloads/UI - keep legacy `amount` compatibility mapped to available credit for older consumers ## User-facing behavior - assigning a credit line now reduces available org funds immediately - spending on `credit_line` reduces available credit and creates debt with interest - the bank app now shows outstanding credit debt and allows repayment from personal bank funds - the org treasury view now shows reserved credit and outstanding due totals ## Validation - `cargo fmt` - `npm run build:webui` - `cargo test -p forge-services --quiet` - `cargo test -p forge-server --quiet` ## Follow-up checks - validate in-game that assigning a credit line reduces org funds immediately - validate store checkout with `credit_line` updates available credit and debt correctly - validate bank repayment decreases player bank balance, increases org funds, and reduces amount due Co-authored-by: Jacob Schmidt <innovativestudios@outlook.com> Reviewed-on: #2
105 lines
3.6 KiB
Markdown
105 lines
3.6 KiB
Markdown
# Forge Task Module
|
|
|
|
## Overview
|
|
The task addon is a server-owned mission/task system for Forge. It manages task execution, task-owned state, participant tracking, contribution-based player earnings, and org-owned rewards.
|
|
|
|
## Responsibilities
|
|
- spawn and monitor task flows on the server
|
|
- track per-task entities through `TaskStore`
|
|
- track task participants and engine-rating contribution
|
|
- award player earnings through the bank module
|
|
- award org funds, reputation, assets, and fleet rewards
|
|
- notify task participants and sync org updates to online members
|
|
|
|
## Dependencies
|
|
- `forge_server_common`
|
|
- `forge_server_actor`
|
|
- `forge_server_bank`
|
|
- `forge_server_org`
|
|
- `forge_client_notifications`
|
|
|
|
## Main Components
|
|
|
|
### Task Flows
|
|
- `fnc_attack.sqf`
|
|
- `fnc_defend.sqf`
|
|
- `fnc_defuse.sqf`
|
|
- `fnc_delivery.sqf`
|
|
- `fnc_destroy.sqf`
|
|
- `fnc_hostage.sqf`
|
|
- `fnc_hvt.sqf`
|
|
|
|
### TaskStore
|
|
`fnc_initTaskStore.sqf` initializes `TaskStore`, which owns:
|
|
- task ownership bindings
|
|
- participant snapshots
|
|
- defuse progress
|
|
- per-task entity registries for cargo, hostages, HVTs, IEDs, protected entities, shooters, and targets
|
|
|
|
### Reward Handling
|
|
`fnc_handleTaskRewards.sqf` applies org-owned rewards:
|
|
- `funds` -> org funds
|
|
- `equipment`, `supplies`, `weapons`, `special` -> org assets
|
|
- `vehicles` -> org fleet
|
|
|
|
Player `earnings` and org `reputation` from task outcomes are distributed separately through `TaskStore.applyRatingOutcome` using Arma engine `rating` deltas.
|
|
|
|
## Task Ownership
|
|
Tasks are bound to an owner org when they are started through `fnc_handler.sqf`.
|
|
|
|
- if a requester UID is provided, the task is owned by that requester's org
|
|
- if no requester UID is available, the task is bound to the `default` org
|
|
|
|
Org rewards always go to the bound owner org. Player earnings still use per-player contribution.
|
|
|
|
## Usage
|
|
|
|
### Start Through The Handler
|
|
Use the handler when you want reputation gating and task ownership binding.
|
|
|
|
```sqf
|
|
["attack", ["task_attack_1", 1, 2, 1500000, -75, 375, false, false], 250, getPlayerUID player] call forge_server_task_fnc_handler;
|
|
["delivery", ["task_delivery_1", 1, 3, "delivery_zone", 250000, -75, 300, false, false, 900], 0, getPlayerUID player] call forge_server_task_fnc_handler;
|
|
```
|
|
|
|
Arguments:
|
|
- `0`: task type
|
|
- `1`: task-specific argument array
|
|
- `2`: minimum org reputation required to start the task
|
|
- `3`: requester UID used for ownership binding
|
|
|
|
### Start Task Functions Directly
|
|
Direct task calls still work, but they do not provide a requester UID. That means task ownership falls back to the `default` org.
|
|
|
|
Use direct starts only when that behavior is intended, such as:
|
|
- mission-authored tasks
|
|
- editor-placed tasks
|
|
- server-owned/random tasks
|
|
|
|
If you want the accepting player's org to own the task rewards, use `fnc_handler.sqf` instead.
|
|
|
|
```sqf
|
|
["task_attack_1", 1, 2, 1500000, -75, 375, false, false] spawn forge_server_task_fnc_attack;
|
|
["task_hostage_1", 1, 2, "extract_marker", 1500000, -75, 500, [false, true], false, false] spawn forge_server_task_fnc_hostage;
|
|
```
|
|
|
|
## Event Hooks
|
|
- `XEH_preInit.sqf`
|
|
- compiles functions
|
|
- initializes `TaskStore`
|
|
- `XEH_postInit.sqf`
|
|
- registers the ACE defuse event hook
|
|
- starts the attack-only mission manager on the server
|
|
|
|
## Notes
|
|
- the dynamic mission manager in `fnc_missionManager.sqf` is now limited to attack missions only
|
|
- it starts server-owned tasks through `fnc_handler.sqf` and binds them to the `default` org
|
|
- task lifecycle for the mission manager is tracked through `TaskStore` status entries
|
|
- task rewards are org-owned, not player-owned
|
|
- participant notifications are sent through the notifications module, not through local server UI
|
|
|
|
## Authors
|
|
- J. Schmidt
|
|
- Creedcoder
|
|
- IDSolutions
|