BIS fnc returnConfigEntry: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *S([a-z ])" to "$1 - s$2")
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>/*
|game4= arma3
|version4= 0.50


Description:
|gr1= Configs
Explores parent classes in the run-time config for the value of a config entry.
Parameter(s):
_this select 0: starting config class (Config)
_this select 1: queried entry name (String)
_this select 2 (Optional): default value returned in case the entry does not exist
Returns:
Number / String - value of the found entry
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|descr= Explores parent classes in the run-time config for the value of a config entry.
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_returnConfigEntry]]; --> |= Syntax
|s1= [config,attribute,defaultValue] call [[BIS_fnc_returnConfigEntry]]


|p1= |= Parameter 1
|p1= config: [[Config]] - starting config


| |= Return value
|p2= attribute: [[String]] - config attribute to be returned
____________________________________________________________________________________________


|x1= <code></code> |=
|p3= defaultValue: [[Anything]] - (Optional, default [[Nothing]]) value to be returned if attribute is not existent
____________________________________________________________________________________________


| |= See also
|r1= [[Array]], [[String]] or [[Number]] - attribute value


|x1= <sqf>[configfile >> "Cfg3DEN" >> "Attributes" >> "ActivationType","idc"] call BIS_fnc_returnConfigEntry;</sqf>
|seealso= [[configFile]] [[BIS_fnc_getCfg]] [[BIS_fnc_getCfgData]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Configs|{{uc:returnConfigEntry}}]]
[[Category:Functions|{{uc:returnConfigEntry}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:returnConfigEntry}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:returnConfigEntry}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:returnConfigEntry}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:returnConfigEntry}}]]

Latest revision as of 16:49, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Explores parent classes in the run-time config for the value of a config entry.
Execution:
call
Groups:
Configs

Syntax

Syntax:
[config,attribute,defaultValue] call BIS_fnc_returnConfigEntry
Parameters:
config: Config - starting config
attribute: String - config attribute to be returned
defaultValue: Anything - (Optional, default Nothing) value to be returned if attribute is not existent
Return Value:
Array, String or Number - attribute value

Examples

Example 1:
[configfile >> "Cfg3DEN" >> "Attributes" >> "ActivationType","idc"] call BIS_fnc_returnConfigEntry;

Additional Information

See also:
configFile BIS_fnc_getCfg BIS_fnc_getCfgData

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_returnConfigEntry&oldid=349149"