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
-|gr1 = Inventory |GROUP1=
+|descr= Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard.
-____________________________________________________________________________________________
-| Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard. |DESCRIPTION=
+|s1= [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]]
-____________________________________________________________________________________________
-| [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]] |SYNTAX=
+|p1= unit: [[Object]] - (Optional, default [[player]]) unit whose loadout should be saved
-____________________________________________________________________________________________
-|p1= unit (Optional): [[Object]] - Unit whose loadout should be saved. Default: [[player]]|PARAMETER1=
+|p2= type: [[String]] - (Optional, default "script") export type, can be:
-|p2= type (Optional): [[String]] - Export type, can be:
+* "script"- scripting commands, target is referred to as {{hl|_unit}}
-* "script"- scripting commands, target is referred to as {{Inline code|_unit}}
+* "init" - scripting commands, target is referred to as {{hl|this}}
-* "init" - scripting commands, target is referred to as {{Inline code|this}}
 * "config" - config attributes
-Default: "script"|PARAMETER2=
-|p3= includeIdentity (Optional): [[Boolean]] - [[true]] to also export face, voice and insignia (applicable to "script" and "init" only). Default: [[true]]|PARAMETER3=
-____________________________________________________________________________________________
-| [[String]] - [[SQF]] code or [[Config]] text when "config" option is chosen|RETURNVALUE=
+|p3= includeIdentity: [[Boolean]] - (Optional, default [[true]]) [[true]] to also export face, voice and insignia (applicable to "script" and "init" only)
-____________________________________________________________________________________________
-|x1= <code><nowiki>[</nowiki>[[player]], "init", [[true]]] [[call]] [[BIS_fnc_exportInventory]];</code> |=
+|r1= [[String]] - [[SQF Syntax|SQF]] code or [[Config]] text when "config" option is chosen
-____________________________________________________________________________________________
-| [[BIS_fnc_loadInventory]], [[BIS_fnc_deleteInventory]], [[BIS_fnc_saveInventory]], [[getUnitLoadout]] |SEEALSO=
+|x1= <sqf>[player, "init", true] call BIS_fnc_exportInventory;</sqf>
+|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}}]]