getMissionConfigValue: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (template:command argument fix) |
||
| Line 11: | Line 11: | ||
# [[Eden_Editor:_Scenario_Atttributes|Eden Editor]] scenario attribute | # [[Eden_Editor:_Scenario_Atttributes|Eden Editor]] scenario attribute | ||
So if attribute exists in both places, 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. | So if attribute exists in both places, 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= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''getMissionConfigValue''' attribute |= | | '''getMissionConfigValue''' attribute |SYNTAX= | ||
|p1= attribute: [[String]] - attribute name |PARAMETER1= | |p1= attribute: [[String]] - attribute name |PARAMETER1= | ||
| [[Number]], [[String]] or [[Array]], depending on the attribute value type. [[nil|Nil]] when the attribute is undefined. |RETURNVALUE= | | [[Number]], [[String]] or [[Array]], depending on the attribute value type. [[nil|Nil]] when the attribute is undefined. |RETURNVALUE= | ||
|s2= '''getMissionConfigValue''' [attribute, defaultValue] |= | |s2= '''getMissionConfigValue''' [attribute, defaultValue] |SYNTAX= | ||
|p21= attribute: [[String]] - attribute name |PARAMETER1= | |p21= attribute: [[String]] - attribute name |PARAMETER1= | ||
|p22= defaultValue: [[Any]] - value used when the attribute is undefined |PARAMETER2= | |p22= defaultValue: [[Any]] - value used when the attribute is undefined |PARAMETER2= | ||
Revision as of 14:40, 7 April 2019
Description
- Description:
- Returns value of the given scenario attribute from the 1st tier. Since only config properties have values, the attribute should be config property. If it is not found or config class is given, the return is nil. If the attribute defined in multiple places, the command 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:
- getMissionConfigmissionConfigFile
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