BIS fnc configViewer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Lou Montana moved page BIS fnc configviewer to BIS fnc configViewer: bad capitalisation)
m (Fix configviewer → configViewer)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Splendid config viewer |= Description
| Splendid™ Config Viewer. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 18: Line 18:
|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 |= Parameter 3
|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 |= Parameter 3


|p4= onSelect: [[Code]] - (Optional, default {}) executed upon selecting a class. '''Has to return STRING''', which will be shown as structured text instead of params.|= Parameter 4
|p4= onSelect: [[Code]] - (Optional, default {}) executed upon selecting a class. '''Must return [[String]]''', which will be shown as structured text instead of params. |= Parameter 4


|p5= onAdd: [[Code]] - (Optional, default {}) executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. |= Parameter 5
|p5= onAdd: [[Code]] - (Optional, default {}) executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. |= Parameter 5
Line 29: Line 29:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[[call]] [[BIS_fnc_configviewer]];</code> |= Example 1
|x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_animViewer]] |= See also
| [[BIS_fnc_animViewer]], [[BIS_fnc_help]] |= See also
}}
}}



Revision as of 11:26, 7 May 2018

Hover & click on the images for description

Description

Description:
Splendid™ Config Viewer.
Execution:
call
Groups:
Uncategorised

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