BIS fnc loadInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "^ {{Function\|Comments\=" to "{{Function|Comments=")
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.58


|0.58|Game version=
|gr1= Inventory
____________________________________________________________________________________________


| Adds a predefined loadout (either via CfgVehicles, CfgRespawnInventory, or a custom inventory saved via [[BIS_fnc_saveInventory]]) to a specified unit. |DESCRIPTION=
|descr= Adds a predefined loadout (either via {{hl|CfgVehicles}}, {{hl|CfgRespawnInventory}}, or a custom inventory saved via [[BIS_fnc_saveInventory]]) to a specified unit.
____________________________________________________________________________________________


| param call [[BIS_fnc_loadInventory]]; |SYNTAX=
|s1= param call [[BIS_fnc_loadInventory]]


|p1= [[Object]] - Unit to receive the loadout. |PARAMETER1=
|p1= [[Object]] - unit to receive the loadout
|p2= [[Config]] - Config entry of loadout found in either CfgVehicles or CfgRespawnInventory, OR:
|p2= [[Config]] or [[Array]] - can be one of:
* [[Array]] in format [[Namespace]], [[Group]], [[Object]] or [[String]] - usable with inventories saved via [[BIS_fnc_saveInventory]]. |Parameter2=
* [[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


|p3= [[Array]] - Array of [[String|Strings]] that define what part of the loadout to ignore. Example "weapons", "uniform". ''Optional parameter''.
|p3= [[Array]] - (Optional, default <sqf inline>[]</sqf>) array of [[String]]s that define what part of the loadout to ignore, e.g ["weapons", "uniform"]


| [[Boolean]] |RETURNVALUE=
|r1= [[Boolean]]
____________________________________________________________________________________________


|x1= <code>loadout = [player,configfile >> "CfgVehicles" >> "B_Soldier_SL_F"] call BIS_fnc_loadInventory; // Gives loadout of BLUFOR Squad Leader 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>
____________________________________________________________________________________________


| [[BIS_fnc_saveInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]]|SEEALSO=
|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>


|seealso= [[BIS_fnc_saveInventory]] [[BIS_fnc_exportInventory]] [[BIS_fnc_deleteInventory]] [[setUnitLoadout]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Ilias38rus
<!-- Note Section BEGIN -->
|timestamp= 20200802152100
 
|text= Doesn't work for backpacks in backpack, unlike [[setUnitLoadout]].
<!-- Note Section END -->
}}
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Inventory|{{uc:loadInventory}}]]
[[Category:Functions|{{uc:loadInventory}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:loadInventory}}]]
 
<!-- 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>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 18:09, 8 November 2023

Arma 3 logo black.png0.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:
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.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_loadInventory&oldid=349482"