BIS fnc exportInventory: Difference between revisions

Latest revision as of 14: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: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.00
-|1.00|= Game version
+|gr1= Inventory
-____________________________________________________________________________________________
-| Export unit's loadout. |= Description
+|descr= Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard.
-____________________________________________________________________________________________
-| [unit,type,identity] call [[BIS_fnc_exportInventory]] |= Syntax
+|s1= [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]]
-____________________________________________________________________________________________
-|p1= unit: [[Object]] - Unit whose loadout should be saved|= Parameter 1
+|p1= unit: [[Object]] - (Optional, default [[player]]) unit whose loadout should be saved
-|p2= type: [[String]] - Export type, can be:
-*1: "script"- Scripting commands, target is referred to as {{Inline code|_unit}}
-*2: "init" - Scripting commands, target is referred to as {{Inline code|this}}
-*3: "config" - CfgVehicles attributes|= Parameter 2
-|p3= identity: [[Boolean]]] - [[True]] to also export face, voice and insignia|= Parameter3
-____________________________________________________________________________________________
-| [[String]] - [[SQF]] code |= Return value
+|p2= type: [[String]] - (Optional, default "script") export type, can be:
-____________________________________________________________________________________________
+* "script"- scripting commands, target is referred to as {{hl|_unit}}
+* "init" - scripting commands, target is referred to as {{hl|this}}
+* "config" - config attributes
-|x1= <code>[ [[player]], "init", [[true]] ] [[call]] [[BIS_fnc_exportInventory]];</code> |=
+|p3= includeIdentity: [[Boolean]] - (Optional, default [[true]]) [[true]] to also export face, voice and insignia (applicable to "script" and "init" only)
-____________________________________________________________________________________________
-| [[BIS_fnc_loadInventory]], [[BIS_fnc_deleteInventory]], [[BIS_fnc_saveInventory]], [[getUnitLoadout]] |= See also
+|r1= [[String]] - [[SQF Syntax|SQF]] code or [[Config]] text when "config" option is chosen
-}}
+|x1= <sqf>[player, "init", true] call BIS_fnc_exportInventory;</sqf>
-<h3 style="display:none">Notes</h3>
+|seealso= [[BIS_fnc_loadInventory]] [[BIS_fnc_deleteInventory]] [[BIS_fnc_saveInventory]] [[getUnitLoadout]]
-<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}}]]