BIS fnc exportInventory: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Inventory(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1 = Inventory |GROUP1= | |gr1 = Inventory |GROUP1= | ||
| Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard. |DESCRIPTION= | | Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard. |DESCRIPTION= | ||
| [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]] |SYNTAX= | | [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]] |SYNTAX= | ||
|p1= unit (Optional): [[Object]] - Unit whose loadout should be saved. Default: [[player]]|PARAMETER1= | |p1= unit (Optional): [[Object]] - Unit whose loadout should be saved. Default: [[player]]|PARAMETER1= | ||
| Line 22: | Line 18: | ||
Default: "script"|PARAMETER2= | Default: "script"|PARAMETER2= | ||
|p3= includeIdentity (Optional): [[Boolean]] - [[true]] to also export face, voice and insignia (applicable to "script" and "init" only). Default: [[true]]|PARAMETER3= | |p3= includeIdentity (Optional): [[Boolean]] - [[true]] to also export face, voice and insignia (applicable to "script" and "init" only). Default: [[true]]|PARAMETER3= | ||
| [[String]] - [[SQF]] code or [[Config]] text when "config" option is chosen|RETURNVALUE= | | [[String]] - [[SQF]] code or [[Config]] text when "config" option is chosen|RETURNVALUE= | ||
|x1= <code><nowiki>[</nowiki>[[player]], "init", [[true]]] [[call]] [[BIS_fnc_exportInventory]];</code> |= | |x1= <code><nowiki>[</nowiki>[[player]], "init", [[true]]] [[call]] [[BIS_fnc_exportInventory]];</code> |= | ||
| [[BIS_fnc_loadInventory]], [[BIS_fnc_deleteInventory]], [[BIS_fnc_saveInventory]], [[getUnitLoadout]] |SEEALSO= | | [[BIS_fnc_loadInventory]], [[BIS_fnc_deleteInventory]], [[BIS_fnc_saveInventory]], [[getUnitLoadout]] |SEEALSO= | ||
Revision as of 23:11, 16 January 2021
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
- "script"- scripting commands, target is referred to as
- 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
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