Skip to content
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.

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

DoomMetal GUI Header and license adjustments #3333

Merged
merged 1 commit into from
Jul 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_adminTab.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles updating and controls on the Admin tab of the Main dialog.

Arguments:
Expand All @@ -17,6 +17,9 @@ Dependencies:

Example:
["update"] call A3A_fnc_adminTab;

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
17 changes: 10 additions & 7 deletions A3A/addons/gui/functions/GUI/fn_aiManagementTab.sqf
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
/*
Maintainer: DoomMetal
Handles updating and controls on the AI Management tab of the Main dialog.
Maintainer: Caleb Serafin, DoomMetal
Handles updating and controls on the AI Management tab of the Main dialog.

Arguments:
<STRING> Mode
<ARRAY<ANY>> Array of params for the mode when applicable. Params for specific modes are documented in the modes.
<STRING> Mode
<ARRAY<ANY>> Array of params for the mode when applicable. Params for specific modes are documented in the modes.

Return Value:
Nothing
Nothing

Scope: Clients, Local Arguments, Local Effect
Environment: Scheduled for control changes / Unscheduled for update
Public: No
Dependencies:
None
None

Example:
["update"] call FUNC(aiManagementTab);
["update"] call FUNC(aiManagementTab);

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_airSupportTab.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles updating and controls on the Air Support tab of the Main dialog.

Arguments:
Expand All @@ -17,6 +17,9 @@ Dependencies:

Example:
["update"] call FUNC(airSupportTab);

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
4 changes: 4 additions & 0 deletions A3A/addons/gui/functions/GUI/fn_arsenalLimitsDialog.sqf
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/*
Maintainer: Caleb Serafin, DoomMetal
Handles the initialization and updating of the arsenal guest limits dialog.

Arguments:
Expand All @@ -10,6 +11,9 @@ Returns:

Environment:
Should not be called by onLoad because findDisplay and ctrlParent do not work in that context.

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
9 changes: 8 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_buyVehicleDialog.sqf
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles the initialization and updating of the Buy Vehicle dialog.
This function should only be called from BuyVehicle onLoad and control activation EHs.

Arguments:
<STRING> Mode, only possible value for this dialog is "onLoad"
<ARRAY<ANY>> Array of params for the mode when applicable. Params for specific modes are documented in the modes.

Return Value:
Nothing

Scope: Clients, Local Arguments, Local Effect
Environment: Scheduled for onLoad mode / Unscheduled for everything else unless specified
Public: No
Dependencies:
None

Example:
["onLoad"] spawn A3A_GUI_fnc_buyVehicleDialog; // initialization

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_buyVehicleTabs.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal, killerswin2
Maintainer: Caleb Serafin, DoomMetal, killerswin2
Handles the initialization and updating of the Buy item dialog.
This function should only be called from Buyvehicle onLoad and control activation EHs.

Expand All @@ -18,6 +18,9 @@ Dependencies:

Example:
["logistics"] call A3A_GUI_fnc_buyVehicleTab;

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_commanderTab.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles updating and controls on the Commander tab of the Main dialog.

Arguments:
Expand All @@ -17,6 +17,9 @@ Dependencies:

Example:
["update"] call FUNC(commanderTab);

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_configColorToArray.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Converts colors defined in mission config to arrays usable in sqf.
From this:
{1,0,0,1}
Expand All @@ -23,6 +23,9 @@ Dependencies:
Example:
[A3A_COLOR_BLACK] call FUNC(configColorToArray); // [0,0,0,1]
[{0,0,0,1}] call FUNC(configColorToArray); // [0,0,0,1]

License: APL-ND

*/

private _configColor = _this select 0;
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_constructTab.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles updating and controls on the Construct tab of the Main dialog.

Arguments:
Expand All @@ -17,6 +17,9 @@ Dependencies:

Example:
["update"] call FUNC(constructTab);

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_donateTab.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles updating and controls on the Donate tab of the Main dialog.

Arguments:
Expand All @@ -17,6 +17,9 @@ Dependencies:

Example:
["update"] call FUNC(donateTab);

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_fastTravelTab.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles updating and controls on the Fast Travel tab of the Main dialog.

Arguments:
Expand All @@ -17,6 +17,9 @@ Dependencies:

Example:
["update"] call FUNC(fastTravelTab);

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_fireMissionEH.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Event Handler for drawing fire mission markers to the commander map

Arguments:
Expand All @@ -16,6 +16,9 @@ Dependencies:

Example:
_commanderMap ctrlAddEventHandler ["Draw","_this call A3A_GUI_fnc_fireMissionEH"];

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
7 changes: 7 additions & 0 deletions A3A/addons/gui/functions/GUI/fn_getGroupInfo.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
// TODO UI-update: update header

/*
Maintainer: Caleb Serafin, DoomMetal

License: APL-ND

*/

// Returns info about a group
// Group name, position, alive/combat ready counts, vehicle status etc.
// Mostly rewritten stuff from REINF/fn_vehStats.sqf
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_getGroupVehicle.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Gets a high command groups assigned vehicle

Arguments:
Expand All @@ -16,6 +16,9 @@ Dependencies:

Example:
[_someGroup] call FUNC(getGroupVehicle); // Returns the group vehicle if it has one, objNull if not

License: APL-ND

*/

// This function was part of A3A_fnc_vehStats
Expand Down
27 changes: 16 additions & 11 deletions A3A/addons/gui/functions/GUI/fn_getVehicleCrewCount.sqf
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
/*
Maintainer: Caleb Serafin, DoomMetal

Returns an array with numbers of vehicle positions

Params:
0 : String - classname of vehicle

Returns
Array :
0 - driver
1 - copilot
2 - commander
3 - gunners
4 - passengers (includes FFV seats)
5 - FFV seats
Params:
0 : String - classname of vehicle

Returns
Array :
0 - driver
1 - copilot
2 - commander
3 - gunners
4 - passengers (includes FFV seats)
5 - FFV seats

License: APL-ND

*/

// TODO UI-update: Update header
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_hqDialog.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles the initialization and updating of the HQ Dialog
This function should only be called from HqDialog onLoad and control activation EHs.

Expand All @@ -19,6 +19,9 @@ Dependencies:
Example:
["onLoad"] spawn FUNC(hqDialog); // initialization
["switchTab", ["garrison"]] call FUNC(hqDialog); // switching to the garrison tab

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_mainDialog.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Handles the initialization and tab switching on the Main Dialog (aka the Y-Menu).
This function should only be called from MainDialog onLoad and control activation EHs.

Expand All @@ -19,6 +19,9 @@ Dependencies:
Example:
["onLoad"] spawn FUNC(mainDialog); // initialization
["switchTab", ["player"]] call FUNC(mainDialog); // switching to the player tab

License: APL-ND

*/

#include "..\..\dialogues\ids.inc"
Expand Down
5 changes: 4 additions & 1 deletion A3A/addons/gui/functions/GUI/fn_mapDrawHcGroupsEH.sqf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Maintainer: DoomMetal
Maintainer: Caleb Serafin, DoomMetal
Event Handler for drawing High Command group markers to the maps

Arguments:
Expand All @@ -16,6 +16,9 @@ Dependencies:

Example:
_commanderMap ctrlAddEventHandler ["Draw","_this call A3A_GUI_fnc_mapDrawHcGroupsEH"];

License: APL-ND

*/
#include "..\..\script_component.hpp"
FIX_LINE_NUMBERS()
Expand Down
47 changes: 25 additions & 22 deletions A3A/addons/gui/functions/GUI/fn_mapDrawOutpostsEH.sqf
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
/*
Maintainer: DoomMetal
Draws map markers to map controls

Arguments:
None

Return Value:
None

Scope: Internal
Environment: Unscheduled
Public: No
Dependencies:
<ARRAY> airportsX
<ARRAY> resourcesX
<ARRAY> factories
<ARRAY> outposts
<ARRAY> seaports
<ARRAY> citiesX

Example:
_fastTravelMap ctrlAddEventHandler ["Draw","_this call A3A_GUI_fnc_mapDrawOutpostsEH"];
Maintainer: Caleb Serafin, DoomMetal
Draws map markers to map controls

Arguments:
None

Return Value:
None

Scope: Internal
Environment: Unscheduled
Public: No
Dependencies:
<ARRAY> airportsX
<ARRAY> resourcesX
<ARRAY> factories
<ARRAY> outposts
<ARRAY> seaports
<ARRAY> citiesX

Example:
_fastTravelMap ctrlAddEventHandler ["Draw","_this call A3A_GUI_fnc_mapDrawOutpostsEH"];

License: APL-ND

*/

#include "..\..\dialogues\textures.inc"
Expand Down
Loading