Skip to main content

Class: ReticleOptions

Defined in: src/core/Options.ts:58

Default options for the reticle (pointing cursor).

Constructors​

Constructor​

new ReticleOptions(): ReticleOptions

Returns​

ReticleOptions

Properties​

defaultRenderDistance​

defaultRenderDistance: number = 0

Defined in: src/core/Options.ts:70

Distance in meters at which to render the reticle when no valid hit is found. Set to 0 to hide the reticle on a miss.


enabled​

enabled: boolean = true

Defined in: src/core/Options.ts:59


hoverRing​

hoverRing: boolean = false

Defined in: src/core/Options.ts:80

Shows a ring around a reticle over interactive targets. The reticle's dark border already outlines it, so this is off by default.


maxDistance?​

optional maxDistance: number

Defined in: src/core/Options.ts:65

Maximum reticle drawing distance in meters. It does not limit targeting.


projectOnDepthMesh​

projectOnDepthMesh: boolean = false

Defined in: src/core/Options.ts:61

Whether reticles use the real-world depth mesh as a surface.


scaleWithDistance​

scaleWithDistance: boolean = true

Defined in: src/core/Options.ts:75

Scales reticles with their distance from the viewer, so they stay legible far away without covering nearby UI. Turn off to keep a fixed world size.