BIS fnc configViewer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|gr1 = Debug |GROUP1=" to "|gr1 = Diagnostic |GROUP1=")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma2oa |Game name=
| arma2oa |Game name=
Line 7: Line 6:


|gr1 = Diagnostic |GROUP1=
|gr1 = Diagnostic |GROUP1=
____________________________________________________________________________________________


| Splendid™ Config Viewer. |DESCRIPTION=
| Splendid™ Config Viewer. |DESCRIPTION=
____________________________________________________________________________________________


| [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]] |SYNTAX=
| [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]] |SYNTAX=
Line 29: Line 26:
* 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. |RETURNVALUE=
* else, an array of currently selected entries in format [class ([[Config]]), param ([[String]])] is returned. |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> |EXAMPLE1=
|x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[BIS_fnc_animViewer]], [[BIS_fnc_help]] |SEEALSO=
| [[BIS_fnc_animViewer]], [[BIS_fnc_help]] |SEEALSO=

Revision as of 22:35, 16 January 2021

Hover & click on the images for description

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
  • 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.

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

Notes

Bottom Section