BIS fnc configViewer: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" 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 | ||
| arma2oa | | arma2oa | ||
|1.00 | |1.00 | ||
|gr1 = Diagnostic | |gr1 = Diagnostic | ||
| Splendid™ Config Viewer. | | Splendid™ Config Viewer. | ||
| [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]] | | [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]] | ||
|p1= parent: [[Display]] - (Optional, default mission display) parent display | |p1= parent: [[Display]] - (Optional, default mission display) parent display | ||
|p2= cfg: [[Config]] - (Optional, default all configs) root config | |p2= cfg: [[Config]] - (Optional, default all configs) root config | ||
|p3= showOk: [[Boolean]] - (Optional, default [[false]]) true to display OK button. Script will then wait until viewer is closed and return selected class and param | |p3= showOk: [[Boolean]] - (Optional, default [[false]]) true to display OK button. Script will then wait until viewer is closed and return selected class and param | ||
|p4= onSelect: [[Code]] - (Optional, default {}) executed upon selecting a class. '''Must return [[String]]''', which will be shown as structured text instead of params. | |p4= onSelect: [[Code]] - (Optional, default {}) executed upon selecting a class. '''Must return [[String]]''', which will be shown as structured text instead of params. | ||
|p5= onAdd: [[Code]] - (Optional, default {}) executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. | |p5= onAdd: [[Code]] - (Optional, default {}) executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. | ||
|p6= header: [[String]] - (Optional, default "%1") custom header. Use %1 to refer to original name ("Splendid Config Viewer") | |p6= header: [[String]] - (Optional, default "%1") custom header. Use %1 to refer to original name ("Splendid Config Viewer") | ||
| [[Array]] | | [[Array]] | ||
* when OK button is not displayed, empty array is returned | * when OK button is not displayed, empty array is returned | ||
* else, an array of currently selected entries in format [class ([[Config]]), param ([[String]])] is returned. | * else, an array of currently selected entries in format [class ([[Config]]), param ([[String]])] is returned. | ||
|x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> | |x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> | ||
| [[BIS_fnc_animViewer]], [[BIS_fnc_help]] | | [[BIS_fnc_animViewer]], [[BIS_fnc_help]] | ||
}} | }} | ||
Revision as of 22:36, 17 January 2021
Description
- Description:
- Splendid™ Config Viewer.
- Execution:
- call
- Groups:
- Diagnostic
Syntax
- Syntax:
- [parent, cfg, showOk, onSelect, onAdd, header] call BIS_fnc_configViewer
- Parameters:
- parent: Display - (Optional, default mission display) parent display
- cfg: Config - (Optional, default all configs) root config
- showOk: Boolean - (Optional, default false) true to display OK button. Script will then wait until viewer is closed and return selected class and param
- onSelect: Code - (Optional, default {}) executed upon selecting a class. Must return String, which will be shown as structured text instead of params.
- onAdd: Code - (Optional, default {}) executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item.
- header: String - (Optional, default "%1") custom header. Use %1 to refer to original name ("Splendid Config Viewer")
- Return Value:
- Array
Examples
- Example 1:
call BIS_fnc_configViewer;
Additional Information
- See also:
- BIS_fnc_animViewerBIS_fnc_help
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