BIS fnc loadInventory: Difference between revisions

Latest revision as of 18:09, 8 November 2023

Hover & click on the images for 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:

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

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

See also:: BIS_fnc_saveInventory BIS_fnc_exportInventory BIS_fnc_deleteInventory setUnitLoadout

: 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

@@ Line 15: / Line 15: @@
 * [[Array]] in format [<nowiki/>[[Namespace]], [[Group]] or [[Object]], [[String]]] or [[BIS_fnc_saveInventory]]'s output
-|p3= [[Array]] - (Optional, default []) array of [[String]]s that define what part of the loadout to ignore, e.g ["weapons", "uniform"]
+|p3= [[Array]] - (Optional, default <sqf inline>[]</sqf>) array of [[String]]s that define what part of the loadout to ignore, e.g ["weapons", "uniform"]
 |r1= [[Boolean]]
-|x1= <code>loadout = [<nowiki/>[[player]], [[configFile]] >> "CfgVehicles" >> "B_Soldier_SL_F"] [[call]] [[BIS_fnc_loadInventory]]; // gives BLUFOR Squad Leader's loadout to player unit</code>
+|x1= <sqf>_loadout = [player, configFile >> "CfgVehicles" >> "B_Soldier_SL_F"] call BIS_fnc_loadInventory; // gives BLUFOR Squad Leader's loadout to player unit</sqf>
 |x2= to save and load the inventory:
-<code>[<nowiki/>[[player]], [<nowiki/>[[missionNamespace]], "TAG_SavedInventory"]] [[call]] [[BIS_fnc_saveInventory]];	// save it
+<sqf>
-[<nowiki/>[[player]], [<nowiki/>[[missionNamespace]], "TAG_SavedInventory"]] [[call]] [[BIS_fnc_loadInventory]];	// load it</code>
+[player, [missionNamespace, "TAG_SavedInventory"]] call BIS_fnc_saveInventory;	// save it
+[player, [missionNamespace, "TAG_SavedInventory"]] call BIS_fnc_loadInventory;	// load it
+</sqf>
 |seealso= [[BIS_fnc_saveInventory]] [[BIS_fnc_exportInventory]] [[BIS_fnc_deleteInventory]] [[setUnitLoadout]]