BIS fnc exportInventory: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\|= " to " ") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1 = Inventory | |gr1 = Inventory | ||
| Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard. | | Exports unit's loadout as a [[String]], also [[copyToClipboard | copies]] it to clipboard. | ||
| [unit, type, includeIdentity] call [[BIS_fnc_exportInventory]] | | [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]] | ||
|p2= type (Optional): [[String]] - Export type, can be: | |p2= type (Optional): [[String]] - Export type, can be: | ||
* "script"- scripting commands, target is referred to as {{Inline code|_unit}} | * "script"- scripting commands, target is referred to as {{Inline code|_unit}} | ||
* "init" - scripting commands, target is referred to as {{Inline code|this}} | * "init" - scripting commands, target is referred to as {{Inline code|this}} | ||
* "config" - config attributes | * "config" - config attributes | ||
Default: "script" | Default: "script" | ||
|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]] | ||
| [[String]] - [[SQF]] code or [[Config]] text when "config" option is chosen | | [[String]] - [[SQF]] code or [[Config]] text when "config" option is chosen | ||
|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]] | | [[BIS_fnc_loadInventory]], [[BIS_fnc_deleteInventory]], [[BIS_fnc_saveInventory]], [[getUnitLoadout]] | ||
}} | }} | ||
Revision as of 00:02, 18 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