Difference between revisions of "missionConfigFile"
Jump to navigation
Jump to search
(add. classification) |
Lou Montana (talk | contribs) m (Text replacement - "|= Game name" to "|Game name=") |
||
(23 intermediate revisions by 11 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 | + | | 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= |
− | | [[Config]] |= | + | | [[Config]] |RETURNVALUE= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | | + | |x1= <code>[[for]] "_i" [[from]] (0) [[to]] (([[count]] [[paramsArray]]) - 1) [[do]] { |
+ | [[missionNamespace]] [[setVariable]] <nowiki>[</nowiki>[[configName]] (([[missionConfigFile]]/"Params") [[select]] _i), [[paramsArray]] [[select]] _i]; | ||
+ | };</code> |EXAMPLE1= | ||
+ | |||
+ | |x2= To define custom values in [[description.ext]]: | ||
+ | <syntaxhighlight lang=cpp>class myMissionConfig | ||
+ | { | ||
+ | class mySetup | ||
+ | { | ||
+ | myNumber = 3; | ||
+ | myArray[] = { 1, 2, 3 }; | ||
+ | myText = "LOL"; | ||
+ | }; | ||
+ | };</syntaxhighlight> | ||
+ | |||
+ | To read defined custom values from a script: | ||
+ | <code>_myNumber = [[getNumber]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myNumber"); | ||
+ | _myArray = [[getArray]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myArray"); | ||
+ | _myText = [[getText]] ([[missionConfigFile]] [[gtgt|>>]] "myMissionConfig" [[gtgt|>>]] "mySetup" [[gtgt|>>]] "myText");</code> |EXAMPLE2= | ||
+ | |||
+ | |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 | ||
+ | ____________________________________________________________________________________________ | ||
+ | |||
+ | | [[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 33: | Line 64: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | ||
− | [[Category:Scripting Commands | + | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] |
+ | [[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | ||
+ | |||
+ | <!-- CONTINUE Notes --> | ||
+ | <dl class="command_description"> | ||
+ | <dd class="notedate">Posted on February 17, 2015 - 16:46 (UTC)</dd> | ||
+ | <dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | ||
+ | <dd class="note"> | ||
+ | [[missionConfigFile]] can be used to parse ''mission.sqm'' file data as well if it is included into [[description.ext]]: | ||
+ | <syntaxhighlight lang=cpp> | ||
+ | class MissionSQM | ||
+ | { | ||
+ | #include "mission.sqm" | ||
+ | };</syntaxhighlight> | ||
+ | Then ''mission.sqm'' data can be accessed like this: | ||
+ | <code>[[getNumber]] ([[missionConfigFile]] >> "MissionSQM" >> "version"); //12 - version param in ''mission.sqm''</code> | ||
+ | (courtesy of [[Special:Contributions/Master85|Master85]]) | ||
+ | </dd> | ||
+ | </dl> | ||
+ | <!-- DISCONTINUE Notes --> |
Latest revision as of 03:35, 1 September 2019
Click on the images for descriptions
Introduced in
- Game:
- Armed Assault
- Version:
- 1.00
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.
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
- Multiplayer:
- -
- See also:
- configClassesconfigPropertiesconfigFilecampaignConfigFileconfig/nameconfig >> nameconfigNamecountgetArraygetTextgetNumberinheritsFromisArrayisClassisNumberisTextselectconfigHierarchygetMissionConfigValuegetMissionPath
Notes
Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To
Add New Note | How To
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)