Struct CinemachineInputAxisDriver
A helper class to drive an input axis, as an alternative to the standard Cinemachine.AxisState. Behaviour is a simple direct scaling of the input channel, with no max speed.
Namespace: Cinemachine
Syntax
public struct CinemachineInputAxisDriverFields
accelTime
The amount of time in seconds it takes to accelerate to a higher speed
Declaration
public float accelTimeField Value
| Type | Description |
|---|---|
| Single |
decelTime
The amount of time in seconds it takes to decelerate to a lower speed
Declaration
public float decelTimeField Value
| Type | Description |
|---|---|
| Single |
inputValue
The value of the input axis. A value of 0 means no input. You can drive "this directly from a custom input system, or you can set the Axis Name and have the value driven by the internal Input Manager
Declaration
public float inputValueField Value
| Type | Description |
|---|---|
| Single |
multiplier
Multiply the input by this amount prior to processing. Controls the input power
Declaration
public float multiplierField Value
| Type | Description |
|---|---|
| Single |
name
The name of this axis as specified in Unity Input manager. Setting to an empty string will disable the automatic updating of this axis
Declaration
public string nameField Value
| Type | Description |
|---|---|
| String |
Methods
Update(Single, ref AxisBase)
Update the axis
Declaration
public bool Update(float deltaTime, ref AxisBase axis)Parameters
| Type | Name | Description |
|---|---|---|
| Single | deltaTime | current deltaTime |
| AxisBase | axis | The AxisState to update |
Returns
| Type | Description |
|---|---|
| Boolean | True if the axis value changed due to user input, false otherwise |
Update(Single, ref AxisState)
Support for legacy AxisState struct: update the axis
Declaration
public bool Update(float deltaTime, ref AxisState axis)Parameters
| Type | Name | Description |
|---|---|---|
| Single | deltaTime | current deltaTime |
| AxisState | axis | The AxisState to update |
Returns
| Type | Description |
|---|---|
| Boolean | True if the axis value changed due to user input, false otherwise |
Validate()
Call from OnValidate: Make sure the fields are sensible
Declaration
public void Validate()