getMissionConfig: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[cC]ommand[_ ][gG]roup:[_ ][^|]+\|\{*uc:{{PAGENAME}*]\]" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


|arma3|Game name=
|arma3


|1.56|Game version=
|1.56


|gr1= Config |GROUP1=
|gr1= Config


|gr2= Mission Information |GROUP2=
|gr2= Mission Information


| 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:
| 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:
Line 13: Line 13:
# [[Eden_Editor:_Scenario_Atttributes|Eden Editor]] scenario attribute
# [[Eden_Editor:_Scenario_Atttributes|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.
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.
  |DESCRIPTION=


| '''getMissionConfig''' attribute |SYNTAX=
 
|p1= attribute: [[String]] - attribute name |PARAMETER1=
| '''getMissionConfig''' attribute
| [[Config]] |RETURNVALUE=
|p1= attribute: [[String]] - attribute name
| [[Config]]


|x1= <code>_header = [[getMissionConfig]] "Header"</code>
|x1= <code>_header = [[getMissionConfig]] "Header"</code>
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:
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>
<code>_header = [[missionConfigFile]] >> "Header"; // Old approach</code>
|EXAMPLE1=


| [[getMissionConfigValue]], [[missionConfigFile]] |SEEALSO=
 
| [[getMissionConfigValue]], [[missionConfigFile]]
|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  
}}
}}

Revision as of 00:40, 18 January 2021

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:
  1. External Description.ext file
  2. 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:
ConfigMission 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:
getMissionConfigValuemissionConfigFile

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