setOpticsMode

From Bohemia Interactive Community
Revision as of 15:44, 6 May 2022 by Lou Montana (talk | contribs) (Add syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.10.

Description

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

Syntax

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 - 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
Return Value:
Nothing

Examples

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

Additional Information

See also:
getOpticsMode

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