missionConfigFile: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Text replacement - "|= Game name" to "|Game name=") |
||
(7 intermediate revisions by 5 users not shown) | |||
Line 4: | Line 4: | ||
[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]] | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma | | | arma |Game name= | ||
|1.00| | |1.00|Game version= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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| | |||
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''' |= | |'''missionConfigFile''' |SYNTAX= | ||
| [[Config]] |= | | [[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> |= | };</code> |EXAMPLE1= | ||
|x2= To define custom values in [[description.ext]]: | |x2= To define custom values in [[description.ext]]: | ||
< | <syntaxhighlight lang=cpp>class myMissionConfig | ||
{ | { | ||
class mySetup | class mySetup | ||
Line 37: | Line 40: | ||
myText = "LOL"; | myText = "LOL"; | ||
}; | }; | ||
};</ | };</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> |= | _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>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> | |||
|= Example | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[configClasses]], [[configProperties]], [[configFile]], [[campaignConfigFile]], [[config/name]], [[config greater greater name|config >> name]], [[configName]], [[count]], [[getArray]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]], [[configHierarchy]] |= | | [[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 74: | 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]]: | ||
< | <syntaxhighlight lang=cpp> | ||
class MissionSQM | class MissionSQM | ||
{ | { | ||
#include "mission.sqm" | #include "mission.sqm" | ||
};</ | };</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 04:35, 1 September 2019
Description
- Description:
- Return root of mission Description.ext entries hierarchy.
- 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 >> 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
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)
Categories:
- Scripting Commands
- Scripting Commands ArmA
- Command Group: System Commands
- Command Group: Mission Information
- Introduced with Arma version 1.00
- Arma: New Scripting Commands
- Arma: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters