Class CinemachineInputAxisController.Reader

Read an input value from legacy input or from and Input Action

Inheritance

object

CinemachineInputAxisController.Reader

Implements

IInputAxisReader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

[Serializable]
public sealed class CinemachineInputAxisController.Reader : IInputAxisReader

Fields

CancelDeltaTime

Enable this if the input value is inherently dependent on frame time. For example, mouse deltas will naturally be bigger for longer frames, so should not normally be scaled by deltaTime.

Declaration

[Tooltip("Enable this if the input value is inherently dependent on frame time.  For example, mouse deltas will naturally be bigger for longer frames, so in this case the default deltaTime scaling should be canceled.")]
public bool CancelDeltaTime

Field Value

Type	Description
bool

LegacyGain

The LegacyInput value is multiplied by this amount prior to processing. Controls the input power. Set it to a negative value to invert the input

Declaration

[Tooltip("The LegacyInput value is multiplied by this amount prior to processing.  Controls the input power.  Set it to a negative value to invert the input")]
public float LegacyGain

Field Value

Type	Description
float

LegacyInput

Axis name for the Legacy Input system (if used).
CinemachineCore.GetInputAxis() will be called with this name.

Declaration

[Tooltip("Axis name for the Legacy Input system (if used).  This value will be used to control the axis.")]
public string LegacyInput

Field Value

Type	Description
string

Methods

GetValue(Object, Hints)

Get the current value of the axis.

Declaration

public float GetValue(Object context, IInputAxisOwner.AxisDescriptor.Hints hint)

Parameters

Type	Name	Description
Object	context	The owner GameObject, can be used for logging diagnostics
IInputAxisOwner.AxisDescriptor.Hints	hint	A hint for converting a Vector2 value to a float

Returns

Type	Description
float	The axis value

Implements

IInputAxisReader