BIS fnc saveInventory: Difference between revisions

From Bohemia Interactive Community
m (template:command argument fix)
m (Some wiki formatting)
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Inventory
____________________________________________________________________________________________


| Save unit's loadout. |DESCRIPTION=
|descr= Save unit's loadout.
____________________________________________________________________________________________


| [unit,input,params,delete] call [[BIS_fnc_saveInventory]] |SYNTAX=
|s1= [unit, input, params, delete] call [[BIS_fnc_saveInventory]]
____________________________________________________________________________________________


|p1= unit: [[Object]] - Unit whose inventory should be saved|PARAMETER1=
|p1= unit: [[Object]] - unit whose inventory should be saved
|p2= input: [[Array]] in format:
*1: [[Namespace]], [[Group]] or [[Object]] - Target where the loadout is stored
*2: [[String]] - Loadout name|PARAMETER2=
|p3= params: [[Array]] - (Optional, default [ ]) Custom parameters stored with the loadout|PARAMETER3=
|p4= delete: [[Boolean]] - (Optional, default [[false]]) Whether or not to delete the loadout|PARAMETER4=
____________________________________________________________________________________________


| [[Array]] - Saved value|RETURNVALUE=
|p2= input: [[Array]] format [target, loadoutName]:
____________________________________________________________________________________________
* target: [[Namespace]], [[Group]] or [[Object]] - target where the loadout is stored
* loadoutName: [[String]] - loadout name


|x1= <code>[ [[player]], [ [[missionNamespace]], "BIS_inv"], [], true ] [[call]] [[BIS_fnc_saveInventory]];</code> |=
|p3= params: [[Array]] - (Optional, default []) custom parameters stored with the loadout
____________________________________________________________________________________________


| [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]], [[getUnitLoadout]] |SEEALSO=
|p4= delete: [[Boolean]] - (Optional, default [[false]]) whether or not to delete the loadout
}}
 
|r1= [[Array]] - saved value


<h3 style="display:none">Notes</h3>
|x1= <sqf>[player, [missionNamespace, "BIS_inv"], [], true] call BIS_fnc_saveInventory;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]] [[getUnitLoadout]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Function Group: Inventory|{{uc:saveInventory}}]]
|user= Ilias38rus
[[Category:Functions|{{uc:saveInventory}}]]
|timestamp= 20200802152200
[[Category:{{Name|arma3}}: Functions|{{uc:saveInventory}}]]
|text= Doesn't work for backpacks in backpack, unlike [[getUnitLoadout]].
}}

Latest revision as of 23:43, 10 May 2026

Hover & click on the images for description

Description

Description:
Save unit's loadout.
Execution:
call
Groups:
Inventory

Syntax

Syntax:
[unit, input, params, delete] call BIS_fnc_saveInventory
Parameters:
unit: Object - unit whose inventory should be saved
input: Array format [target, loadoutName]:
params: Array - (Optional, default []) custom parameters stored with the loadout
delete: Boolean - (Optional, default false) whether or not to delete the loadout
Return Value:
Array - saved value

Examples

Example 1:
[player, [missionNamespace, "BIS_inv"], [], true] call BIS_fnc_saveInventory;

Additional Information

See also:
BIS_fnc_loadInventoryBIS_fnc_exportInventoryBIS_fnc_deleteInventory getUnitLoadout

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Ilias38rus - c
Posted on Aug 02, 2020 - 15:22 (UTC) §
Doesn't work for backpacks in backpack, unlike getUnitLoadout.