BIS fnc exportInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)<nowiki\/>\[\[([a-zA-Z0-9_]+)\]\](.*)<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "= <code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-_]+)\]\]([^<]*)<\/code>" to "= <code>$1$2$3</code>")
Line 20: Line 20:
|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>[player, "init", [[true]]] [[call]] [[BIS_fnc_exportInventory]];</code>
|x1= <code>[player, "init", true] [[call]] [[BIS_fnc_exportInventory]];</code>


|seealso= [[BIS_fnc_loadInventory]] [[BIS_fnc_deleteInventory]] [[BIS_fnc_saveInventory]] [[getUnitLoadout]]
|seealso= [[BIS_fnc_loadInventory]] [[BIS_fnc_deleteInventory]] [[BIS_fnc_saveInventory]] [[getUnitLoadout]]
}}
}}

Revision as of 16:56, 13 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