getMissionConfigValue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
m (Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|")
Line 14: Line 14:
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.<br><br>
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.<br><br>


{{Important | This command cannot force return type, it will return the value of the type given in config. Use [[isEqualType]] to additionally reaffirm the correct type if necessary to account for human error.}}   
{{Feature | important | This command cannot force return type, it will return the value of the type given in config. Use [[isEqualType]] to additionally reaffirm the correct type if necessary to account for human error.}}   


| '''getMissionConfigValue''' attribute
| '''getMissionConfigValue''' attribute

Revision as of 02:13, 7 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
ConfigMission Information

Syntax

Syntax:
Syntax needed
Parameters:
attribute: String - attribute name
Return Value:
Return value needed

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:
See also needed

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