BIS fnc loadInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(5 intermediate revisions by the same user not shown)
Line 15: Line 15:
* [[Array]] in format [<nowiki/>[[Namespace]], [[Group]] or [[Object]], [[String]]] or [[BIS_fnc_saveInventory]]'s output
* [[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]]
|r1= [[Boolean]]


|x1= <code>loadout = [<nowiki/>[[player]], [[configFile]] >> "CfgVehicles" >> "B_Soldier_SL_F"] [[call]] [[BIS_fnc_loadInventory]]; {{cc|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:
|x2= to save and load the inventory:
<code>[<nowiki/>[[player]], [<nowiki/>[[missionNamespace]], "TAG_SavedInventory"]] [[call]] [[BIS_fnc_saveInventory]]; {{cc|save it}}
<sqf>
[<nowiki/>[[player]], [<nowiki/>[[missionNamespace]], "TAG_SavedInventory"]] [[call]] [[BIS_fnc_loadInventory]]; {{cc|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]]
|seealso= [[BIS_fnc_saveInventory]] [[BIS_fnc_exportInventory]] [[BIS_fnc_deleteInventory]] [[setUnitLoadout]]
Line 30: Line 32:
{{Note
{{Note
|user= Ilias38rus
|user= Ilias38rus
|datetime= 20200802152100
|timestamp= 20200802152100
|text= Doesn't work for backpacks in backpack, unlike [[setUnitLoadout]].
|text= Doesn't work for backpacks in backpack, unlike [[setUnitLoadout]].
}}
}}

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"