BIS fnc saveInventory: Difference between revisions

From Bohemia Interactive Community
No edit summary
m (Some wiki formatting)
 
(46 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Inventory


|1.00|= Game version
|descr= Save unit's loadout.
____________________________________________________________________________________________


| <pre>/*
|s1= [unit, input, params, delete] call [[BIS_fnc_saveInventory]]


Description:
|p1= unit: [[Object]] - unit whose inventory should be saved
Save unit's loadout


Parameter(s):
|p2= input: [[Array]] format [target, loadoutName]:
0: OBJECT - unit of which loadout will be saved
* target: [[Namespace]], [[Group]] or [[Object]] - target where the loadout is stored
1: ARRAY in format
* loadoutName: [[String]] - loadout name
0: NAMESPACE or GROUP or OBJECT - target in which namespace the loadout will be saved
1: STRING - loadout name
2 (Optional): ARRAY - custom params to be saved along the loadout (default: [])
3 (Optional): BOOL - true to delete the loadout (default: false)


Returns:
|p3= params: [[Array]] - (Optional, default []) custom parameters stored with the loadout
ARRAY - saved value
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p4= delete: [[Boolean]] - (Optional, default [[false]]) whether or not to delete the loadout
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_saveInventory]]; --> |= Syntax
|r1= [[Array]] - saved value


|p1= |= Parameter 1
|x1= <sqf>[player, [missionNamespace, "BIS_inv"], [], true] call BIS_fnc_saveInventory;</sqf>


| |= Return value
|seealso= [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]] [[getUnitLoadout]]
____________________________________________________________________________________________
}}
 
|x1= <code>[player, [missionNamespace, "inv"]] call [[BIS_fnc_saveInventory]] </code> |=
____________________________________________________________________________________________
 
| [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]]|= See also


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

Latest revision as of 23:43, 10 May 2026

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