ZoomConfig

Configuration for the shared client-side zoom system.

Adding a Zoom block to an interaction step's Effects makes that step drive the zoom while it is active. All values are optional and fall back to sensible defaults.

MagnificationMultiplier

How many times narrower the field of view becomes while zoomed (relative to the player's FoV).

Type information:

(Nullable) Either Number defaults to: 4.0 or String that matches the pattern: ^(-?Infinity|NaN)$

MouseSensitivityMultiplier

Mouse sensitivity multiplier applied while zoomed (lower = steadier aim).

Type information:

(Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$

OverlayTexture

Optional screen-effect texture drawn over the screen while zoomed.

Type information: (Nullable) String

DepthOfField

Whether to enable a depth-of-field post effect while zoomed.

Type information: Boolean defaults to: false

AllowCameraOrbit

Whether the free-rotate orbit camera is allowed while zoomed. When false (the default), an active orbit ends when the zoom begins and orbit cannot be started while zoomed, since its pull-back distance is field-of-view derived.

Type information: Boolean defaults to: false

ForcePerspective

Temporarily forces the player's camera perspective while zoomed, restoring it afterwards. None leaves the perspective untouched; FirstPerson and ThirdPerson switch a player in the other perspective.

Type information:

(Nullable) Any one of the following String (defaults to None):

LodMultiplier

Scales entity level-of-detail distances while zoomed so distant things keep updating. 0 means scale with MagnificationMultiplier.

Type information:

(Nullable) Either Number defaults to: 4.0 or String that matches the pattern: ^(-?Infinity|NaN)$

TransitionLerp

Shared field-of-view interpolation factor for zooming in and out: a unitless lerp weight in the 0-1 range applied each fixed movement tick (higher snaps faster, 1 is instant).

Type information:

(Nullable) Either Number defaults to: 0.4000000059604645 or String that matches the pattern: ^(-?Infinity|NaN)$

InLerp

Optional override for the zoom-in FoV lerp. Falls back to TransitionLerp.

Type information:

(Nullable) Either Number defaults to: 0.4000000059604645 or String that matches the pattern: ^(-?Infinity|NaN)$

OutLerp

Optional override for the zoom-out FoV lerp. Falls back to TransitionLerp.

Type information:

(Nullable) Either Number defaults to: 0.4000000059604645 or String that matches the pattern: ^(-?Infinity|NaN)$

OverlayFade

Whether the overlay fades in/out (false = snap on/off instantly).

Type information: Boolean defaults to: true

OverlayFadePerSecond

Shared overlay fade rate in units per second: the overlay alpha eases toward its target at this rate (higher = faster).

Type information:

(Nullable) Either Number defaults to: 3.0 or String that matches the pattern: ^(-?Infinity|NaN)$

OverlayFadeInPerSecond

Optional override for the overlay fade-in rate. Falls back to OverlayFadePerSecond.

Type information:

(Nullable) Either Number defaults to: 3.0 or String that matches the pattern: ^(-?Infinity|NaN)$

OverlayFadeOutPerSecond

Optional override for the overlay fade-out rate. Falls back to OverlayFadePerSecond.

Type information:

(Nullable) Either Number defaults to: 3.0 or String that matches the pattern: ^(-?Infinity|NaN)$