Skip to content

General - Various header cleanup #1797

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

Open
PabstMirror wants to merge 4 commits into
base: master
Choose a base branch
from
Open

General - Various header cleanup #1797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17278f0
General - Various header cleanup
PabstMirror Dec 15, 2025
b2052fc
Merge branch 'master' into headers2
PabstMirror Dec 19, 2025
6f5c5e6
Merge branch 'master' into headers2
PabstMirror Dec 27, 2025
f3dc21b
Update project.toml
PabstMirror Jan 2, 2026
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
8 changes: 0 additions & 8 deletions .hemtt/project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,6 @@ include = [
[version]
git_hash = 0

# Unused in HEMTT v1.11 or higher, kept for backwards compatibility
[asc]
enabled = true
exclude = [
".inc.sqf",
"/test_"
]

[hemtt.config]
preset = "Hemtt"

Expand Down
2 changes: 1 addition & 1 deletion addons/arrays/fnc_standardDeviation.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Description:

Parameters:
_numbers - The array from which the standard deviation is computed <ARRAY>
_ddof - The delta degrees of freedom [optional] <SCALAR> (default: 0)
_ddof - The delta degrees of freedom (optional) <SCALAR> (default: 0)
_ddof = 0 - Population standard deviation
_ddof = 1 - Sample standard deviation

Expand Down
2 changes: 1 addition & 1 deletion addons/common/fnc_attachToBone.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Description:

Parameters:
_child - Child object to be attached to parent <OBJECT>
_parent - Parent object to which child will be attached <STRING>
_parent - Parent object to which child will be attached <OBJECT>
_bone - Bone name <STRING>
_matchOrientation - Orientation <BOOLEAN> (Default: true) True: match bone orientation, False: maintain relative orientation
_lod - LOD in which to check for bone <NUMBER><STRING> (Default: 1e15 for Memory LOD)
Expand Down
4 changes: 2 additions & 2 deletions addons/common/fnc_getNearest.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Description:
Parameters:
_position - <MARKER, OBJECT, LOCATION, GROUP, TASK or POSITION>
_array - <ARRAY> of <MARKER, OBJECT, LOCATION, GROUP, TASK and/or POSITION>
_radius - Maximum distance from _position <NUMBER>
_code - Condition to meet, object is stored in _x variable <CODE>
_radius - Maximum distance from _position <NUMBER> (default: infinity)
_code - Condition to meet, object is stored in _x variable <CODE> (default: no condition)

Example:
(begin example)
Expand Down
2 changes: 1 addition & 1 deletion addons/common/fnc_selectWeapon.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Description:
Parameters:
_unit - Unit object to perform function on. <OBJECT>
_weapon - Weapon or muzzle to select <STRING>
_mode - Weapon mode to switch to [optional] <STRING> (default: "")
_mode - Weapon mode to switch to (optional) <STRING> (default: "")

Returns:
Success or Failed <BOOLEAN>
Expand Down
2 changes: 1 addition & 1 deletion addons/common/test.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#define DEBUG_MODE_FULL
#include "script_component.hpp"

#define TESTS ["common", "config", "inventory", "weaponComponents", "position", "ret.inc", "macro_is_x"]
#define TESTS ["common", "config", "inventory", "weaponComponents", "position", "ret.inc", "macro_is_x.inc"]

SCRIPT(test-common);

Expand Down
0 addons/common/test_macro_is_x.sqf → addons/common/test_macro_is_x.inc.sqf
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions addons/diagnostic/fnc_error.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Description:
Parameters:
_prefix - Addon name (optional, defaut: "cba") <STRING>
_component - Component name (optional, default: "diagnostic") <STRING>
_title - Title of the error <STRING>
_message - Error message (use "\n" for newline) <STRING>
_file - Name of file <STRING>
_lineNum - Line of file <NUMBER>
_title - Title of the error (optional) <STRING>
_message - Error message (use "\n" for newline) (optional) <STRING>
_file - Name of file (optional) <STRING>
_lineNum - Line of file (optional) <NUMBER>

Returns:
nil
Expand Down
2 changes: 1 addition & 1 deletion addons/events/fnc_addBISPlayerEventHandler.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Parameters:
_key - Unique identifier for the event. <STRING>
_eventType - Type of event to add. Can be any event supported by addEventHandler. <STRING>
_eventCode - Code to run when event is raised. <CODE>
_ignoreVirtual - Ignore virtual units (spectators, virtual zeus, UAV RC) [optional] (default: true) <BOOLEAN>
_ignoreVirtual - Ignore virtual units (spectators, virtual zeus, UAV RC) (optional) (default: true) <BOOLEAN>

Returns:
Event was added <BOOLEAN>
Expand Down
8 changes: 4 additions & 4 deletions addons/events/fnc_addKeyHandler.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Parameters:
_key - Key (DIK-Code) to attach action to. <NUMBER>
_settings - Shift, Ctrl, Alt required. (default: [false, false, false]) <ARRAY>
_code - Code to execute upon event. <CODE>
_type - "keydown" or "keyup". [optional] (default: "keydown") <STRING>
_hashKey - Key handler identifier. Randomly generated if not supplied. [optional] <STRING>
_allowHold - Will the key fire every frame while hold down? [optional] (default: true) <BOOLEAN>
_holdDelay - How long after keydown will the key event fire, in seconds. [optional] <NUMBER>
_type - "keydown" or "keyup". (optional) (default: "keydown") <STRING>
_hashKey - Key handler identifier. Randomly generated if not supplied. (optional) <STRING>
_allowHold - Will the key fire every frame while hold down? (optional) (default: true) <BOOLEAN>
_holdDelay - How long after keydown will the key event fire, in seconds. (optional) <NUMBER>

Returns:
_hashKey - Key handler identifier. Used to remove or change the key handler. <STRING>
Expand Down
2 changes: 1 addition & 1 deletion addons/events/fnc_addKeyHandlerFromConfig.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Parameters:
_component - Classname under "CfgSettings" >> "CBA" >> "events" <STRING>
_action - Action name <STRING>
_code - Code to execute upon event. <CODE>
_type - "keydown" or "keyup". [optional] (default: "keydown") <STRING>
_type - "keydown" or "keyup". (optional) (default: "keydown") <STRING>

Returns:
_hashKey - Key handler identifier. Used to remove or change the key handler. <STRING>
Expand Down
2 changes: 1 addition & 1 deletion addons/events/fnc_changeKeyHandler.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Parameters:
_hashKey - Key handler identifier. <STRING>
_key - New key (DIK-Code). <NUMBER>
_settings - New Settings. Shift, Ctrl, Alt required. (default: [false, false, false]) <ARRAY>
_type - "keydown" or "keyup". [optional] (default: "keydown") <STRING>
_type - "keydown" or "keyup". (optional) (default: "keydown") <STRING>

Returns:
None
Expand Down
2 changes: 1 addition & 1 deletion addons/events/fnc_globalEventJIP.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Description:
Parameters:
_eventName - Type of event to publish. <STRING>
_params - Parameters to pass to the event handlers. <ANY>
_jipID - Unique event ID or object. [optional] (default: create unique id) <STRING, OBJECT>
_jipID - Unique event ID or object. (optional) (default: create unique id) <STRING, OBJECT>
STRING:
Unique, custom ID - can be used to remove or overwrite the event later.
OBJECT:
Expand Down
2 changes: 1 addition & 1 deletion addons/events/fnc_removeKeyHandler.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Description:

Parameters:
_hashKey - Key handler identifier. <STRING>
_type - "keydown" or "keyup". [optional] (default: "keydown") <STRING>
_type - "keydown" or "keyup". (optional) (default: "keydown") <STRING>

Returns:
None
Expand Down
2 changes: 1 addition & 1 deletion addons/jr/test.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

#include "script_component.hpp"

#define TESTS ["compatibleItems"]
#define TESTS ["compatibleItems.inc"]

SCRIPT(test-jr);

Expand Down
0 addons/jr/test_compatibleItems.sqf → addons/jr/test_compatibleItems.inc.sqf
View file
Open in desktop
File renamed without changes.
3 changes: 1 addition & 2 deletions addons/settings/fnc_export.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ Description:

Parameters:
_source - Can be "client", "mission" or "server" (optional, default: "client") <STRING>
_exportDefault - true: export all settings,
false: only changed settings (optional, default: false) <BOOL>
_exportDefault - true: export all settings, false: only changed settings (optional, default: false) <BOOL>

Returns:
Formatted setting info. <STRING>
Expand Down
2 changes: 1 addition & 1 deletion addons/ui/fnc_notify.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Description:
Display a text message. Multiple incoming messages are queued.

Parameters:
_content - Notifications content (lines). <ARRAY>
_content - Notifications content (lines). <ARRAY><STRING><NUMBER>
_line1 - First content line. <ARRAY>
_line2 - Second content line. <ARRAY>
...
Expand Down
6 changes: 3 additions & 3 deletions addons/xeh/fnc_addClassEventHandler.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Parameters:
0: _className - The classname of objects you wish to add the eventhandler too. Can be a base class. <STRING>
1: _eventName - The type of the eventhandler. E.g. "init", "fired", "killed" etc. <STRING>
2: _eventFunc - Function to execute when event happens. <CODE>
3: _allowInheritance - Allow event for objects that only inherit from the given classname? [optional] <BOOLEAN> (default: true)
4: _excludedClasses - Exclude these classes from this event including their children [optional] <ARRAY> (default: [])
5: _applyInitRetroactively - Apply "init" event type on existing units that have already been initilized. [optional] <BOOLEAN> ((default: false)
3: _allowInheritance - Allow event for objects that only inherit from the given classname? (optional) <BOOLEAN> (default: true)
4: _excludedClasses - Exclude these classes from this event including their children (optional) <ARRAY> (default: [])
5: _applyInitRetroactively - Apply "init" event type on existing units that have already been initilized. (optional) <BOOLEAN> ((default: false)

Returns:
_success - Whether adding the event was successful or not. <BOOLEAN>
Expand Down
8 changes: 4 additions & 4 deletions addons/xeh/fnc_supportMonitor.sqf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Description:
Iterate through all vehicle classes and find those who don't support extended event handlers.

Parameters:
0: _addAddonToOutput - false: simple list of classnames - true: include addon in output [optional] <BOOLEAN> (default: false)
1: _includeDuplicates - Include classes that inherit class EventHandlers? [optional] <BOOLEAN> (default: false)
2: _includeDisabled - Include classes that have XEH explicitly disabled? [optional] <BOOLEAN> (default: false)
3: _classFilter - Only include children of this class. "" to disable filter [optional] <STRING> (default: "")
0: _addAddonToOutput - false: simple list of classnames - true: include addon in output (optional) <BOOLEAN> (default: false)
1: _includeDuplicates - Include classes that inherit class EventHandlers? (optional) <BOOLEAN> (default: false)
2: _includeDisabled - Include classes that have XEH explicitly disabled? (optional) <BOOLEAN> (default: false)
3: _classFilter - Only include children of this class. "" to disable filter (optional) <STRING> (default: "")

Returns:
List of addons not supporting XEH <ARRAY>
Expand Down
Loading