BIS fnc configViewer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatting)
m (Some wiki formatting)
Line 2: Line 2:


|game1= arma2oa
|game1= arma2oa
|version1= 1.50
|version1= 1.50


|game2= tkoh
|game2= tkoh
|version2= 1.00
|version2= 1.00


|game3= arma3
|game3= arma3
|version3= 0.50
|version3= 0.50


Line 23: Line 20:
|p2= cfg: [[Config]] - (Optional, default all configs) Root config
|p2= cfg: [[Config]] - (Optional, default all configs) Root config


|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
|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. Currently evaluated config is passed in the {{ic|_this}} variable.
|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 {}) 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.
|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") 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")


|r1= [[Array]]
|r1= [[Array]]
Line 48: Line 45:
{ {{cc|Layzy evaluation}}
{ {{cc|Layzy evaluation}}
[[getNumber]](_cfg >> "type") [[in]] [1,2,4] && {{cc|primary, secondary, handgun weapons}}
[[getNumber]](_cfg >> "type") [[in]] [1,2,4] && {{cc|primary, secondary, handgun weapons}}
{![[isClass]] (_cfg >> "LinkedItems") [[or]] [[getText]](_cfg >> "baseWeapon") == [[configName]] _cfg} {{cc|only base weapons, no accesories}}
{ ![[isClass]] (_cfg >> "LinkedItems") [[or]] [[getText]](_cfg >> "baseWeapon") == [[configName]] _cfg } {{cc|only base weapons, no accessories}}
}
}
) [[exitWith]] {
) [[exitWith]] {
[_cfg] [[call]] [[BIS_fnc_displayName]]; {{cc|Add the weapon with its displayname}}
[_cfg] [[call]] [[BIS_fnc_displayName]]; {{cc|add the weapon with its displayname}}
};
};
"" {{cc|Don't add}}
"" {{cc|don't add}}
},
},
"Select Weapon"
"Select Weapon"

Revision as of 20:44, 10 June 2021

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_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_configViewer&oldid=264227"