BIS fnc configViewer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix configviewer → configViewer)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )R([a-z])" to "$1r$3")
 
(48 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma2oa |= Game name
|game1= arma2oa
|version1= 1.50


|1.00|= Game version
|game2= tkoh
____________________________________________________________________________________________
|version2= 1.00


| Splendid™ Config Viewer. |= Description
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configviewer]] |= Syntax
|gr1= Diagnostic


|p1= parent: [[Display]] - (Optional, default mission display) parent display |= Parameter 1
|descr= Opens the [[Arma 3: Splendid Config Viewer|Splendid™ Config Viewer]].


|p2= cfg: [[Config]] - (Optional, default all configs) root config |= Parameter 2
|s1= [parent, cfg, showOk, onSelect, onAdd, header] call [[BIS_fnc_configViewer]]


|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
|p1= parent: [[Display]] - (Optional, default mission display) parent display


|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
|p2= cfg: [[Config]] - (Optional, default all configs) root config


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


|p6= header: [[String]] - (Optional, default "%1") custom header. Use %1 to refer to original name ("Splendid Config Viewer") |= Parameter 6
|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.


| [[Array]]
|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.
* 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. |= Return value
____________________________________________________________________________________________


|x1= <code>[[call]] [[BIS_fnc_configViewer]];</code> |= Example 1
|p6= header: [[String]] - (Optional, default "%1") custom header. Use %1 to refer to original name ("Splendid Config Viewer")
____________________________________________________________________________________________


| [[BIS_fnc_animViewer]], [[BIS_fnc_help]] |= See also
|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.


<h3 style="display:none">Notes</h3>
|x1= <sqf>call BIS_fnc_configViewer;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>
</dl>
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>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[BIS_fnc_animViewer]] [[BIS_fnc_help]]
[[Category:Function Group: Debug|{{uc:configviewer}}]]
}}
[[Category:Functions|{{uc:configviewer}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:configviewer}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:configviewer}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:configviewer}}]]

Latest revision as of 12:32, 8 November 2023

A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_configViewer&oldid=348118"