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: @@
-{{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=
+*2: [[String]] - Loadout name
-|p3= params: [[Array]] - (Optional, default [ ]) Custom parameters stored with the loadout|PARAMETER3=
+|p3= params: [[Array]] - (Optional, default []) custom parameters stored with the loadout
-|p4= delete: [[Boolean]] - (Optional, default [[false]]) Whether or not to delete the loadout|PARAMETER4=
+|p4= delete: [[Boolean]] - (Optional, default [[false]]) whether or not to delete the loadout
-____________________________________________________________________________________________
-| [[Array]] - Saved value|RETURNVALUE=
+|r1= [[Array]] - saved value
-____________________________________________________________________________________________
-|x1= <code>[ [[player]], [ [[missionNamespace]], "BIS_inv"], [], true ] [[call]] [[BIS_fnc_saveInventory]];</code> |=
+|x1= <sqf>[player, [missionNamespace, "BIS_inv"], [], true] call BIS_fnc_saveInventory;</sqf>
-____________________________________________________________________________________________
-| [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]], [[getUnitLoadout]] |SEEALSO=
+|seealso= [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]] [[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}}]]
-<!-- CONTINUE Notes -->
+<dt></dt>
-<dl class="command_description">
+<dd class="notedate">Posted on 2020-08-02 - 15:22 (UTC)</dd>
-<dd class="notedate">Posted on August 2, 2020 - 15:22 (UTC)</dd>
 <dt class="note">[[User:Ilias38rus|Ilias38rus]]</dt>
 <dd class="note">
 Doesn't work for backpacks in backpack, unlike [[getUnitLoadout]].
 </dd>
 </dl>
-<!-- DISCONTINUE Notes -->