BIS fnc saveInventory: Difference between revisions

Latest revision as of 17:48, 8 November 2023

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 in format:

1: Namespace, Group or Object - Target where the loadout is stored
2: String - Loadout name

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_loadInventory BIS_fnc_exportInventory BIS_fnc_deleteInventory getUnitLoadout

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

: Posted on 2020-08-02 - 15:22 (UTC)
Ilias38rus: Doesn't work for backpacks in backpack, unlike getUnitLoadout.

@@ 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
+|p2= input: [[Array]] in format:
+*1: [[Namespace]], [[Group]] or [[Object]] - Target where the loadout is stored
+*2: [[String]] - Loadout name
+|p3= params: [[Array]] - (Optional, default []) custom parameters stored with the loadout
+|p4= delete: [[Boolean]] - (Optional, default [[false]]) whether or not to delete the loadout
-	Parameter(s):
+|r1= [[Array]] - saved value
-: OBJECT - unit of which loadout will be saved
-: ARRAY in format
-: NAMESPACE or GROUP or OBJECT - target in which namespace the loadout will be saved
-: STRING - loadout name
-(Optional): ARRAY - custom params to be saved along the loadout (default: [])
-(Optional): BOOL - true to delete the loadout (default: false)
-	Returns:
+|x1= <sqf>[player, [missionNamespace, "BIS_inv"], [], true] call BIS_fnc_saveInventory;</sqf>
-	ARRAY - saved value
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|seealso= [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]] [[getUnitLoadout]]
-____________________________________________________________________________________________
+}}
-| <!-- [] call [[BIS_fnc_saveInventory]]; --> |= Syntax
-|p1= |= Parameter 1
+<dl class="command_description">
-| |= Return value
+<dt></dt>
-____________________________________________________________________________________________
+<dd class="notedate">Posted on 2020-08-02 - 15:22 (UTC)</dd>
+<dt class="note">[[User:Ilias38rus|Ilias38rus]]</dt>
+<dd class="note">
+Doesn't work for backpacks in backpack, unlike [[getUnitLoadout]].
+</dd>
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]]|= See also
-}}
-<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}}]]