From 51450b86fb8f4f9e955aaeb9a24d76a3312aa727 Mon Sep 17 00:00:00 2001 From: jonpas Date: Tue, 9 Aug 2016 01:15:59 +0200 Subject: [PATCH] Add dogtags $, Improve function headers --- addons/dogtags/$PBOPREFIX$ | 1 + addons/dogtags/Dogtag.hpp | 8 ++++---- addons/dogtags/README.md | 1 + addons/dogtags/config.cpp | 6 ++++-- addons/dogtags/functions/fnc_addDogtagActions.sqf | 3 +++ addons/dogtags/functions/fnc_addDogtagItem.sqf | 5 ++++- addons/dogtags/functions/fnc_bloodType.sqf | 3 +++ addons/dogtags/functions/fnc_canCheckDogtag.sqf | 3 +++ addons/dogtags/functions/fnc_canTakeDogtag.sqf | 3 +++ addons/dogtags/functions/fnc_checkDogtag.sqf | 5 ++++- addons/dogtags/functions/fnc_checkDogtagItem.sqf | 7 +++++-- addons/dogtags/functions/fnc_getDogtagData.sqf | 10 ++++++++-- addons/dogtags/functions/fnc_getDogtagItem.sqf | 5 ++++- addons/dogtags/functions/fnc_sendDogtagData.sqf | 7 +++++-- addons/dogtags/functions/fnc_showDogtag.sqf | 7 +++++-- addons/dogtags/functions/fnc_ssn.sqf | 2 +- addons/dogtags/functions/fnc_takeDogtag.sqf | 7 +++++-- addons/dogtags/script_component.hpp | 1 + 18 files changed, 64 insertions(+), 20 deletions(-) create mode 100644 addons/dogtags/$PBOPREFIX$ diff --git a/addons/dogtags/$PBOPREFIX$ b/addons/dogtags/$PBOPREFIX$ new file mode 100644 index 0000000000..475914e9b1 --- /dev/null +++ b/addons/dogtags/$PBOPREFIX$ @@ -0,0 +1 @@ +z\ace\addons\dogtags diff --git a/addons/dogtags/Dogtag.hpp b/addons/dogtags/Dogtag.hpp index 937432d2a8..d783ec15b0 100644 --- a/addons/dogtags/Dogtag.hpp +++ b/addons/dogtags/Dogtag.hpp @@ -4,8 +4,8 @@ class RscStructuredText; class RscTitles { class GVAR(singleTag) { idd = -1; - onLoad = QUOTE(uiNamespace setVariable [ARR_2(QUOTE(QGVAR(tag)),_this select 0)]); - onUnload = QUOTE(uiNamespace setVariable [ARR_2(QUOTE(QGVAR(tag)),nil)]); + onLoad = QUOTE(uiNamespace setVariable [ARR_2(QQGVAR(tag),_this select 0)]); + onUnload = QUOTE(uiNamespace setVariable [ARR_2(QQGVAR(tag),nil)]); movingEnable = false; duration = 5; fadeIn = 0.2; @@ -49,8 +49,8 @@ class RscTitles { }; class GVAR(doubleTag): GVAR(singleTag) { idd = -1; - onLoad = QUOTE(uiNamespace setVariable [ARR_2(QUOTE(QGVAR(tag)),_this select 0)]); - onUnload = QUOTE(uiNamespace setVariable [ARR_2(QUOTE(QGVAR(tag)),nil)]); + onLoad = QUOTE(uiNamespace setVariable [ARR_2(QQGVAR(tag),_this select 0)]); + onUnload = QUOTE(uiNamespace setVariable [ARR_2(QQGVAR(tag),nil)]); class controls: controls { class background: background { diff --git a/addons/dogtags/README.md b/addons/dogtags/README.md index e3bf6caf73..176b60750d 100644 --- a/addons/dogtags/README.md +++ b/addons/dogtags/README.md @@ -9,3 +9,4 @@ Adds options to check and take dog tag from dead or unconscious units The people responsible for merging changes to this component or answering potential questions. - [SzwedzikPL](https://github.com/SzwedzikPL) +- [esteldunedain](https://github.com/esteldunedain) diff --git a/addons/dogtags/config.cpp b/addons/dogtags/config.cpp index de66b2a087..a3ad6b7cf0 100644 --- a/addons/dogtags/config.cpp +++ b/addons/dogtags/config.cpp @@ -2,12 +2,14 @@ class CfgPatches { class ADDON { + name = COMPONENT_NAME; units[] = {}; weapons[] = {}; requiredVersion = REQUIRED_VERSION; requiredAddons[] = {"ace_common"}; - author[] = {"SzwedzikPL"}; - authorUrl = "https://github.com/SzwedzikPL/"; + author = ECSTRING(common,ACETeam); + authors[] = {"SzwedzikPL"}; + url = ECSTRING(main,URL); VERSION_CONFIG; }; }; diff --git a/addons/dogtags/functions/fnc_addDogtagActions.sqf b/addons/dogtags/functions/fnc_addDogtagActions.sqf index ffc45532e9..05f136830c 100644 --- a/addons/dogtags/functions/fnc_addDogtagActions.sqf +++ b/addons/dogtags/functions/fnc_addDogtagActions.sqf @@ -9,6 +9,9 @@ * Return Value: * Children actions * + * Example: + * _childrenActions = [unit, player] call ace_dogtags_fnc_addDogtagActions + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_addDogtagItem.sqf b/addons/dogtags/functions/fnc_addDogtagItem.sqf index f4890782b0..e734b6f38f 100644 --- a/addons/dogtags/functions/fnc_addDogtagItem.sqf +++ b/addons/dogtags/functions/fnc_addDogtagItem.sqf @@ -1,6 +1,6 @@ /* * Author: SzwedzikPL - * Adds dogtag item to unit (triggered by server) + * Adds dogtag item to unit (triggered by server). * * Arguments: * 0: Item class @@ -9,6 +9,9 @@ * Return Value: * None * + * Example: + * ["itemClass", ["name", "610-27-5955", "A POS"]] call ace_dogtags_fnc_addDogtagItem + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_bloodType.sqf b/addons/dogtags/functions/fnc_bloodType.sqf index 2111e16ccf..a7cafbd1fd 100644 --- a/addons/dogtags/functions/fnc_bloodType.sqf +++ b/addons/dogtags/functions/fnc_bloodType.sqf @@ -8,6 +8,9 @@ * Return Value: * A random blood type * + * Example: + * _bloodType = ["name"] call ace_dogtags_fnc_bloodType + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_canCheckDogtag.sqf b/addons/dogtags/functions/fnc_canCheckDogtag.sqf index a05629c72f..66a25c94b0 100644 --- a/addons/dogtags/functions/fnc_canCheckDogtag.sqf +++ b/addons/dogtags/functions/fnc_canCheckDogtag.sqf @@ -9,6 +9,9 @@ * Return Value: * True if dogtag can be checked * + * Example: + * _canCheck = [player, unit] call ace_dogtags_fnc_canCheckDogtag + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_canTakeDogtag.sqf b/addons/dogtags/functions/fnc_canTakeDogtag.sqf index b8279144bb..33a3ef055f 100644 --- a/addons/dogtags/functions/fnc_canTakeDogtag.sqf +++ b/addons/dogtags/functions/fnc_canTakeDogtag.sqf @@ -9,6 +9,9 @@ * Return Value: * True if dogtag can be taken * + * Example: + * _canTake = [player, unit] call ace_dogtags_fnc_canTakeDogtag + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_checkDogtag.sqf b/addons/dogtags/functions/fnc_checkDogtag.sqf index 6345871f02..7b703b995c 100644 --- a/addons/dogtags/functions/fnc_checkDogtag.sqf +++ b/addons/dogtags/functions/fnc_checkDogtag.sqf @@ -1,6 +1,6 @@ /* * Author: SzwedzikPL - * Checks unit dogtag + * Checks unit dogtag. * * Arguments: * 0: Player @@ -9,6 +9,9 @@ * Return Value: * None * + * Example: + * [player, unit] call ace_dogtags_fnc_checkDogtag + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_checkDogtagItem.sqf b/addons/dogtags/functions/fnc_checkDogtagItem.sqf index 930532a0d9..237c4cf4b1 100644 --- a/addons/dogtags/functions/fnc_checkDogtagItem.sqf +++ b/addons/dogtags/functions/fnc_checkDogtagItem.sqf @@ -1,6 +1,6 @@ /* * Author: SzwedzikPL - * Check dogtag self menu action + * Check dogtag self menu action. * * Arguments: * 0: Player @@ -8,7 +8,10 @@ * 2: Item class * * Return Value: - * Mone + * None + * + * Example: + * [player, unit, "itemClass"] call ace_dogtags_fnc_checkDogtagItem * * Public: No */ diff --git a/addons/dogtags/functions/fnc_getDogtagData.sqf b/addons/dogtags/functions/fnc_getDogtagData.sqf index 485e09789e..607426fda4 100644 --- a/addons/dogtags/functions/fnc_getDogtagData.sqf +++ b/addons/dogtags/functions/fnc_getDogtagData.sqf @@ -1,12 +1,18 @@ /* * Author: esteldunedain - * Get unit dogtag data + * Get unit dogtag data. * * Arguments: * 0: Target * * Return Value: - * None + * Dogtag Data + * 0: Name + * 1: SSN + * 2: Blood Type + * + * Example: + * _dogtagData = [unit, player] call ace_dogtags_fnc_getDogtagData * * Public: No */ diff --git a/addons/dogtags/functions/fnc_getDogtagItem.sqf b/addons/dogtags/functions/fnc_getDogtagItem.sqf index aee57b31e3..9c21ce0c54 100644 --- a/addons/dogtags/functions/fnc_getDogtagItem.sqf +++ b/addons/dogtags/functions/fnc_getDogtagItem.sqf @@ -1,6 +1,6 @@ /* * Author: SzwedzikPL - * Server: creates new dogtag item and send it to client + * Server: creates new dogtag item and send it to client. * * Arguments: * 0: Player @@ -9,6 +9,9 @@ * Return Value: * None * + * Example: + * [player, unit] call ace_dogtags_fnc_getDogtagItem + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_sendDogtagData.sqf b/addons/dogtags/functions/fnc_sendDogtagData.sqf index cadb343796..34665fdfee 100644 --- a/addons/dogtags/functions/fnc_sendDogtagData.sqf +++ b/addons/dogtags/functions/fnc_sendDogtagData.sqf @@ -1,6 +1,6 @@ /* * Author: SzwedzikPL - * Server: returns to client data on given dogtag + * Server: returns to client data on given dogtag. * * Arguments: * 0: Player @@ -9,11 +9,14 @@ * Return Value: * None * + * Example: + * [player, unit] call ace_dogtags_fnc_sendDogtagData + * * Public: No */ #include "script_component.hpp" -if(!isServer) exitWith {}; +if (!isServer) exitWith {}; params ["_target", "_item"]; TRACE_2("sendDogtagData",_target,_item); diff --git a/addons/dogtags/functions/fnc_showDogtag.sqf b/addons/dogtags/functions/fnc_showDogtag.sqf index 119a2de773..aac4557f64 100644 --- a/addons/dogtags/functions/fnc_showDogtag.sqf +++ b/addons/dogtags/functions/fnc_showDogtag.sqf @@ -1,14 +1,17 @@ /* * Author: SzwedzikPL - * Shows dogtag + * Shows dogtag. * * Arguments: - * 0: Dog tag data + * 0: Dogtag data * 1: Display as double tag * * Return Value: * None * + * Example: + * [["name", "610-27-5955", "A POS"], true] call ace_dogtags_fnc_showDogtag + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/functions/fnc_ssn.sqf b/addons/dogtags/functions/fnc_ssn.sqf index bb79ddca9a..330d4c00d2 100644 --- a/addons/dogtags/functions/fnc_ssn.sqf +++ b/addons/dogtags/functions/fnc_ssn.sqf @@ -9,7 +9,7 @@ * A random three/two/four format social security number * * Example: - * ["AAA"] call ace_dogtags_fnc_ssn + * _ssn = ["AAA"] call ace_dogtags_fnc_ssn * * Public: No */ diff --git a/addons/dogtags/functions/fnc_takeDogtag.sqf b/addons/dogtags/functions/fnc_takeDogtag.sqf index e8c93a985d..0b779c029b 100644 --- a/addons/dogtags/functions/fnc_takeDogtag.sqf +++ b/addons/dogtags/functions/fnc_takeDogtag.sqf @@ -1,7 +1,7 @@ /* * Author: SzwedzikPL - * If dogtag is not already taken triggers event on server - * If dogtag already taken displays info about it + * If dogtag is not already taken triggers event on server. + * If dogtag already taken displays info about it. * * Arguments: * 0: Player @@ -10,6 +10,9 @@ * Return Value: * None * + * Example: + * [player, unit] call ace_dogtags_fnc_takeDogtag + * * Public: No */ #include "script_component.hpp" diff --git a/addons/dogtags/script_component.hpp b/addons/dogtags/script_component.hpp index 980222c8da..c5912f2d2c 100644 --- a/addons/dogtags/script_component.hpp +++ b/addons/dogtags/script_component.hpp @@ -1,4 +1,5 @@ #define COMPONENT dogtags +#define COMPONENT_BEAUTIFIED Dogtags #include "\z\ace\addons\main\script_mod.hpp" // #define DEBUG_MODE_FULL