Difference between revisions of "missionConfigFile"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (<code> tidy)
m (Text replacement - "\|game([0-9]) ?= (.+) \|version([0-9]) ?= (.+) " to "|game$1= $2 |version$3= $4 ")
 
(49 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|MISSIONCONFIGFILE]]
+
{{RV|type=command
[[Category:Scripting Commands ArmA|MISSIONCONFIGFILE]]
 
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]]
 
  
{{Command|= Comments
+
|game1= arma1
____________________________________________________________________________________________
+
|version1= 1.00
  
| arma |= Game name
+
|game2= arma2
 +
|version2= 1.00
  
|1.00|= Game version
+
|game3= arma2oa
____________________________________________________________________________________________
+
|version3= 1.50
  
| Return root of mission description.ext entries hierarchy. |= Description
+
|game4= tkoh
____________________________________________________________________________________________
+
|version4= 1.00
  
|[[Config]] <nowiki>=</nowiki> '''missionConfigFile''' |= Syntax
+
|game5= arma3
 +
|version5= 0.50
  
| [[Config]] |= Return value
+
|gr1= Config
____________________________________________________________________________________________
 
  
|x1= <code>[[for]] "_i" [[from]] (0) [[to]] ((count paramsArray) - 1) [[do]] {
+
|descr= Return root of mission [[Description.ext]] entries hierarchy.
    [[missionNamespace]] [[setVariable]] <nowiki>[</nowiki>[[configName]] (([[missionConfigFile]]/"Params") [[select]] _i), [[paramsArray]] [[select]] _i];
+
{{Feature|important|Since introduction of the [[Eden Editor]], scenario attributes can be configured in the editor itself, not only in the external Description.ext file. To access desired value independently on where it is stored, use the following commands instead:
};</code> |= Example 1
+
* [[getMissionConfigValue]]
 +
* [[getMissionConfig]]}}
 +
{{Feature|Warning|If your [[Description.ext]] file is empty, [[str]] [[missionConfigFile]] may report an empty string instead of the path to the file. You have to put at least one entry into your config.}}
 +
 
 +
|s1= '''missionConfigFile'''
 +
 
 +
|r1= [[Config]]
 +
 
 +
|x1= <code>[[for]] "_i" [[from]] 0 [[to]] ([[count]] [[paramsArray]] - 1) [[do]] {
 +
[[missionNamespace]] [[setVariable]] [<nowiki/>[[configName]] (([[missionConfigFile]]/"Params") [[select]] _i), [[paramsArray]] [[select]] _i];
 +
};</code>
  
 
|x2= To define custom values in [[description.ext]]:
 
|x2= To define custom values in [[description.ext]]:
<code>class myMissionConfig
+
<syntaxhighlight lang=cpp>class myMissionConfig
 
{
 
{
 
     class mySetup
 
     class mySetup
Line 33: Line 41:
 
         myText = "LOL";
 
         myText = "LOL";
 
     };
 
     };
};</code>
+
};</syntaxhighlight>
  
 
To read defined custom values from a script:
 
To read defined custom values from a script:
<code>_myNumber = [[getNumber]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myNumber");
+
<code>_myNumber = [[getNumber]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myNumber");<br><!--
_myArray = [[getArray]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myArray");
+
-->_myArray = [[getArray]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myArray");<br><!--
_myText = [[getText]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myText");</code> |= Example 2
+
-->_myText = [[getText]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myText");</code>
____________________________________________________________________________________________
 
  
| [[configFile]], [[campaignConfigFile]], [[config/name]], [[config greater greater name|config >> name]], [[configName]], [[count]], [[getArray]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |= See also
+
|x3= To get file path with [[description.ext]] to play sound via [[playSound3D]]:
 +
<code>MISSION_ROOT = [[str]] [[missionConfigFile]] [[select]] [0, [[count]] [[str]] [[missionConfigFile]] - 15];</code>
  
 +
|seealso=[[configFile]] [[campaignConfigFile]] [[getMissionConfigValue]] [[getMissionConfig]] [[getMissionPath]]
 
}}
 
}}
 
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
+
<dt></dt>
 
+
<dd class="notedate">Posted on February 17, 2015 - 16:46 (UTC)</dd>
<!-- Note Section END -->
+
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 +
<dd class="note">
 +
[[missionConfigFile]] can be used to parse ''mission.sqm'' file data as well if it is included into [[description.ext]]:
 +
<syntaxhighlight lang="cpp">
 +
class MissionSQM
 +
{
 +
#include "mission.sqm"
 +
};
 +
</syntaxhighlight>
 +
Then ''mission.sqm'' data can be accessed like this:
 +
<code>[[getNumber]] ([[missionConfigFile]] >> "MissionSQM" >> "version"); //12 - version param in ''mission.sqm''</code>
 +
(courtesy of [[Special:Contributions/Master85|Master85]])
 +
</dd>
 
</dl>
 
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 16:53, 3 May 2021

Hover & click on the images for descriptions

Description

Description:
Return root of mission Description.ext entries hierarchy.
Since introduction of the Eden Editor, scenario attributes can be configured in the editor itself, not only in the external Description.ext file. To access desired value independently on where it is stored, use the following commands instead:
If your Description.ext file is empty, str missionConfigFile may report an empty string instead of the path to the file. You have to put at least one entry into your config.

Syntax

Syntax:
missionConfigFile
Return Value:
Config

Examples

Example 1:
for "_i" from 0 to (count paramsArray - 1) do { missionNamespace setVariable [configName ((missionConfigFile/"Params") select _i), paramsArray select _i]; };
Example 2:
To define custom values in description.ext:
class myMissionConfig
{
    class mySetup
    {
        myNumber = 3;
        myArray[] = { 1, 2, 3 };
        myText = "LOL";
    };
};

To read defined custom values from a script:

_myNumber = getNumber (missionConfigFile >> "myMissionConfig" >> "mySetup" >> "myNumber");
_myArray = getArray (missionConfigFile >> "myMissionConfig" >> "mySetup" >> "myArray");
_myText = getText (missionConfigFile >> "myMissionConfig" >> "mySetup" >> "myText");
Example 3:
To get file path with description.ext to play sound via playSound3D: MISSION_ROOT = str missionConfigFile select [0, count str missionConfigFile - 15];

Additional Information

See also:
configFile campaignConfigFile getMissionConfigValue getMissionConfig getMissionPath
Groups:
Config

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
Posted on February 17, 2015 - 16:46 (UTC)
Killzone Kid
missionConfigFile can be used to parse mission.sqm file data as well if it is included into description.ext:
class MissionSQM
{
	#include "mission.sqm"
};

Then mission.sqm data can be accessed like this: getNumber (missionConfigFile >> "MissionSQM" >> "version"); //12 - version param in mission.sqm (courtesy of Master85)