BIS fnc exportInventory: Difference between revisions

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


| [unit,type,identity] call [[BIS_fnc_exportInventory]] |SYNTAX=
| [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]] |SYNTAX=
____________________________________________________________________________________________
____________________________________________________________________________________________


|p1= unit: [[Object]] - Unit whose loadout should be saved|PARAMETER1=
|p1= unit (Optional): [[Object]] - Unit whose loadout should be saved. Default: [[player]]|PARAMETER1=
|p2= type: [[String]] - Export type, can be:
|p2= type (Optional): [[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" - config attributes|PARAMETER2=
*3: "config" - config attributes
|p3= identity: [[Boolean]] - [[True]] to also export face, voice and insignia (applicable to "script" and "init" only)|PARAMETER3=
Default: "script"|PARAMETER2=
|p3= includeIdentity (Optional): [[Boolean]] - [[true]] to also export face, voice and insignia (applicable to "script" and "init" only). Default: [[true]]|PARAMETER3=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 24: Line 25:
____________________________________________________________________________________________
____________________________________________________________________________________________


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



Revision as of 20:07, 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, includeIdentity] call BIS_fnc_exportInventory
Parameters:
unit (Optional): Object - Unit whose loadout should be saved. Default: player
type (Optional): 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
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


Notes

Bottom Section