BIS fnc exportInventory: Difference between revisions

Latest revision as of 15:22, 27 July 2022

1.00

Hover & click on the images for description

Description

Description:: Exports unit's loadout as a String, also copies it to clipboard.
Execution:: call
Groups:: Inventory

Syntax

Syntax:

[unit, type, includeIdentity] call BIS_fnc_exportInventory

Parameters:

unit: Object - (Optional, default player) unit whose loadout should be saved

type: String - (Optional, default "script") export type, can be:

"script"- scripting commands, target is referred to as _unit
"init" - scripting commands, target is referred to as this
"config" - config attributes

includeIdentity: Boolean - (Optional, default true) true to also export face, voice and insignia (applicable to "script" and "init" only)

Return Value:

String - SQF code or Config text when "config" option is chosen

Examples

Example 1:: [player, "init", true] call BIS_fnc_exportInventory;

Additional Information

See also:: BIS_fnc_loadInventory BIS_fnc_deleteInventory BIS_fnc_saveInventory 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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Inventory
-|1.00|= Game version
+|descr= Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]]
-	Description:
+|p1= unit: [[Object]] - (Optional, default [[player]]) unit whose loadout should be saved
-	Export unit's loadout
-	Parameter(s):
+|p2= type: [[String]] - (Optional, default "script") export type, can be:
-: OBJECT - unit of which loadout will be export
+* "script"- scripting commands, target is referred to as {{hl|_unit}}
-: STRING - export type
+* "init" - scripting commands, target is referred to as {{hl|this}}
-			"script" - scripting commands, target is referred to as _unit
+* "config" - config attributes
-			"init" - scripting commands, target is referred to as this
-			"config" - CfgVehicles attributes
-: BOOL - true to export identity (face, voice and insignia)
-	Returns:
+|p3= includeIdentity: [[Boolean]] - (Optional, default [[true]]) [[true]] to also export face, voice and insignia (applicable to "script" and "init" only)
-	STRING - SQF code
-*/
+|r1= [[String]] - [[SQF Syntax|SQF]] code or [[Config]] text when "config" option is chosen
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|x1= <sqf>[player, "init", true] call BIS_fnc_exportInventory;</sqf>
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_exportInventory]]; --> |= Syntax
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[BIS_fnc_loadInventory]] [[BIS_fnc_deleteInventory]] [[BIS_fnc_saveInventory]] [[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:exportInventory}}]]
-[[Category:Functions|{{uc:exportInventory}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:exportInventory}}]]