This is the documentation for the Scripting APIs of this package.
Show / Hide Table of Contents
-
Unity.
Cinemachine -
Axis
Base -
Axis
State -
Axis
State. IInput Axis Provider -
Axis
State. IRequires Input -
Axis
State. Recentering -
Axis
State. Speed Mode -
Camera
Pipeline Attribute -
Camera
State -
Camera
State. Blend Hints -
Camera
State. Custom Blendable Items -
Camera
State. Custom Blendable Items. Item -
Camera
State Extensions -
Camera
Target -
Child
Camera Property Attribute -
Cinemachine3Orbit
Rig -
Cinemachine3Orbit
Rig. Orbit -
Cinemachine3Orbit
Rig. Settings -
Cinemachine3rd
Person Follow -
Cinemachine
Auto Focus -
Cinemachine
Auto Focus. Focus Tracking Mode -
Cinemachine
Basic Multi Channel Perlin -
Cinemachine
Blend -
Cinemachine
Blend. IBlender -
Cinemachine
Blend Definition -
Cinemachine
Blend Definition. Lookup Blend Delegate -
Cinemachine
Blend Definition. Styles -
Cinemachine
Blender Settings -
Cinemachine
Blender Settings. Custom Blend -
Cinemachine
Brain -
Cinemachine
Brain. Brain Update Methods -
Cinemachine
Brain. Lens Mode Override Settings -
Cinemachine
Brain. Update Methods -
Cinemachine
Brain Events -
Cinemachine
Camera -
Cinemachine
Camera Events -
Cinemachine
Camera Manager Base -
Cinemachine
Camera Manager Base. Default Target Settings -
Cinemachine
Camera Manager Events -
Cinemachine
Camera Offset -
Cinemachine
Clear Shot -
Cinemachine
Collision Impulse Source -
Cinemachine
Component Base -
Cinemachine
Composer -
Cinemachine
Core -
Cinemachine
Core. Axis Input Delegate -
Cinemachine
Core. Blend Event -
Cinemachine
Core. Blend Event Params -
Cinemachine
Core. Blend Hints -
Cinemachine
Core. Brain Event -
Cinemachine
Core. Camera Event -
Cinemachine
Core. Get Blend Override Delegate -
Cinemachine
Core. Get Custom Blender Delegate -
Cinemachine
Core. Stage -
Cinemachine
Do Not Upgrade -
Cinemachine
Dolly Cart -
Cinemachine
Dolly Cart. Update Method -
Cinemachine
Embedded Asset Property Attribute -
Cinemachine
Extension -
Cinemachine
Extension. Vcam Extra State Base -
Cinemachine
External Camera -
Cinemachine
External Impulse Listener -
Cinemachine
Fixed Signal -
Cinemachine
Follow -
Cinemachine
Follow Zoom -
Cinemachine
Framing Transposer -
Fields
-
m_Adjustment
Mode -
m_Bias
X -
m_Bias
Y -
m_Camera
Distance -
m_Center
On Activate -
m_Dead
Zone Depth -
m_Dead
Zone Height -
m_Dead
Zone Width -
m_Group
Framing Mode -
m_Group
Framing Size -
m_Lookahead
Ignore Y -
m_Lookahead
Smoothing -
m_Lookahead
Time -
m_Max
Dolly In -
m_Max
Dolly Out -
m_Maximum
Distance -
m_Maximum
FOV -
m_Maximum
Ortho Size -
m_Minimum
Distance -
m_Minimum
FOV -
m_Minimum
Ortho Size -
m_Screen
X -
m_Screen
Y -
m_Soft
Zone Height -
m_Soft
Zone Width -
m_Target
Movement Only -
m_Tracked
Object Offset -
m_Unlimited
Soft Zone - m_XDamping
- m_YDamping
- m_ZDamping
-
m_Adjustment
- Properties
- Methods
-
Fields
-
Cinemachine
Framing Transposer. Adjustment Mode -
Cinemachine
Framing Transposer. Framing Mode -
Cinemachine
Free Look -
Cinemachine
Free Look. Create Rig Delegate -
Cinemachine
Free Look. Destroy Rig Delegate -
Cinemachine
Free Look. Orbit -
Cinemachine
Free Look Modifier -
Cinemachine
Free Look Modifier. Component Modifier<T> -
Cinemachine
Free Look Modifier. Composition Modifier -
Cinemachine
Free Look Modifier. Distance Modifier -
Cinemachine
Free Look Modifier. IModifiable Composition -
Cinemachine
Free Look Modifier. IModifiable Distance -
Cinemachine
Free Look Modifier. IModifiable Noise -
Cinemachine
Free Look Modifier. IModifiable Position Damping -
Cinemachine
Free Look Modifier. IModifier Value Source -
Cinemachine
Free Look Modifier. Lens Modifier -
Cinemachine
Free Look Modifier. Modifier -
Cinemachine
Free Look Modifier. Noise Modifier -
Cinemachine
Free Look Modifier. Noise Modifier. Noise Settings -
Cinemachine
Free Look Modifier. Position Damping Modifier -
Cinemachine
Free Look Modifier. Tilt Modifier -
Cinemachine
Free Look Modifier. Top Bottom Rigs<T> -
Cinemachine
Group Composer -
Cinemachine
Group Composer. Adjustment Mode -
Cinemachine
Group Composer. Framing Mode -
Cinemachine
Group Framing -
Cinemachine
Group Framing. Framing Modes -
Cinemachine
Group Framing. Lateral Adjustment Modes -
Cinemachine
Group Framing. Size Adjustment Modes -
Cinemachine
Hard Lock To Target -
Cinemachine
Hard Look At -
Cinemachine
Impulse Channel Property Attribute -
Cinemachine
Impulse Definition -
Cinemachine
Impulse Definition. Impulse Shapes -
Cinemachine
Impulse Definition. Impulse Types -
Cinemachine
Impulse Definition. Repeat Modes -
Cinemachine
Impulse Listener -
Cinemachine
Impulse Listener. Impulse Reaction -
Cinemachine
Impulse Manager -
Cinemachine
Impulse Manager. Envelope Definition -
Cinemachine
Impulse Manager. Impulse Event -
Cinemachine
Impulse Manager. Impulse Event. Direction Modes -
Cinemachine
Impulse Manager. Impulse Event. Dissipation Modes -
Cinemachine
Impulse Source -
Cinemachine
Input Axis Controller -
Cinemachine
Input Axis Controller. Reader -
Cinemachine
Input Axis Driver -
Cinemachine
Input Provider -
Cinemachine
Input Provider Extensions -
Cinemachine
Legacy Camera Events -
Cinemachine
Legacy Camera Events. On Camera Live Event -
Cinemachine
Mixer Events Base -
Cinemachine
Mixing Camera -
Cinemachine
Orbital Follow -
Cinemachine
Orbital Follow. Orbit Styles -
Cinemachine
Orbital Follow. Reference Frames -
Cinemachine
Orbital Transposer -
Cinemachine
Orbital Transposer. Heading -
Cinemachine
Orbital Transposer. Heading. Heading Definition -
Cinemachine
POV -
Cinemachine
POV. Recenter Target Mode -
Cinemachine
Pan Tilt -
Cinemachine
Pan Tilt. Reference Frames -
Cinemachine
Path -
Cinemachine
Path. Waypoint -
Cinemachine
Path Base - Fields
- Properties
-
Methods
-
Distance
Cache Is Valid -
Evaluate
Local Orientation -
Evaluate
Local Position -
Evaluate
Local Tangent -
Evaluate
Orientation -
Evaluate
Orientation At Unit -
Evaluate
Position -
Evaluate
Position At Unit -
Evaluate
Tangent -
Evaluate
Tangent At Unit -
Find
Closest Point -
From
Path Native Units -
Invalidate
Distance Cache -
Max
Unit -
Min
Unit -
On
Enable -
Standardize
Path Distance -
Standardize
Pos -
Standardize
Unit -
To
Native Path Units
-
Distance
-
Cinemachine
Path Base. Appearance -
Cinemachine
Path Base. Position Units -
Cinemachine
Pipeline -
Cinemachine
Pixel Perfect -
Cinemachine
Position Composer -
Cinemachine
Recomposer -
Cinemachine
Rotation Composer -
Cinemachine
Same As Follow Target -
Cinemachine
Sequencer Camera -
Cinemachine
Sequencer Camera. Instruction -
Cinemachine
Smooth Path -
Cinemachine
Smooth Path. Waypoint -
Cinemachine
Spline Cart -
Cinemachine
Spline Cart. Update Methods -
Cinemachine
Spline Dolly -
Cinemachine
Spline Dolly. Damping Settings -
Cinemachine
Spline Dolly. Rotation Mode -
Cinemachine
Spline Roll -
Cinemachine
Target Group -
Cinemachine
Target Group. Position Modes -
Cinemachine
Target Group. Rotation Modes -
Cinemachine
Target Group. Target -
Cinemachine
Target Group. Update Methods -
Cinemachine
Third Person Follow -
Cinemachine
Touch Input Mapper -
Cinemachine
Tracked Dolly -
Cinemachine
Tracked Dolly. Auto Dolly -
Cinemachine
Tracked Dolly. Camera Up Mode -
Cinemachine
Transposer -
Cinemachine
Virtual Camera -
Cinemachine
Virtual Camera. Create Pipeline Delegate -
Cinemachine
Virtual Camera. Destroy Pipeline Delegate -
Cinemachine
Virtual Camera Base - Fields
- Properties
-
Methods
-
Cancel
Damping -
Detached
Follow Target Damp -
Detached
Look At Target Damp -
Force
Camera Position -
Get
Cinemachine Component -
Get
Max Damp Time -
Internal
Update Camera State -
Invoke
On Transition In Extensions -
Invoke
Post Pipeline Stage Callback -
Invoke
Pre Pipeline Mutate Camera State Callback -
Is
Participating In Blend -
Move
To Top Of Priority Subqueue -
On
Camera Activated -
On
Destroy -
On
Disable -
On
Enable -
On
Target Object Warped -
On
Transform Parent Changed -
On
Transition From Camera -
Perform
Legacy Upgrade - Prioritize
-
Pull
State From Virtual Camera -
Resolve
Follow -
Resolve
Look At - Start
- Update
-
Update
Camera State -
Update
Target Cache
-
Cancel
-
Cinemachine
Virtual Camera Base. Standby Update Mode - Damper
-
Default
Input Axis Driver -
Embedded
Blender Settings Property Attribute -
Enabled
Property Attribute -
Foldout
With Enabled Button Attribute -
Group
Weight Manipulator -
Heading
Tracker -
Hide
Foldout Attribute -
Hide
If No Component Attribute -
ICamera
Override Stack -
ICinemachine
Camera -
ICinemachine
Camera. Activation Event -
ICinemachine
Camera. Activation Event Params -
ICinemachine
Mixer -
ICinemachine
Target Group -
IInput
Axis Controller -
IInput
Axis Owner -
IInput
Axis Owner. Axis Descriptor -
IInput
Axis Owner. Axis Descriptor. Axis Getter -
IInput
Axis Owner. Axis Descriptor. Hints -
IInput
Axis Reader -
IInput
Axis Reset Source -
IShot
Quality Evaluator -
ISignal
Source6D -
Input
Axis -
Input
Axis. Recentering Settings -
Input
Axis. Restriction Flags -
Input
Axis Controller Base<T> -
Input
Axis Controller Base<T>. Controller -
Input
Axis Name Property Attribute -
Legacy
Lens Settings -
Lens
Settings -
Lens
Settings. Override Modes -
Lens
Settings. Physical Settings -
Lens
Settings Hide Mode Override Property Attribute -
Lookahead
Settings -
Min
Max Range Slider Attribute -
Nested
Blend Source -
No
Save During Play Attribute -
Noise
Settings -
Noise
Settings. Noise Params -
Noise
Settings. Transform Noise Params -
Output
Channels -
Position
Predictor -
Priority
Settings -
Range
Slider Attribute -
Runtime
Utility -
Save
During Play Attribute -
Screen
Composer Settings -
Screen
Composer Settings. Dead Zone Settings -
Screen
Composer Settings. Hard Limit Settings -
Sensor
Size Property Attribute -
Signal
Source Asset -
Spline
Auto Dolly -
Spline
Auto Dolly. Fixed Speed -
Spline
Auto Dolly. ISpline Auto Dolly -
Spline
Auto Dolly. Nearest Point To Target -
Tag
Field Attribute -
Unity
Quaternion Extensions -
Unity
Rect Extensions -
Unity
Vector Extensions -
Vcam
Target Property Attribute -
Vector2As
Range Attribute
-
Axis
-
Unity.
Cinemachine. Editor -
Unity.
Cinemachine. Target Tracking -
Unity.
Cinemachine. Tests -
Unity.
Cinemachine. Tests. Editor