API reference
API reference
Select your platform
No SDKs available
No versions available

LocomotionComfortVignetteSetting Class

Extends MonoBehaviour
Locomotion setting that controls the vignette strength when different locomotion events occur.
You can select between Turning, Acceleration and linear movement and it will apply the selected AnimationCurve when the referenced toggle is activated

Protected Fields

_started : bool
Signature 
bool _started

Protected Methods

OnDisable ()
Signature 
virtual void OnDisable()
Returns
void
OnEnable ()
Signature 
virtual void OnEnable()
Returns
void
Start ()
Signature 
virtual void Start()
Returns
void

Methods

InjectAllComfortOption ( comfortType , toggle , curve , tunneling )
Signature 
void InjectAllComfortOption(ComfortType comfortType, Toggle toggle, AnimationCurve curve, LocomotionTunneling tunneling)
Parameters
comfortType: ComfortType
toggle: Toggle
curve: AnimationCurve
tunneling: LocomotionTunneling
Returns
void
InjectComfortType ( comfortType )
Signature 
void InjectComfortType(ComfortType comfortType)
Parameters
comfortType: ComfortType
Returns
void
InjectCurve ( curve )
Signature 
void InjectCurve(AnimationCurve curve)
Parameters
curve: AnimationCurve
Returns
void
InjectToggle ( toggle )
Signature 
void InjectToggle(Toggle toggle)
Parameters
toggle: Toggle
Returns
void
InjectTunneling ( tunneling )
Signature 
void InjectTunneling(LocomotionTunneling tunneling)
Parameters
tunneling: LocomotionTunneling
Returns
void

Inner Enum

ComfortType Enum

Types of movement that will trigger the comfort vignette.

Enumeration Constants

Member
Turning
Accelerating
Moving
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta