getMissionConfigValue: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3dev |= Game name |1.52|= Game version ______________...") |
Killzone Kid (talk | contribs) (clarification) |
||
Line 10: | Line 10: | ||
# External ''[[Description.ext]]'' file | # External ''[[Description.ext]]'' file | ||
# [[Eden_Editor:_Scenario_Atttributes|Eden Editor]] scenario attribute | # [[Eden_Editor:_Scenario_Atttributes|Eden Editor]] scenario attribute | ||
Previously, scenario attributes were extracted from ''Description.ext'' using [[missionConfigFile]]. That still works, but it ignores attributes set directly in the editor and it should not be used anymore. | So if attribute exists in both files, attribute from [[description.ext]] is used. Previously, scenario attributes were extracted from ''Description.ext'' using [[missionConfigFile]]. That still works, but it ignores attributes set directly in the editor and it should not be used anymore. | ||
|= Description | |= Description | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ |
Revision as of 12:09, 11 December 2015
Description
- Description:
- Returns value of a scenario attribute. The attribute can be defined on multiple places, the commands checks them in the following order:
- External Description.ext file
- Eden Editor scenario attribute
- Groups:
- Uncategorised
Syntax
- Syntax:
- getMissionConfigValue attribute
- Parameters:
- attribute: String - attribute name
- Return Value:
- Number, String or Array, depending on the attribute value type. Nil when the attribute is undefined.
Alternative Syntax
- Syntax:
- getMissionConfigValue [attribute, defaultValue]
- Parameters:
- attribute: String - attribute name
- defaultValue: Any - value used when the attribute is undefined
- Return Value:
- Number, String or Array, depending on the attribute value type. Default value when the attribute is undefined.
Examples
- Example 1:
_respawnDelay = getMissionConfigValue ["respawnDelay",0]
Returns respawn delay value. Replaces the previous approach which would scan only the external Description.ext file, but ignore the value set in the Eden Editor:_respawnDelay = getNumber (missionConfigFile >> "respawnDelay"); // Old approach
Additional Information
- See also:
- getMissionConfig missionConfigFile
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
[[Category:Introduced with arma3dev version 1.52]][[ Category: arma3dev: New Scripting Commands | GETMISSIONCONFIGVALUE]][[ Category: arma3dev: Scripting Commands | GETMISSIONCONFIGVALUE]]
Notes