BIS fnc configViewer: Difference between revisions

Latest revision as of 12:32, 8 November 2023

1.50

1.00

0.50

Hover & click on the images for description

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

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;
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 accessories } ) 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_animViewer BIS_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

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma2oa
+|game1= arma2oa
+|version1= 1.50
-|1.50
+|game2= tkoh
+|version2= 1.00
-|gr1 = Diagnostic
+|game3= arma3
+|version3= 0.50
-| Splendid™ Config Viewer.
+|gr1= Diagnostic
-| [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]]
+|descr= Opens the [[Arma 3: Splendid Config Viewer|Splendid&trade; Config Viewer]].
+|s1= [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]]
 |p1= parent: [[Display]] - (Optional, default mission display) parent display
@@ Line 15: / Line 20: @@
 |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. Currently evaluated config is passed in the {{hl|_this}} variable.
-|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. Currently evaluated config is passed in the {{hl|_this}} variable.
 |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
+* 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= <sqf>call BIS_fnc_configViewer;</sqf>
-| [[BIS_fnc_animViewer]], [[BIS_fnc_help]]
+|x2= <sqf>
+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 accessories
+			}
+		) 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];
+</sqf>
+|seealso= [[BIS_fnc_animViewer]] [[BIS_fnc_help]]
 }}
-[[Category:{{Name|arma2oa}}: Functions|{{uc:configViewer}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:configViewer}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:configViewer}}]]