BIS fnc returnConfigEntry: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= Configs |GROUP1=")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *S([a-z ])" to "$1 - s$2")
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Configs |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Explores parent classes in the run-time config for the value of a config entry.|DESCRIPTION=
|game4= arma3
|version4= 0.50


____________________________________________________________________________________________
|gr1= Configs


| [config,attribute,defaultValue] call [[BIS_fnc_returnConfigEntry]] |SYNTAX=
|descr= Explores parent classes in the run-time config for the value of a config entry.
____________________________________________________________________________________________
|p1= config: [[Config]] - Starting config |PARAMETER1=


|p2= attribute: [[String]] - Config attribute to be returned |PARAMETER2=
|s1= [config,attribute,defaultValue] call [[BIS_fnc_returnConfigEntry]]


|p3= defaultValue: [[Anything]] - (Optional, default [[Nothing]]) Value to be returned if attribute is not existent |PARAMETER3=
|p1= config: [[Config]] - starting config
____________________________________________________________________________________________


| [[Array]], [[String]] or [[Number]] - Attribute value |RETURNVALUE=
|p2= attribute: [[String]] - config attribute to be returned
____________________________________________________________________________________________


|x1= <code>[configfile >> "Cfg3DEN" >> "Attributes" >> "ActivationType","idc"] [[call]] [[BIS_fnc_returnConfigEntry]];</code> |=
|p3= defaultValue: [[Anything]] - (Optional, default [[Nothing]]) value to be returned if attribute is not existent
____________________________________________________________________________________________


|[[configFile]], [[BIS_fnc_getCfg]], [[BIS_fnc_getCfgData]] |SEEALSO=
|r1= [[Array]], [[String]] or [[Number]] - attribute value
}}


<h3 style="display:none">Notes</h3>
|x1= <sqf>[configfile >> "Cfg3DEN" >> "Attributes" >> "ActivationType","idc"] call BIS_fnc_returnConfigEntry;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[configFile]] [[BIS_fnc_getCfg]] [[BIS_fnc_getCfgData]]
</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

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