Class InputAxis

Virtual input axis binding. Helps with listening for a selected axis input.

System.Object
InputAxis
System.IComparable
System.IComparable<InputAxis>
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
public class InputAxis : Object, IComparable, IComparable<InputAxis>

Constructors

InputAxis()

Initializes a new instance of the InputAxis class.

Declaration
public InputAxis()

InputAxis(String)

Initializes a new instance of the InputAxis class.

Declaration
public InputAxis(string name)
Parameters
System.String name

The axis name.

Fields

Name

The name of the axis to use. See AxisMappings.

Declaration
[Tooltip("The name of the axis to use.")]
public string Name
Field Value
System.String

Properties

Value

Gets the current axis value.

Declaration
public float Value { get; }
Property Value
System.Single

ValueRaw

Gets the current axis raw value.

Declaration
public float ValueRaw { get; }
Property Value
System.Single

Methods

CompareTo(InputAxis)

Declaration
public int CompareTo(InputAxis other)
Parameters
InputAxis other

Returns
System.Int32

CompareTo(Object)

Declaration
public int CompareTo(object obj)
Parameters
System.Object obj

Returns
System.Int32

Dispose()

Releases this object.

Declaration
public void Dispose()

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

Finalize()

Finalizes an instance of the InputAxis class.

Declaration
protected override void Finalize()

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

ToString()

Declaration
public override string ToString()
Returns
System.String

Events

ValueChanged

Occurs when axis is changed. Called before scripts update.

Declaration
public event Action ValueChanged
Event Type
System.Action

Extension Methods