InControl API Reference
InputControl Class Reference
Inheritance diagram for InputControl:
OneAxisInputControl IInputControl

Public Member Functions

 InputControl (string handle, InputControlType target)
 
 InputControl (string handle, InputControlType target, bool passive)
 
- Public Member Functions inherited from OneAxisInputControl
bool UpdateWithState (bool state, ulong updateTick, float deltaTime)
 
bool UpdateWithValue (float value, ulong updateTick, float deltaTime)
 
void ClearInputState ()
 
void Commit ()
 
void CommitWithState (bool state, ulong updateTick, float deltaTime)
 
void CommitWithValue (float value, ulong updateTick, float deltaTime)
 

Public Attributes

bool Passive
 When a control is passive, it will not cause a device to be considered active. This is useful for certain controls that spam data, like gyro or accelerometer input. Defaults to More...
 
- Public Attributes inherited from OneAxisInputControl
float FirstRepeatDelay = 0.8f
 
float RepeatDelay = 0.1f
 
bool Raw
 

Static Public Attributes

static readonly InputControl Null = new InputControl { isNullControl = true }
 

Properties

string Handle [get, protected set]
 
InputControlType Target [get, protected set]
 
bool IsButton [get, protected set]
 
bool IsAnalog [get, protected set]
 
bool IsStandard [get]
 
- Properties inherited from OneAxisInputControl
ulong UpdateTick [get, protected set]
 
bool State [get]
 
bool LastState [get]
 
float? Value [get]
 
float? LastValue [get]
 
float? RawValue [get]
 
bool HasChanged [get]
 
bool IsPressed [get]
 
bool WasPressed [get]
 
bool WasReleased [get]
 
bool WasRepeated [get]
 
float Sensitivity [get, set]
 
float LowerDeadZone [get, set]
 
float UpperDeadZone [get, set]
 
float StateThreshold [get, set]
 
bool IsNullControl [get]
 
bool Enabled [get, set]
 
bool EnabledInHierarchy [get]
 
- Properties inherited from IInputControl
bool HasChanged [get]
 
bool IsPressed [get]
 
bool WasPressed [get]
 
bool WasReleased [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from OneAxisInputControl
static implicit operator bool (OneAxisInputControl instance)
 
static implicit operator float (OneAxisInputControl instance)
 
- Protected Attributes inherited from OneAxisInputControl
bool isNullControl = false
 
bool ownerEnabled = true
 

Member Data Documentation

◆ Passive

bool Passive

When a control is passive, it will not cause a device to be considered active. This is useful for certain controls that spam data, like gyro or accelerometer input. Defaults to

false.


The documentation for this class was generated from the following file: