BIS fnc exportInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "| arma3 |1.00 " to "|game1= arma3 |version1= 1.00 ")
m (Text replacement - " |r1=[[" to " |r1= [[")
Line 18: Line 18:
|p3= includeIdentity (Optional): [[Boolean]] - [[true]] to also export face, voice and insignia (applicable to "script" and "init" only). Default: [[true]]
|p3= includeIdentity (Optional): [[Boolean]] - [[true]] to also export face, voice and insignia (applicable to "script" and "init" only). Default: [[true]]


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


|x1= <code>[<nowiki/>[[player]], "init", [[true]]] [[call]] [[BIS_fnc_exportInventory]];</code>
|x1= <code>[<nowiki/>[[player]], "init", [[true]]] [[call]] [[BIS_fnc_exportInventory]];</code>

Revision as of 22:25, 7 August 2021

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_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