BIS fnc returnConfigEntry: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (pf)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Explores parent classes in the run-time config for the value of a config entry.|= Description


Description:
____________________________________________________________________________________________
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
|  [config,attribute,defaultValue] call [[BIS_fnc_returnConfigEntry]] |= Syntax
____________________________________________________________________________________________
____________________________________________________________________________________________
|p1= config: [[Config]] - Starting config |= Parameter 1


| <!-- [] call [[BIS_fnc_returnConfigEntry]]; --> |= Syntax
|p2= attribute: [[String]] - Config attribute to be returned |= Parameter 2


|p1= |= Parameter 1
|p3= defaultValue: [[Anything]] - (Optional, default [[Nothing]]) Value to be returned if attribute is not existent |= Parameter 3
____________________________________________________________________________________________


| |= Return value
| [[Array]], [[String]] or [[Number]] - Attribute value |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[configfile >> "Cfg3DEN" >> "Attributes" >> "ActivationType","idc"] [[call]] [[BIS_fnc_returnConfigEntry]];</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
|[[configFile]], [[BIS_fnc_getCfg]], [[BIS_fnc_getCfgData]] |= See also
 
}}
}}


Revision as of 09:16, 2 July 2018

Logo A2.png1.00
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:
Uncategorised

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_returnConfigEntry&oldid=108799"