Skip to content

docs: dark theme by default and fix custom event examples #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fank merged 1 commit into from
Mar 8, 2026
Merged

docs: dark theme by default and fix custom event examples #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions NaturalDocs.Project/Project.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

Title: OCAP2
Subtitle: Operations Capture and Playback
Style: OCAP2


# This is where you put general information about your project. None of these
Expand Down
3 changes: 3 additions & 0 deletions NaturalDocs.Project/Styles/OCAP2/Style.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Inherit: Default

Frame OnLoad: NDThemes.SetAvailableThemes([["Dark","Dark"],["Light","Light"],["Auto","Auto:Light/Dark"],["Black","Black"]])
17 changes: 1 addition & 16 deletions addons/recorder/fnc_addEventMission.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,22 +185,7 @@ if (isClass (configFile >> "CfgPatches" >> "ace_explosives")) then {
};


/*
CBA Event: OCAP_customEvent
Description:
Event listener for custom event text to be added to the timeline. Calls <OCAP_recorder_fnc_handleCustomEvent> when triggered.

Parameters:
0 - Event name [String]
1 - Event data [Array]
1.0 - Always "generalEvent" [String]
1.1 - Custom event text [String]

Example:
> ["OCAP_customEvent", ["generalEvent", "The warehouse has been secured!"]] call CBA_fnc_serverEvent;
> [QGVARMAIN(customEvent), ["generalEvent", "The warehouse has been secured!"]] call CBA_fnc_serverEvent;

*/
// See <OCAP_recorder_fnc_handleCustomEvent> for usage and examples
if (isNil QEGVAR(listener,customEvent)) then {
EGVAR(listener,customEvent) = [QGVARMAIN(customEvent), {
_this call FUNC(handleCustomEvent);
Expand Down
22 changes: 17 additions & 5 deletions addons/recorder/fnc_handleCustomEvent.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,27 @@
true

Examples:
These examples use the expanded event name "OCAP_customEvent" so they can be
called from user-defined mission scripts without requiring the CBA macros.

(start code)
// Sector captured with structured data (sent by fnc_trackSectors)
[QGVARMAIN(customEvent), ["captured", ["sector", "Sector Alpha", str west, getPosASL _sector]]] call CBA_fnc_localEvent;
// Sector captured with structured data
["OCAP_customEvent", ["captured", ["sector", "Sector Alpha", str west, getPosASL _sector]]] call CBA_fnc_localEvent;

// Sector contested (no owning side)
["OCAP_customEvent", ["contested", ["sector", "Sector Alpha", "", getPosASL _sector]]] call CBA_fnc_localEvent;

// End mission with side and message
[QGVARMAIN(customEvent), ["endMission", [str west, "BLUFOR controlled all sectors!"]]] call CBA_fnc_localEvent;
["OCAP_customEvent", ["endMission", [str west, "BLUFOR controlled all sectors!"]]] call CBA_fnc_localEvent;

// End mission with just a message (no side)
["OCAP_customEvent", ["endMission", "Mission complete!"]] call CBA_fnc_localEvent;

// Generic event — any unrecognized event name goes through the general handler
["OCAP_customEvent", ["generalEvent", "Some event text"]] call CBA_fnc_serverEvent;

// Generic event with optional extra data
[QGVARMAIN(customEvent), ["generalEvent", "Some event text"]] call CBA_fnc_serverEvent;
// Custom event name — works the same as generalEvent via the default handler
["OCAP_customEvent", ["myCustomEvent", "Player reached the extraction zone"]] call CBA_fnc_serverEvent;
(end code)

Public:
Expand Down