From 26fe04134227223f5b187200a1fba1dd68a557f2 Mon Sep 17 00:00:00 2001 From: Dedmen Miller Date: Wed, 5 Jun 2019 03:00:55 +0200 Subject: [PATCH] Move gunbag type from inheritance to config property (#7022) * Move gunbag type from inheritance to config property * Add gunbag framework wiki * Remove _generalMacro from doc * Apply documentation suggestions Co-Authored-By: mharis001 <34453221+mharis001@users.noreply.github.com> --- addons/gunbag/CfgVehicles.hpp | 1 + addons/gunbag/functions/fnc_calculateMass.sqf | 2 +- addons/gunbag/functions/fnc_canInteract.sqf | 2 +- addons/gunbag/functions/fnc_hasGunbag.sqf | 4 +- docs/wiki/framework/gunbag-framework.md | 39 +++++++++++++++++++ 5 files changed, 44 insertions(+), 4 deletions(-) create mode 100644 docs/wiki/framework/gunbag-framework.md diff --git a/addons/gunbag/CfgVehicles.hpp b/addons/gunbag/CfgVehicles.hpp index e23966cfa2..0addf22710 100644 --- a/addons/gunbag/CfgVehicles.hpp +++ b/addons/gunbag/CfgVehicles.hpp @@ -73,6 +73,7 @@ class CfgVehicles { hiddenSelectionsTextures[] = {QPATHTOF(data\gunbag_co.paa)}; maximumLoad = 80; mass = 11; + ADDON = 1; }; class GVAR(Tan): ADDON { diff --git a/addons/gunbag/functions/fnc_calculateMass.sqf b/addons/gunbag/functions/fnc_calculateMass.sqf index 8f845dc4ee..6d66d191df 100644 --- a/addons/gunbag/functions/fnc_calculateMass.sqf +++ b/addons/gunbag/functions/fnc_calculateMass.sqf @@ -1,7 +1,7 @@ #include "script_component.hpp" /* * Author: Ir0n1E - * Calculate mass of weapon an items. + * Calculate mass of weapon and items. * * Arguments: * 0: Weapon diff --git a/addons/gunbag/functions/fnc_canInteract.sqf b/addons/gunbag/functions/fnc_canInteract.sqf index 46451b50d5..fbf17819f6 100644 --- a/addons/gunbag/functions/fnc_canInteract.sqf +++ b/addons/gunbag/functions/fnc_canInteract.sqf @@ -1,7 +1,7 @@ #include "script_component.hpp" /* * Author: Ir0n1E - * Check if client able to interact with gunbag. + * Check if client is able to interact with gunbag. * * Arguments: * 0: Unit diff --git a/addons/gunbag/functions/fnc_hasGunbag.sqf b/addons/gunbag/functions/fnc_hasGunbag.sqf index 5fa90c7b9c..7f9c7135e0 100644 --- a/addons/gunbag/functions/fnc_hasGunbag.sqf +++ b/addons/gunbag/functions/fnc_hasGunbag.sqf @@ -1,7 +1,7 @@ #include "script_component.hpp" /* * Author: Ir0n1E - * Switches gunbag full/empty for mass calculation. + * Check if unit has a gunbag. * * Arguments: * 0: Unit @@ -17,4 +17,4 @@ params ["_unit"]; -(backpackContainer _unit) isKindOf QUOTE(ADDON) +getNumber (configFile >> "CfgVehicles" >> (backpack _unit) >> QUOTE(ADDON)) == 1 diff --git a/docs/wiki/framework/gunbag-framework.md b/docs/wiki/framework/gunbag-framework.md new file mode 100644 index 0000000000..a3df099abe --- /dev/null +++ b/docs/wiki/framework/gunbag-framework.md @@ -0,0 +1,39 @@ +--- +layout: wiki +title: Gunbag Framework +description: Explains how to set up gunbags +group: framework +parent: wiki +order: 7 +mod: ace +version: + major: 3 + minor: 13 + patch: 0 +--- + +## 1. Overview + +ACE Gunbag provides a framework that allows users to enable putting a gun inside a backpack. + + +## 2. Config Values + +The `ace_gunbag` config entry needs to be set to `1` to enable a backpack to be a gunbag. + +```cpp +class Bag_Base; +class ace_gunbag: Bag_Base { + author = "Ir0n1E"; + scope = 2; + displayName = CSTRING(Displayname); + model = QPATHTOF(data\ace_gunbag.p3d); + picture = QPATHTOF(ui\gunbag_ca.paa); + icon = QPATHTOF(ui\gunbag_icon_ca.paa); + hiddenSelections[] = {"Camo", "insignia"}; + hiddenSelectionsTextures[] = {QPATHTOF(data\gunbag_co.paa)}; + maximumLoad = 80; + mass = 11; + ace_gunbag = 1; +}; +```