BIS fnc exportInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
m (Text replacement - " |s1=[" to " |s1= [")
Line 8: Line 8:
|descr= Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard.
|descr= Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard.


|s1=[unit, type, includeIdentity] call [[BIS_fnc_exportInventory]]
|s1= [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]]


|p1= unit (Optional): [[Object]] - Unit whose loadout should be saved. Default: [[player]]
|p1= unit (Optional): [[Object]] - Unit whose loadout should be saved. Default: [[player]]

Revision as of 23:11, 12 July 2022

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 (Optional): Object - Unit whose loadout should be saved. Default: player
type (Optional): String - 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
Default: "script"
includeIdentity (Optional): Boolean - true to also export face, voice and insignia (applicable to "script" and "init" only). Default: true
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