Jacob Schmidt cb69941884 chore: baseline v0.1.0

2026-05-23 09:23:12 -05:00

6.1 KiB

Raw Permalink Blame History

Client CAD Usage Guide

The client CAD addon provides the map and dispatch UI for groups, active tasks, task assignment, dispatch orders, support requests, and task acknowledge/decline workflows.

Open CAD UI

call forge_client_cad_fnc_openUI;

The CAD UI opens RscMapUI and loads separate browser controls for:

top bar
bottom bar
side panel
dispatcher board

The native Arma map remains part of the same display.

Repository and Bridge

forge_client_cad_fnc_initRepository caches the hydrated CAD payload, selected mode, dispatch view, session data, groups, tasks, requests, and assignments.

forge_client_cad_fnc_initUIBridge owns:

ready state for side panel, top bar, and dispatcher board
operations vs dispatch mode
board vs map dispatch view
hydrate requests
task assignment, acknowledge, and decline requests
dispatch order create/close requests
support request submit/close requests
group status, role, and profile requests
map focus actions

Browser Events

<th>
  Client behavior
</th>

<td>
  Mark top bar ready and push top bar state.
</td>

<td>
  Mark side panel ready and request hydrate.
</td>

<td>
  Mark dispatcher board ready and push hydrate data.
</td>

<td>
  Switch between operations and dispatch mode.
</td>

<td>
  Switch dispatch board/map view.
</td>

<td>
  Request fresh CAD hydrate data.
</td>

<td>
  Assign a task to a group.
</td>

<td>
  Acknowledge assigned task.
</td>

<td>
  Decline assigned task.
</td>

<td>
  Create dispatch order.
</td>

<td>
  Close dispatch order.
</td>

<td>
  Submit support request.
</td>

<td>
  Close support request.
</td>

<td>
  Update group status.
</td>

<td>
  Update group role.
</td>

<td>
  Update status and role together.
</td>

<td>
  Center map on a group.
</td>

<td>
  Center map on a task.
</td>

<td>
  Center map on a support request.
</td>

<td>
  Zoom native map in.
</td>

<td>
  Zoom native map out.
</td>

<td>
  Placeholder status update.
</td>

<td>
  Dispose bridge state and close the display.
</td>

Event
`cad::topbar::ready`
`cad::ready`
`cad::dispatcher::ready`
`cad::mode::set`
`cad::dispatchView::set`
`cad::refresh`
`cad::tasks::assign`
`cad::tasks::acknowledge`
`cad::tasks::decline`
`cad::dispatchOrder::create`
`cad::dispatchOrder::close`
`cad::supportRequest::submit`
`cad::supportRequest::close`
`cad::groups::status`
`cad::groups::role`
`cad::groups::profile`
`cad::groups::focus`
`cad::tasks::focus`
`cad::requests::focus`
`map::zoomIn`
`map::zoomOut`
`map::search`
`map::close`

Response Events

The bridge pushes:

<th>
  Purpose
</th>

<td>
  Full hydrated CAD payload to the side panel.
</td>

<td>
  Task assignment/acknowledge/decline result.
</td>

<td>
  Group status/role/profile result.
</td>

<td>
  Support request result.
</td>

Event
`cad::hydrate`
`cad::assignment::response`
`cad::group::response`
`cad::request::response`

Dispatcher board controls also receive direct ExecJS status and hydrate calls.

Task Compatibility

CAD task visibility depends on server-side task catalog entries. Tasks created through Eden Forge task modules or forge_server_task_fnc_startTask are the normal CAD-compatible task sources because they register task catalog data.

Direct handler or task-function calls only work with CAD when the task catalog entry already exists.

Authorization Notes

Only dispatcher sessions can enter dispatch mode. If the hydrated session is not a dispatcher, the bridge forces the UI back to operations mode.

6.1 KiB Raw Permalink Blame History