BIS fnc loadInventory: Difference between revisions

Latest revision as of 18:09, 8 November 2023

0.58

Hover & click on the images for description

Description

Description:: Adds a predefined loadout (either via CfgVehicles, CfgRespawnInventory, or a custom inventory saved via BIS_fnc_saveInventory) to a specified unit.
Execution:: call
Groups:: Inventory

Syntax

Syntax:

param call BIS_fnc_loadInventory

Parameters:

Object - unit to receive the loadout

Config or Array - can be one of:

Config: config entry of loadout found in either CfgVehicles or CfgRespawnInventory
Array in format [Namespace, Group or Object, String] or BIS_fnc_saveInventory's output

Array - (Optional, default []) array of Strings that define what part of the loadout to ignore, e.g ["weapons", "uniform"]

Return Value:

Boolean

Examples

Example 1:: _loadout = [player, configFile >> "CfgVehicles" >> "B_Soldier_SL_F"] call BIS_fnc_loadInventory; // gives BLUFOR Squad Leader's loadout to player unit
Example 2:: to save and load the inventory:
[player, [missionNamespace, "TAG_SavedInventory"]] call BIS_fnc_saveInventory; // save it [player, [missionNamespace, "TAG_SavedInventory"]] call BIS_fnc_loadInventory; // load it

Additional Information

See also:: BIS_fnc_saveInventory BIS_fnc_exportInventory BIS_fnc_deleteInventory setUnitLoadout

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Ilias38rus - c: Posted on Aug 02, 2020 - 15:21 (UTC)
: Doesn't work for backpacks in backpack, unlike setUnitLoadout.

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma3
+|game1= arma3
+|version1= 0.58
-|0.58
+|gr1= Inventory
-|gr1 = Inventory
+|descr= Adds a predefined loadout (either via {{hl|CfgVehicles}}, {{hl|CfgRespawnInventory}}, or a custom inventory saved via [[BIS_fnc_saveInventory]]) to a specified unit.
-| Adds a predefined loadout (either via CfgVehicles, CfgRespawnInventory, or a custom inventory saved via [[BIS_fnc_saveInventory]]) to a specified unit.
+|s1= param call [[BIS_fnc_loadInventory]]
-| param call [[BIS_fnc_loadInventory]];
+|p1= [[Object]] - unit to receive the loadout
+|p2= [[Config]] or [[Array]] - can be one of:
+* [[Config]]: config entry of loadout found in either {{hl|CfgVehicles}} or {{hl|CfgRespawnInventory}}
+* [[Array]] in format [<nowiki/>[[Namespace]], [[Group]] or [[Object]], [[String]]] or [[BIS_fnc_saveInventory]]'s output
-|p1= [[Object]] - Unit to receive the loadout.
+|p3= [[Array]] - (Optional, default <sqf inline>[]</sqf>) array of [[String]]s that define what part of the loadout to ignore, e.g ["weapons", "uniform"]
-|p2= [[Config]] - Config entry of loadout found in either CfgVehicles or CfgRespawnInventory, OR:
-* [[Array]] in format [ < [[Namespace]], [[Group]] or [[Object]] >, [[String]] ] or [ output of [[BIS_fnc_saveInventory]] ] - usable with inventories saved via [[BIS_fnc_saveInventory]].
-|p3= [[Array]] - Array of [[String|Strings]] that define what part of the loadout to ignore. Example "weapons", "uniform". ''Optional parameter''.
+|r1= [[Boolean]]
-| [[Boolean]]
+|x1= <sqf>_loadout = [player, configFile >> "CfgVehicles" >> "B_Soldier_SL_F"] call BIS_fnc_loadInventory; // gives BLUFOR Squad Leader's loadout to player unit</sqf>
-|x1= <code>loadout = [player,configfile >> "CfgVehicles" >> "B_Soldier_SL_F"] call BIS_fnc_loadInventory; // Gives loadout of BLUFOR Squad Leader to player unit.</code>
+|x2= to save and load the inventory:
+<sqf>
+[player, [missionNamespace, "TAG_SavedInventory"]] call BIS_fnc_saveInventory;	// save it
+[player, [missionNamespace, "TAG_SavedInventory"]] call BIS_fnc_loadInventory;	// load it
+</sqf>
-| [[BIS_fnc_saveInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]][[setUnitLoadout]]
+|seealso= [[BIS_fnc_saveInventory]] [[BIS_fnc_exportInventory]] [[BIS_fnc_deleteInventory]] [[setUnitLoadout]]
 }}
+{{Note
+|user= Ilias38rus
-[[Category:Functions|{{uc:loadInventory}}]]
+|timestamp= 20200802152100
-[[Category:{{Name|arma3}}: Functions|{{uc:loadInventory}}]]
+|text= Doesn't work for backpacks in backpack, unlike [[setUnitLoadout]].
+}}
-<!-- CONTINUE Notes -->
-<dl class="command_description">
-<dd class="notedate">Posted on August 8, 2015 - 17:18 (UTC)</dd>
-<dt class="note">[[User:Drunken Officer|Drunken Officer]]</dt>
-<dd class="note">
-to save and load the inventory <br>
-//--- save it<br>
-[player, [missionNamespace, "Var_SavedInventory"]] call BIS_fnc_saveInventory;<br><br>
-//--- load it<br>
-[player, [missionNamespace, "Var_SavedInventory"]] '''call BIS_fnc_loadInventory;'''
-</dd>
-<dd class="notedate">Posted on August 2, 2020 - 15:21 (UTC)</dd>
-<dt class="note">[[User:Ilias38rus|Ilias38rus]]</dt>
-<dd class="note">
-Doesn't work for backpacks in backpack, unlike [[setUnitLoadout]].
-</dd>
-</dl>
-<!-- DISCONTINUE Notes -->