IDSolutions/forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add CAD compatibility section to task module documentation

Browse Source
This commit is contained in:
Jacob Schmidt 2026-04-18 12:15:24 -05:00
parent 81baca90d3
commit 0cfaec86d0
2 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
arma/server/addons/task/README.md
View File

@ -75,6 +75,25 @@ Mission designers can create tasks in four ways:
The dynamic mission manager can also generate attack tasks from config. That is The dynamic mission manager can also generate attack tasks from config. That is
system-generated content rather than a hand-authored task creation path. system-generated content rather than a hand-authored task creation path.
### CAD Compatibility
CAD hydrates assignable tasks from `TaskStore.getActiveTaskCatalog`. A task must
have a catalog entry and active task status before CAD can show and assign it.
CAD-compatible creation paths:
- Eden modules: compatible because they delegate to `fnc_startTask.sqf`
- `fnc_startTask.sqf`: compatible because it registers the catalog entry,
creates the BIS task, and dispatches through `fnc_handler.sqf`
- dynamic mission manager attack tasks: compatible because the mission manager
uses `fnc_startTask.sqf`
Limited or incompatible paths:
- `fnc_handler.sqf`: only compatible if a catalog entry was already registered
elsewhere. The handler sets active status and ownership, but it does not
create the BIS task or upsert the catalog entry
- direct task function calls: not CAD-compatible by default. They bypass
`fnc_startTask.sqf` and usually do not register the task catalog entry or
active status that CAD hydrates from
### Create With Eden Modules ### Create With Eden Modules
Eden task modules are the normal designer-facing path. Place the module, Eden task modules are the normal designer-facing path. Place the module,
configure its attributes, and sync it to the relevant entities or grouping configure its attributes, and sync it to the relevant entities or grouping

23
docs/TASK_USAGE_GUIDE.md
View File

@ -140,6 +140,29 @@ Mission designers can create tasks in four ways:
The dynamic mission manager can also generate attack tasks from config. That is The dynamic mission manager can also generate attack tasks from config. That is
system-generated content rather than a hand-authored task creation path. system-generated content rather than a hand-authored task creation path.
## CAD Compatibility
CAD hydrates assignable tasks from `TaskStore.getActiveTaskCatalog`. A task must
have a catalog entry and active task status before CAD can show and assign it.
CAD-compatible creation paths:
- Eden modules: compatible because they delegate to
`forge_server_task_fnc_startTask`.
- `forge_server_task_fnc_startTask`: compatible because it registers the
catalog entry, creates the BIS task, and dispatches through the handler.
- Dynamic mission manager attack tasks: compatible because the mission manager
uses `forge_server_task_fnc_startTask`.
Limited or incompatible paths:
- `forge_server_task_fnc_handler`: only compatible if a catalog entry was
already registered elsewhere. The handler sets active status and ownership,
but it does not create the BIS task or upsert the catalog entry.
- Direct task function calls: not CAD-compatible by default. They bypass
`startTask` and usually do not register the task catalog entry or active
status that CAD hydrates from.
## Eden Modules ## Eden Modules
Eden task modules are the normal designer-facing path. Place the module, Eden task modules are the normal designer-facing path. Place the module,