BIS fnc loadInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


|p1= [[Object]] - Unit to receive the loadout. |= Parameter 1
|p1= [[Object]] - Unit to receive the loadout. |= Parameter 1
Line 18: Line 18:
|p3= [[Array]] - Array of [[String|Strings]] that define what part of the loadout to ignore. Example "weapons", "uniform". ''Optional parameter''.
|p3= [[Array]] - Array of [[String|Strings]] that define what part of the loadout to ignore. Example "weapons", "uniform". ''Optional parameter''.


| [[Boolean]] |= Return value
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 24: Line 24:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_saveInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]]|= See also
| [[BIS_fnc_saveInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]]|SEEALSO=


}}
}}

Revision as of 11:29, 7 April 2019


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:
Uncategorised

Syntax

Syntax:
param call BIS_fnc_loadInventory;
Parameters:
Object - Unit to receive the loadout.
Config - Config entry of loadout found in either CfgVehicles or CfgRespawnInventory, OR:
Array - Array of Strings that define what part of the loadout to ignore. Example "weapons", "uniform". Optional parameter.
Return Value:
Boolean

Examples

Example 1:
loadout = [player,configfile >> "CfgVehicles" >> "B_Soldier_SL_F"] call BIS_fnc_loadInventory; // Gives loadout of BLUFOR Squad Leader to player unit.

Additional Information

See also:
BIS_fnc_saveInventoryBIS_fnc_exportInventoryBIS_fnc_deleteInventory

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

Notes

Bottom Section

Posted on August 8, 2015 - 17:18 (UTC)
Drunken Officer
to save and load the inventory
//--- save it
[player, [missionNamespace, "Var_SavedInventory"]] call BIS_fnc_saveInventory;

//--- load it
[player, [missionNamespace, "Var_SavedInventory"]] call BIS_fnc_loadInventory;