setOpticsMode

Description

Sets the optic mode of the current weapon to the given class name or the index.

Syntax

unit setOpticsMode mode

Parameters:

• unit: Object

• mode: String, Number or Array:

  • String - class name defined in the optic's OpticsModes config class
  • Number - 0-based index of the optic mode with 0 being the default optic mode
  • Array with [slotIndex, opticsModeIndexOrClassName]
    • slotIndex: Number, can be one of:
      • 0 - Current weapon
      • 1 - Primary weapon
      • 2 - Secondary weapon
      • 3 - Handgun
    • opticsModeIndexOrClassName: String or Number as above

Returns: Nothing

Examples

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

See also

getOpticsMode