BIS fnc exportInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(corrected)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Export unit's loadout. |DESCRIPTION=
| Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 15: Line 15:
|p1= unit: [[Object]] - Unit whose loadout should be saved|PARAMETER1=
|p1= unit: [[Object]] - Unit whose loadout should be saved|PARAMETER1=
|p2= type: [[String]] - Export type, can be:
|p2= type: [[String]] - Export type, can be:
*1: "script"- Scripting commands, target is referred to as {{Inline code|_unit}}
*1: "script"- scripting commands, target is referred to as {{Inline code|_unit}}
*2: "init" - Scripting commands, target is referred to as {{Inline code|this}}
*2: "init" - scripting commands, target is referred to as {{Inline code|this}}
*3: "config" - CfgVehicles attributes|PARAMETER2=
*3: "config" - config attributes|PARAMETER2=
|p3= identity: [[Boolean]] - [[True]] to also export face, voice and insignia|PARAMETER3=
|p3= identity: [[Boolean]] - [[True]] to also export face, voice and insignia (applicable to "script" and "init" only)|PARAMETER3=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[String]] - [[SQF]] code |RETURNVALUE=
| [[String]] - [[SQF]] code or [[Config]] text when "config" option is chosen|RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 20:01, 9 June 2019

Hover & click on the images for description

Description

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

Syntax

Syntax:
[unit,type,identity] call BIS_fnc_exportInventory
Parameters:
unit: Object - Unit whose loadout should be saved
type: String - Export type, can be:
  • 1: "script"- scripting commands, target is referred to as _unit
  • 2: "init" - scripting commands, target is referred to as this
  • 3: "config" - config attributes
identity: Boolean - 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_loadInventoryBIS_fnc_deleteInventoryBIS_fnc_saveInventorygetUnitLoadout

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