setOpticsMode: Difference between revisions

Latest revision as of 13:23, 23 August 2022

Hover & click on the images for description

Description:: Sets the optic mode of the current weapon to the given class name or the index.
Groups:: Object Manipulation

Syntax:

unit setOpticsMode mode

Parameters:

unit: Object

Return Value:

Nothing

Example 1:: player setOpticsMode "Hamr2Scope"; // Default optic mode for optic_Hamr
Example 2:: player setOpticsMode 0;
Example 3:: player setOpticsMode [1, 0]; // reset the optics mode of the player's primary weapon to the default

: 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
-|branch= dev
 |version1= 2.10
 |gr1= Object Manipulation
-|descr= Sets the optic mode of the current weapon to the given class name or the index. Class name should be defined in the OpticsModes config class of the optic, index is the 0-based order of the optic modes with 0 being the default optic mode.
+|descr= Sets the optic mode of the current weapon to the given class name or the index.
-|s1= unit [[getOpticsMode]] modeClassNameOrIndex
+|s1= unit [[setOpticsMode]] mode
 |p1= unit: [[Object]]
-|r1= [[String]] or [[Number]] - Class name defined in the OpticsModes config class of the optic. Or the 0-based order of the optic modes with 0 being the default optic mode.
+|p2= mode: [[String]], [[Number]] or [[Array]]:
+* [[String]] - class name defined in the optic's {{hl|OpticsModes}} config class
+* [[Number]] - 0-based index of the optic mode with 0 being the default optic mode
+* [[Array]] - in format [slotIndex, opticsModeIndexOrClassName] where:
+** slotIndex: [[Number]], can be one of:
+*** 0 - Current weapon
+*** 1 - Primary weapon
+*** 2 - Secondary weapon
+*** 3 - Handgun
+** opticsModeIndexOrClassName: [[String]] or [[Number]] as above
+|r1= [[Nothing]]
 |x1= <sqf>player setOpticsMode "Hamr2Scope"; // Default optic mode for optic_Hamr</sqf>
 |x2= <sqf>player setOpticsMode 0;</sqf>
+|x3= <sqf>player setOpticsMode [1, 0]; // reset the optics mode of the player's primary weapon to the default</sqf>
 |seealso= [[getOpticsMode]]
 }}