setMissionOptions: Difference between revisions

Revision as of 21:31, 27 August 2024

2.18

LELocal

Hover & click on the images for description

⚠

Only available in Development branch(es) until its release with Arma 3 patch v2.18.

Description

Description:

Sets various mission options. The options are automatically reset between missions and are saved/restored with the save system.
Available Options:

IgnoreNoDamage: Boolean - (default false) true to filter out no change in damage from HandleDamage calls
IgnoreFakeHeadHit: Boolean - (default false) true to filter out FakeHeadHit context from HandleDamage calls
IgnoreUpsideDownDamage: Boolean - (default false) true to ignore some minor upside down damage accumulation for a helicopter

Providing a empty HashMap will reset all options to defaults.

Groups:

System

Syntax

Syntax:: setMissionOptions options
Parameters:: options: HashMap - a HashMap containing all the options to be changed
Return Value:: Nothing

Examples

Example 1:: setMissionOptions createHashMapFromArray [["IgnoreNoDamage", true], ["IgnoreFakeHeadHit", true], ["IgnoreUpsideDownDamage", true]];
Example 2:: setMissionOptions createHashMap; // reset options to default

Additional Information

See also:: getMissionOptions getResolution getAudioOptionVolumes getSubtitleOptions

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

@@ Line 2: / Line 2: @@
 |game1= arma3
-|version1= 2.16
+|version1= 2.18
+|branch= dev
+|eff= local
 |gr1= System
-|descr= Sets various mission options. The options are automatically reset before and after the mission. Currently supported options are:
+|descr= Sets various mission options. The options are automatically reset between missions and are saved/restored with the save system.<br>
-* ignoreNoDamage: [[Boolean]] - [[true]] to filter out no change in damage [[Arma_3:_Event_Handlers#HandleDamage | HandleDamage]] calls. Default: [[false]]
+Available Options:
+* IgnoreNoDamage: [[Boolean]] - (default [[false]]) [[true]] to filter out no change in damage from {{Link|Arma 3: Event Handlers#HandleDamage|HandleDamage}} calls
+* IgnoreFakeHeadHit: [[Boolean]] - (default [[false]]) [[true]] to filter out FakeHeadHit context from {{Link|Arma 3: Event Handlers#HandleDamage|HandleDamage}} calls
+* IgnoreUpsideDownDamage: [[Boolean]] - (default [[false]]) [[true]] to ignore some minor upside down damage accumulation for a helicopter
+Providing a empty HashMap will reset all options to defaults.
 |s1= [[setMissionOptions]] options
-|p1= options: [[Array]] - array of options (see description). Empty array [] will reset all options to defaults.
+|p1= options: [[HashMap]] - a HashMap containing all the options to be changed
 |r1= [[Nothing]]
-|x1= <sqf>
+|x1= <sqf>setMissionOptions createHashMapFromArray [["IgnoreNoDamage", true], ["IgnoreFakeHeadHit", true], ["IgnoreUpsideDownDamage", true]];</sqf>
-setMissionOptions [true];
-</sqf>
+|x2= <sqf>setMissionOptions createHashMap; // reset options to default</sqf>
 |seealso= [[getMissionOptions]] [[getResolution]] [[getAudioOptionVolumes]] [[getSubtitleOptions]]
 }}