BIS fnc configViewer: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (Text replacement - "|gr1 = Debug |GROUP1=" to "|gr1 = Diagnostic |GROUP1=") |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Function|= | {{Function|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma2oa | | | arma2oa |Game name= | ||
|1.00| | |1.00|Game version= | ||
|gr1 = Diagnostic |GROUP1= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 12: | Line 14: | ||
| [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]] |SYNTAX= | | [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]] |SYNTAX= | ||
|p1= parent: [[Display]] - (Optional, default mission display) parent display |= | |p1= parent: [[Display]] - (Optional, default mission display) parent display |PARAMETER1= | ||
|p2= cfg: [[Config]] - (Optional, default all configs) root config |= | |p2= cfg: [[Config]] - (Optional, default all configs) root config |PARAMETER2= | ||
|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 |PARAMETER3= | ||
|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. |PARAMETER4= | ||
|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. |PARAMETER5= | ||
|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") |PARAMETER6= | ||
| [[Array]] | | [[Array]] | ||
| Line 29: | Line 31: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> |= | |x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 43: | Line 45: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Functions|{{uc:configViewer}}]] | [[Category:Functions|{{uc:configViewer}}]] | ||
[[Category:{{Name|arma2oa}}: Functions|{{uc:configViewer}}]] | [[Category:{{Name|arma2oa}}: Functions|{{uc:configViewer}}]] | ||
[[Category:{{Name|tkoh}}: Functions|{{uc:configViewer}}]] | [[Category:{{Name|tkoh}}: Functions|{{uc:configViewer}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:configViewer}}]] | [[Category:{{Name|arma3}}: Functions|{{uc:configViewer}}]] | ||
Revision as of 17:38, 11 October 2020
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