missionConfigFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Example 3 doesn't work when description.ext is empty)
(format)
Line 13: Line 13:


| Return root of mission [[Description.ext]] entries hierarchy.
| Return root of mission [[Description.ext]] entries hierarchy.
<br />
<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:
{{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]]
* [[getMissionConfigValue]]
* [[getMissionConfig]]}}
* [[getMissionConfig]]}}<br>
{{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.
Line 32: Line 32:


|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 40: Line 40:
         myText = "LOL";
         myText = "LOL";
     };
     };
};</code>
};</syntaxhighlight>


To read defined custom values from a script:
To read defined custom values from a script:
Line 73: 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>

Revision as of 14:11, 19 November 2018


-wrong parameter ("Arma") defined!-1.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's 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:
Uncategorised

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 >> nameconfigNamecountgetArraygetTextgetNumberinheritsFromisArrayisClassisNumberisTextselectconfigHierarchygetMissionConfigValue

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

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)