missionConfigFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added example for missionConfigFile.)
m (Text replacement - "Category:Eden Editor" to "Eden Editor")
 
(66 intermediate revisions by 11 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= <pre>for "_i" from (0) to ((count paramsArray) - 1) do
|descr= Return root of mission [[Description.ext]] entries hierarchy.
{{Feature|important|Since the introduction of the [[:Category:Eden Editor|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:
* [[getMissionConfigValue]]
* [[getMissionConfig]]
}}
 
|s1= [[missionConfigFile]]
 
|r1= [[Config]]
 
|x1= <sqf>
for "_i" from 0 to (count paramsArray - 1) do
{
missionNamespace setVariable [configName ((missionConfigFile/"Params") select _i), paramsArray select _i];
};
</sqf>
 
|x2= To define custom values in [[Description.ext|description.ext]]:
<syntaxhighlight lang="cpp">
class myMissionConfig
{
{
missionNamespace setVariable [configName ((missionConfigFile/"Params") select _i),paramsArray select _i];
class mySetup
};</pre> |= Example 1
{
____________________________________________________________________________________________
myNumber = 3;
myArray[] = { 1, 2, 3 };
myText = "LOL";
};
};
</syntaxhighlight>


|  |= See also
To read defined custom values from a script:
<sqf>
_myNumber = getNumber (missionConfigFile >> "myMissionConfig" >> "mySetup" >> "myNumber");
_myArray = getArray (missionConfigFile >> "myMissionConfig" >> "mySetup" >> "myArray");
_myText = getText (missionConfigFile >> "myMissionConfig" >> "mySetup" >> "myText");
</sqf>


|seealso=[[configFile]] [[campaignConfigFile]] [[getMissionConfigValue]] [[getMissionConfig]] [[getMissionPath]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Killzone_Kid
<!-- Note Section BEGIN -->
|timestamp= 20150217164600
|text= [[missionConfigFile]] can be used to parse ''mission.sqm'' file data as well if it is included into [[Description.ext|description.ext]]:
<syntaxhighlight lang="cpp">
class MissionSQM
{
#include "mission.sqm"
};
</syntaxhighlight>
Then ''mission.sqm'' data can be accessed like this:
<sqf>getNumber (missionConfigFile >> "MissionSQM" >> "version"); // 12 - version param in mission.sqm</sqf>
(courtesy of [[Special:Contributions/Master85|Master85]])
}}


<!-- Note Section END -->
{{Note
</dl>
|user= Dedmen
 
|timestamp= 20180427203900
<h3 style="display:none">Bottom Section</h3>
|text= 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.<br>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
To get file path with [[Description.ext|description.ext]] to play sound via [[playSound3D]] (before [[getMissionPath]]):
[[Category:Scripting Commands VBS2|{{uc:{{PAGENAME}}}}]]
<sqf>private _missionRootPath = str missionConfigFile select [0, count str missionConfigFile - 15];</sqf>
}}

Latest revision as of 14:26, 9 July 2023

Hover & click on the images for description

Description

Description:
Return root of mission Description.ext entries hierarchy.
Since the 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:

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");

Additional Information

See also:
configFile campaignConfigFile getMissionConfigValue getMissionConfig getMissionPath

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
Killzone_Kid - c
Posted on Feb 17, 2015 - 16:46 (UTC)
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)

Dedmen - c
Posted on Apr 27, 2018 - 20:39 (UTC)
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.
To get file path with description.ext to play sound via playSound3D (before getMissionPath):
private _missionRootPath = str missionConfigFile select [0, count str missionConfigFile - 15];