getMissionConfigValue

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Arma 3 version 1.56
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.56

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:
  1. External Description.ext file
  2. 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.

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

Multiplayer:
-
See also:
getMissionConfigmissionConfigFile

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

Notes


Bottom Section