Difference between revisions of "missionConfigFile"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
(10 intermediate revisions by 7 users not shown)
Line 4: Line 4:
 
[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]]
  
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma |= Game name
+
| arma |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Return root of mission description.ext entries hierarchy. |= Description
+
| Return root of mission [[Description.ext]] entries hierarchy.
 +
<br><br>
 +
{{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's stored, use the following commands instead:
 +
* [[getMissionConfigValue]]
 +
* [[getMissionConfig]]}}<br>
 +
{{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.
 +
}} |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|'''missionConfigFile''' |= Syntax
+
|'''missionConfigFile''' |SYNTAX=
  
| [[Config]] |= Return value
+
| [[Config]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
 
|x1= <code>[[for]] "_i" [[from]] (0) [[to]] (([[count]] [[paramsArray]]) - 1) [[do]] {
 
|x1= <code>[[for]] "_i" [[from]] (0) [[to]] (([[count]] [[paramsArray]]) - 1) [[do]] {
 
     [[missionNamespace]] [[setVariable]] <nowiki>[</nowiki>[[configName]] (([[missionConfigFile]]/"Params") [[select]] _i), [[paramsArray]] [[select]] _i];
 
     [[missionNamespace]] [[setVariable]] <nowiki>[</nowiki>[[configName]] (([[missionConfigFile]]/"Params") [[select]] _i), [[paramsArray]] [[select]] _i];
};</code> |= Example 1
+
};</code> |EXAMPLE1=
  
 
|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 40:
 
         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");
 
_myArray = [[getArray]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myArray");
 
_myArray = [[getArray]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myArray");
_myText = [[getText]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myText");</code> |= Example 2
+
_myText = [[getText]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myText");</code> |EXAMPLE2=
  
 
|x3= To get file path with [[description.ext]] to play sound via [[playSound3D]]:
 
|x3= To get file path with [[description.ext]] to play sound via [[playSound3D]]:
<code>_filePath = [([[str]] [[missionConfigFile]]), 0, -15] [[call]] [[BIS_fnc_trimString]];</code> | = Example 3
+
<code>MISSION_ROOT = [[str]] [[missionConfigFile]] [[select]] [0, [[count]] [[str]] [[missionConfigFile]] - 15];</code> | = Example 3
 
 
|x4= Obtaining mission root using A3 substring functionality
 
<code>MISSION_ROOT = [[str]] [[missionConfigFile]] [[select]] [0, [[count]] [[str]] [[missionConfigFile]] - 15];</code>
 
|= Example 4
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[configClasses]], [[configProperties]], [[configFile]], [[campaignConfigFile]], [[config/name]], [[config greater greater name|config >> name]], [[configName]], [[count]], [[getArray]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |= See also
+
| [[configClasses]], [[configProperties]], [[configFile]], [[campaignConfigFile]], [[config/name]], [[config greater greater name|config >> name]], [[configName]], [[count]], [[getArray]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]], [[configHierarchy]], [[getMissionConfigValue]], [[getMissionPath]] |SEEALSO=
  
 
}}
 
}}
Line 70: Line 73:
 
<dd class="note">
 
<dd class="note">
 
[[missionConfigFile]] can be used to parse ''mission.sqm'' file data as well if it is included into [[description.ext]]:
 
[[missionConfigFile]] can be used to parse ''mission.sqm'' file data as well if it is included into [[description.ext]]:
<pre>
+
<syntaxhighlight lang=cpp>
 
class MissionSQM
 
class MissionSQM
 
{
 
{
 
#include "mission.sqm"
 
#include "mission.sqm"
};</pre>
+
};</syntaxhighlight>
 
Then ''mission.sqm'' data can be accessed like this:
 
Then ''mission.sqm'' data can be accessed like this:
 
<code>[[getNumber]] ([[missionConfigFile]] >> "MissionSQM" >> "version"); //12 - version param in ''mission.sqm''</code>
 
<code>[[getNumber]] ([[missionConfigFile]] >> "MissionSQM" >> "version"); //12 - version param in ''mission.sqm''</code>
(courtesy of [[User:Master85|Master85]])
+
(courtesy of [[Special:Contributions/Master85|Master85]])
 
</dd>
 
</dd>
 
</dl>
 
</dl>
 
<!-- DISCONTINUE Notes -->
 
<!-- DISCONTINUE Notes -->

Revision as of 04:35, 1 September 2019


Template:Command

Notes

Bottom Section

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)