Filtered Loadouts #1270

BrettMayson · 2019-12-21T19:35:43Z

When merged this pull request will:

Alternate to Filtered getUnitLoadout #1238
Close Filtered getUnitLoadout #1236
CBA_fnc_getUnitLoadout
CBA_fnc_filterLoadout
CBA_fnc_addLoadoutFilter
CBA_fnc_removeLoadoutFilter

private _loadout = [player] call CBA_fnc_getUnitLoadout; // Loadout with ItemRadio

private _handle = [{ 
    params ["_loadout", "_handle"]; 
    if ((_loadout select 9) select 2 == "ItemRadio") then { 
        (_loadout select 9) set [2, ""]; 
    }; 
    _loadout
}] call CBA_fnc_addLoadoutFilter;

_loadout = [_loadout] call CBA_fnc_filterLoadout; // Previous loadout with ItemRadio removed
_loadout = [player] call CBA_fnc_getUnitLoadout; // Loadout without ItemRadio

[_handle] call CBA_fnc_removeLoadoutFilter;

_loadout = [player] call CBA_fnc_getUnitLoadout; // Loadout with ItemRadio

commy2 · 2019-12-31T14:04:24Z

Explain the purpose of this in CBA in 500 words or less.

BrettMayson · 2020-01-03T01:16:53Z

Filtered Loadouts: A Case For

Loadouts are an integral aspect of the Arma 3 gameplay, an aspect that players of any game mode are familiar. getUnitLoadout is a command many are familiar with due to its importance in persistent missions, loadout management, dynamic role selection, and overall utility. The inclusion in CBA would remedy the downfalls of current solutions and benefit the entire community. This implementation would be a small change for a lot of lasting good.

Persistent Missions

There are several communities and game modes that take advantage of persistence spanning multiple sessions. These missions rely on utilities like getUnitLoadout to get the information they need. Unfortunately, programmers can not prepare for every case, we are human. These persistent missions do not always have the proper protections and systems in place to properly handle ID'd items such as those found in the popular TFAR and ACRE modifications. This can pose a threat to stability when duplicate instances of items can be present in a single session. This threat to stability can be easily neutralized by the implementation of loadout filtering at save and load.

Loadout Management

Various popular modifications have implemented various forms of loadout management. Take ACE 3's ACE Arsenal, even such a well developed and managed community project suffers from the inability to properly handle ID'd items. Loadouts are saved, loaded, and exported with ID'd items causing potential instability and unexpected behavior. Filtered loadouts specified by mod makers could assure that these issues are avoided both during saving and loading, instantly resolving any previous issues as poisoned loadouts are repaired during load.

Dynamic Role Selection

Game modes that implement dynamic role selection may rely on user-generated or config loadouts. These loadouts can change over time introducing potential mission breaking changes. Imagine a mission based on inserting, retrieving an item, and extracting back to the start. This could be a potential issue as future loadouts or config changes by additional modifications could result in missions ending instantly if players receive a loadout containing the item they are intended to retrieve. While this scenario is less likely that the two previously discussed, it is still an element that will be improved by the addition of filtered loadouts.

Conclusion

Filtered loadouts may not be as sexy as weapon optics or face wear randomization in the eyes of everyone, but they provide another tool in the toolbox that creators can use to increase dependability, durability, persistence, permanence, perseverance, stableness, cohesion, constancy, stability, and functionality. The simplicity of implementation for creators compared to current solutions being created will allow these benefits to be realized with ease.

Arma has a rich community of creators, builders, and dreamers. Adding this utility to the already vast abilities of CBA would unlock more possibilities than this amazing project already has. It would be impossible to cover the potential of this amazing community in such a brief analysis.

Historically CBA has stood for stability, functionality, and user experience. Filtered loadouts stand for the same three principals. CBA should stand with filtered loadouts.

mharis001 · 2020-01-03T02:26:16Z

This will definitely be a useful addition, however, I think this can be simplified to just two functions:

CBA_fnc_addLoadoutFilter

Adds a new loadout filter, simply just adds the given code to an array.
I don't think removal is needed or ever makes sense, but this could adopt the CBA_fnc_addClassEventHandler approach for that.

CBA_fnc_filterLoadout

Filters the given loadout by applying all loadout filters to it.
CBA_fnc_getUnitLoadout will not be needed because this function should handle receiving the different inputs for the getUnitLoadout command as well as a normal loadout array - OBJECT (unit), STRING (CfgVehicles class name), and CONFIG (loadout config).

commy2 · 2020-01-03T09:04:10Z

Totally agree with what mharis001 wrote.

Removal makes no sense (here and I argue in general). If you need to disable it on the fly, turn it off by condition in the filter script.

CBA_fnc_getUnitLoadout currently is just input validation for CBA_fnc_filterLoadout. CBA_fnc_filterLoadout should do its own validation (if even necessary for this!), get is not needed.

2 functions are enough.

Filtered loadouts may not be as sexy as weapon optics or face wear randomization in the eyes of everyone

lol nice dig

jonpas · 2020-01-03T09:07:11Z

Let's just appreciate his post is exactly 500 words long. :D

commy2 · 2020-01-03T09:33:32Z

505 according to MS Word.

jonpas · 2020-01-03T10:01:40Z

Don't count the title.

dedmen · 2020-01-03T11:05:35Z

So in TFAR I iterate all BI Arsenal loadouts after you close arsenal, and remove the ID from TFAR radios,
Would this be essentially the same then? Would tihs automatically integrate with Arsenal or would I still need to do that myself?
I assume ACE Arsenal and BI Arsenal would need to implement this system into their loadout save/load code?
We know BI Arsenal will never do that, so who does that?
Or will TFAR/ACRE keep their loadout handlers the same but instead of patching directly, just invoke the CBA stuff?
Such that we end up with a dozen mods all doing that and calling the loadout filtering a dozen times?

BrettMayson · 2020-01-04T08:30:07Z

I guess that could be added to CBA as part of this PR? Then that functionality would be part of every mod that would use this. That would potentially cause an issue though as mod defined filters should be used, but not mission defined filters

commy2

What @mharis001 wrote.

mharis001 · 2020-05-31T00:09:18Z

addons/common/fnc_addLoadoutFilter.sqf

@@ -0,0 +1,32 @@
+#include "script_component.hpp"
+/* ----------------------------------------------------------------------------
+Function: CBA_fnc_addLoadoutFilter


Should add blank lines between different header sections.

mharis001 · 2020-05-31T00:09:24Z

addons/common/fnc_filterLoadout.sqf

@@ -0,0 +1,25 @@
+#include "script_component.hpp"
+/* ----------------------------------------------------------------------------
+Function: CBA_fnc_filterLoadout


Should add blank lines between different header sections.

mharis001 · 2020-05-31T00:18:42Z

addons/common/init_filteredLoadout.sqf

@@ -0,0 +1,3 @@
+#include "script_component.hpp"
+
+GVAR(loadoutFilters) = [];


Put this directly in XEH_preInit.sqf; one line does not need a separate file.

mharis001 · 2020-05-31T00:19:54Z

addons/common/fnc_addLoadoutFilter.sqf

+
+params [["_function", {}, [{}]]];
+
+if (_function isEqualTo {}) exitWith {-1};


Remove -1 and add nil at the end of file since header says function returns nothing.

It could return false, and true if it worked.

mharis001 · 2020-05-31T00:21:21Z

addons/common/fnc_filterLoadout.sqf

+---------------------------------------------------------------------------- */
+SCRIPT(filterLoadout);
+
+params [["_loadout", [], [[]]]];


Should handle receiving the different inputs (OBJECT, STRING, CONFIG) for the getUnitLoadout command as well as a normal loadout array.

BrettMayson · 2021-11-09T15:08:50Z

Close in favour of #1503

Filtered Loadouts

dbe0324

BrettMayson mentioned this pull request Jan 20, 2020

Filtered getUnitLoadout #1238

Closed

commy2 suggested changes Feb 9, 2020

View reviewed changes

Brett added 2 commits April 26, 2020 23:41

mharis001 suggestions

3c2c8aa

remove space

f4c78a1

commy2 approved these changes May 30, 2020

View reviewed changes

mharis001 reviewed May 31, 2020

View reviewed changes

jonpas added Feature WIP labels Jul 23, 2021

BrettMayson mentioned this pull request Sep 20, 2021

Extended Loadout Framework #1503

Merged

BrettMayson closed this Nov 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Filtered Loadouts #1270

Filtered Loadouts #1270

BrettMayson commented Dec 21, 2019

commy2 commented Dec 31, 2019

BrettMayson commented Jan 3, 2020 •

edited

Loading

mharis001 commented Jan 3, 2020 •

edited

Loading

commy2 commented Jan 3, 2020

jonpas commented Jan 3, 2020

commy2 commented Jan 3, 2020

jonpas commented Jan 3, 2020

dedmen commented Jan 3, 2020

BrettMayson commented Jan 4, 2020

commy2 left a comment

mharis001 May 31, 2020

mharis001 May 31, 2020

mharis001 May 31, 2020

mharis001 May 31, 2020

commy2 May 31, 2020

mharis001 May 31, 2020

BrettMayson commented Nov 9, 2021

		@@ -0,0 +1,3 @@
		#include "script_component.hpp"

		GVAR(loadoutFilters) = [];


		params [["_function", {}, [{}]]];

		if (_function isEqualTo {}) exitWith {-1};

Filtered Loadouts #1270

Filtered Loadouts #1270

Conversation

BrettMayson commented Dec 21, 2019

commy2 commented Dec 31, 2019

BrettMayson commented Jan 3, 2020 • edited Loading

Filtered Loadouts: A Case For

Persistent Missions

Loadout Management

Dynamic Role Selection

Conclusion

mharis001 commented Jan 3, 2020 • edited Loading

commy2 commented Jan 3, 2020

jonpas commented Jan 3, 2020

commy2 commented Jan 3, 2020

jonpas commented Jan 3, 2020

dedmen commented Jan 3, 2020

BrettMayson commented Jan 4, 2020

commy2 left a comment

Choose a reason for hiding this comment

mharis001 May 31, 2020

Choose a reason for hiding this comment

mharis001 May 31, 2020

Choose a reason for hiding this comment

mharis001 May 31, 2020

Choose a reason for hiding this comment

mharis001 May 31, 2020

Choose a reason for hiding this comment

commy2 May 31, 2020

Choose a reason for hiding this comment

mharis001 May 31, 2020

Choose a reason for hiding this comment

BrettMayson commented Nov 9, 2021

BrettMayson commented Jan 3, 2020 •

edited

Loading

mharis001 commented Jan 3, 2020 •

edited

Loading