missionConfigFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "config/name" to "config / name")
m (Some wiki formatting)
Line 1: Line 1:
[[Category:Scripting Commands|MISSIONCONFIGFILE]]
{{RV|type=command
{{GameCategory|arma1|Scripting Commands}}


|game1= arma1


{{RV|type=command
|version1= 1.00
 
| arma1


|gr1= Config
|gr1= Config


|1.00
|descr= Return root of mission [[Description.ext]] entries hierarchy.
 
| 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 is stored, use the following commands instead:
{{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:
* [[getMissionConfigValue]]
* [[getMissionConfigValue]]
* [[getMissionConfig]]}}<br>
* [[getMissionConfig]]}}
{{Warning|
{{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.}}
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.
}}


|'''missionConfigFile'''
|s1= '''missionConfigFile'''


| [[Config]]
|r1= [[Config]]


|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/>[[configName]] (([[missionConfigFile]]/"Params") [[select]] _i), [[paramsArray]] [[select]] _i];
[[missionNamespace]] [[setVariable]] [<nowiki/>[[configName]] (([[missionConfigFile]]/"Params") [[select]] _i), [[paramsArray]] [[select]] _i];
};</code>
};</code>


Line 40: Line 33:


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>
-->_myText = [[getText]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myText");</code>


|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>MISSION_ROOT = [[str]] [[missionConfigFile]] [[select]] [0, [[count]] [[str]] [[missionConfigFile]] - 15];</code> | = Example 3
<code>MISSION_ROOT = [[str]] [[missionConfigFile]] [[select]] [0, [[count]] [[str]] [[missionConfigFile]] - 15];</code>


| [[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= [[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]]
}}
}}


Line 60: Line 53:
<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]]:
<syntaxhighlight lang=cpp>
<syntaxhighlight lang="cpp">
class MissionSQM
class MissionSQM
{
{
#include "mission.sqm"
#include "mission.sqm"
};</syntaxhighlight>
};
</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>

Revision as of 00:38, 1 February 2021

Logo A1 black.png1.00
Hover & click on the images for description

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.
Groups:
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:
configClassesconfigPropertiesconfigFilecampaignConfigFileconfig / nameconfig >> nameconfigNamecountgetArraygetTextgetNumberinheritsFromisArrayisClassisNumberisTextselectconfigHierarchygetMissionConfigValuegetMissionPath

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)

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