BIS fnc saveInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Save unit's loadout. |= Description
____________________________________________________________________________________________


Description:
| [unit,input,params,delete] call [[BIS_fnc_saveInventory]] |= Syntax
Save unit's loadout
____________________________________________________________________________________________
 
Parameter(s):
0: OBJECT - unit of which loadout will be saved
1: ARRAY in format
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:
ARRAY - saved value
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= unit: [[Object]] - Unit whose inventory should be saved|= Parameter 1
|p2= input: [[Array]] in format:
*1: [[Namespace]], [[Group]] or [[Object]] - Target where the loadout is stored
*2: [[String]] - Loadout name|= Parameter 2
|p3= params: [[Array]] - (Optional, default [ ]) Custom parameters stored with the loadout|= Parameter 3
|p4= delete: [[Boolean]] - (Optional, default [[false]]) Whether or not to delete the loadout|= Parameter 4
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_saveInventory]]; --> |= Syntax
| [[Array]] - Saved value|= Return value
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[player, [missionNamespace, "inv"]] call [[BIS_fnc_saveInventory]] </code> |=  
|x1= <code>[ [[player]], [ [[missionNamespace]], "BIS_inv"], [], true ] [[call]] [[BIS_fnc_saveInventory]];</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]]|= See also
| [[BIS_fnc_loadInventory]][[BIS_fnc_exportInventory]][[BIS_fnc_deleteInventory]], [[getUnitLoadout]] |= See also
 
}}
}}


Revision as of 15:45, 29 May 2018

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

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

Syntax

Syntax:
[unit,input,params,delete] call BIS_fnc_saveInventory
Parameters:
unit: Object - Unit whose inventory should be saved
input: Array in format:
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_deleteInventorygetUnitLoadout

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_saveInventory&oldid=107760"