getMissionConfig: Difference between revisions

Latest revision as of 13:18, 18 June 2023

Hover & click on the images for description

Description

Description:

Returns Config entry for the given scenario attribute from the 1st tier. The attribute can be config class or config property. If it is defined in multiple places, the command checks them in the following order:

External Description.ext file
Eden Editor scenario attribute

So if attribute exists in both places, attribute from description.ext is used. Previously, scenario attributes were extracted from Description.ext using missionConfigFile. That still works, but it ignores attributes set directly in the editor and it should not be used anymore.

Groups:

Config Mission Information

Syntax

Syntax:: getMissionConfig attribute
Parameters:: attribute: String - attribute name
Return Value:: Config

Examples

Example 1:: _header = getMissionConfig "Header";
Returns scenario header config. Replaces the previous approach which would scan only the external Description.ext file, but ignore the value set in the Eden Editor:
_header = missionConfigFile >> "Header"; // Old approach

Additional Information

See also:: getMissionConfigValue missionConfigFile BIS_fnc_getParamValue Mission_Parameters

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3dev |= Game name
+|game1= arma3
+|version1= 1.56
-|1.52|= Game version
+|gr1= Config
-____________________________________________________________________________________________
-| Returns value of a scenario attribute. The attribute can be defined on multiple places, the commands checks them in the following order:
+|gr2= Mission Information
+|descr= Returns [[Config]] entry for the given scenario attribute from the 1st tier. The attribute can be config class or config property. If it is defined in multiple places, the command checks them in the following order:
 # External ''[[Description.ext]]'' file
 # [[Eden_Editor:_Scenario_Atttributes|Eden Editor]] scenario attribute
-So if attribute exists in both files, attribute from [[description.ext]] is used. Previously, scenario attributes were extracted from ''Description.ext'' using [[missionConfigFile]]. That still works, but it ignores attributes set directly in the editor and it should not be used anymore.
+So if attribute exists in both places, attribute from [[Description.ext|description.ext]] is used. Previously, scenario attributes were extracted from ''Description.ext'' using [[missionConfigFile]]. That still works, but it ignores attributes set directly in the editor and it should not be used anymore.
-  |= Description
-____________________________________________________________________________________________
-| '''getMissionConfig''' class |= Syntax
+|s1= [[getMissionConfig]] attribute
-|p1= attribute: [[String]] - class name |= PARAMETER1
-| [[Config]] |= RETURNVALUE
-|x1= <code>_header = getMissionConfig "Header"</code>
+|p1= attribute: [[String]] - attribute name
+|r1= [[Config]]
+|x1= <sqf>_header = getMissionConfig "Header";</sqf>
 Returns scenario header config. Replaces the previous approach which would scan only the external ''Description.ext'' file, but ignore the value set in the Eden Editor:
-<code>_header = [[missionConfigFile]] >> "Header"; // Old approach</code>
+<sqf>_header = missionConfigFile >> "Header"; // Old approach</sqf>
-|= EXAMPLE1
-____________________________________________________________________________________________
-|
+|seealso= [[getMissionConfigValue]] [[missionConfigFile]] [[BIS_fnc_getParamValue]] [[Mission_Parameters]]
- [[getMissionConfigValue]]
- [[missionConfigFile]]
-|= SEEALSO
-|  |= MPBEHAVIOUR
-____________________________________________________________________________________________
 }}
-<h3 style='display:none'>Notes</h3>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<!-- DISCONTINUE Notes -->
-<h3 style='display:none'>Bottom Section</h3>
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]]