BIS fnc configViewer: Difference between revisions
Jump to navigation
Jump to search
(filtered example with return) |
m (formatting) |
||
Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma2oa | |game1= arma2oa | ||
|1.50 | |version1= 1.50 | ||
|game2= tkoh | |||
|version2= 1.00 | |||
|game3= arma3 | |||
|version3= 0.50 | |||
|gr1= Diagnostic | |gr1= Diagnostic | ||
| Opens the [[Arma 3: Splendid Config Viewer|Splendid™ Config Viewer]]. | |descr= Opens the [[Arma 3: Splendid Config Viewer|Splendid™ Config Viewer]]. | ||
| [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]] | |s1= [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) | |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|true]] to display OK button. Script will then wait until viewer is closed and return selected class and param | ||
|p4= onSelect: [[Code]] - (Optional, default {}) | |p4= onSelect: [[Code]] - (Optional, default {}) Executed upon selecting a class. '''Must return [[String]]''', which will be shown as structured text instead of params. Currently evaluated config is passed in the {{ic|_this}} variable. | ||
|p5= onAdd: [[Code]] - (Optional, default {}) | |p5= onAdd: [[Code]] - (Optional, default {}) Executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. Currently evaluated config is passed in the {{ic|_this}} variable. | ||
|p6= header: [[String]] - (Optional, default "%1") | |p6= header: [[String]] - (Optional, default "%1") Custom header. Use %1 to refer to original name ("Splendid Config Viewer") | ||
| [[Array]] | |r1= [[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. | ||
|x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> | |x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> | ||
|x2= <code>[[private]] _return = [ | |x2= <code>[[private]] _return = [ | ||
[[nil]], | [[nil]], | ||
Line 53: | Line 62: | ||
|seealso= [[BIS_fnc_animViewer]], [[BIS_fnc_help]] | |seealso= [[BIS_fnc_animViewer]], [[BIS_fnc_help]] | ||
}} | }} | ||
Revision as of 12:13, 13 May 2021
Description
- Description:
- Opens the 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. Currently evaluated config is passed in the
_this
variable. - onAdd: Code - (Optional, default {}) Executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. Currently evaluated config is passed in the
_this
variable. - 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;
- Example 2:
private _return = [ nil, configFile >> "CfgWeapons", true, nil, { params ["_cfg"]; if ( getNumber(_cfg >> "scope") == 2 && { // Layzy evaluation getNumber(_cfg >> "type") in [1,2,4] && // primary, secondary, handgun weapons {!isClass (_cfg >> "LinkedItems") or getText(_cfg >> "baseWeapon") == configName _cfg} // only base weapons, no accesories } ) exitWith { [_cfg] call BIS_fnc_displayName; // Add the weapon with its displayname }; "" // Don't add }, "Select Weapon" ] call BIS_fnc_configViewer; _cfgSelected = _return param [0, configNull]; systemChat str [configName _cfgSelected, _cfgSelected];
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