Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.UIEngine2.InputManager Class Reference

Detailed Description

Manager that filtering input by axises to prevent smooth user-friendly experience.

Inheritance diagram for Doloro.UIEngine2.InputManager:
Collaboration diagram for Doloro.UIEngine2.InputManager:

Public Member Functions

float GetInput (string axis)
 Getting filtered input by axis. Prevent to often call of the same input. More...
 
float GetInput (string axis, float threshold)
 Getting filtered input by axis. Prevent to often call of the same input. More...
 
float GetInput (string axis, out bool axisLocked)
 Getting filtered input by axis. Prevent to often call of the same input. More...
 
float GetInput (string axis, float threshold, out bool axisLocked)
 Getting filtered input by axis. Prevent to often call of the same input. More...
 
float PeekInput (string axis, out bool canBeUsed, out bool isPressed)
 Getting input without registering at the register. More...
 
void ReleaseAxis (string axis)
 Releasing axis from pressed status. More...
 

Properties

static InputManager Active [get]
 Reference to the current singleton instance of the manager. More...
 
static float AxisBlockTime [get, set]
 Hom many seconds axis is blocked to input since it was pressed. More...
 

Member Function Documentation

◆ GetInput() [1/4]

float Doloro.UIEngine2.InputManager.GetInput ( string  axis)

Getting filtered input by axis. Prevent to often call of the same input.

Parameters
axisTarget axis.
Returns
Axis value.

◆ GetInput() [2/4]

float Doloro.UIEngine2.InputManager.GetInput ( string  axis,
float  threshold 
)

Getting filtered input by axis. Prevent to often call of the same input.

Parameters
axisTarget axis.
thresholdThreshold that
Returns
Axis value.

◆ GetInput() [3/4]

float Doloro.UIEngine2.InputManager.GetInput ( string  axis,
float  threshold,
out bool  axisLocked 
)

Getting filtered input by axis. Prevent to often call of the same input.

Parameters
axisTarget axis.
thresholdThreshold that
axisLockedIs axis are locked?
Returns
Axis value.

◆ GetInput() [4/4]

float Doloro.UIEngine2.InputManager.GetInput ( string  axis,
out bool  axisLocked 
)

Getting filtered input by axis. Prevent to often call of the same input.

Parameters
axisTarget axis.
axisLockedIs axis are locked?

◆ PeekInput()

float Doloro.UIEngine2.InputManager.PeekInput ( string  axis,
out bool  canBeUsed,
out bool  isPressed 
)

Getting input without registering at the register.

Parameters
axisTarget input.
canBeUsedIs axis can be called without throwing out?
isPressedIs axis already pressed during agent session.
Returns
Input value.

◆ ReleaseAxis()

void Doloro.UIEngine2.InputManager.ReleaseAxis ( string  axis)

Releasing axis from pressed status.

Parameters
axisTarget axis.

Property Documentation

◆ Active

InputManager Doloro.UIEngine2.InputManager.Active
staticget

Reference to the current singleton instance of the manager.

Always non null. Can be called during MonoBehavior constructor.

◆ AxisBlockTime

float Doloro.UIEngine2.InputManager.AxisBlockTime
staticgetset

Hom many seconds axis is blocked to input since it was pressed.

0.3 seconds by default.


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