ORK Framework  2.25.2
API Documentation
ORKFramework.InputKey Class Reference
Inheritance diagram for ORKFramework.InputKey:
ORKFramework.BaseIndexData ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

 InputKey (string n)
 InputKey (string n, KeyCode pk, KeyCode nk, InputHandling h)
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
void Tick ()
void TickCollection ()
bool GetButton ()
float GetAxis ()
void SetDownTime ()
void ReleaseDownTime ()
void SetAxisHUD (float value)
void SetAxis (float value)
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...

Public Attributes

string name = ""
InputKeyType type = InputKeyType.None
bool invertAxis = false
float axisFactor = 1
bool limitAxis = false
float minAxis = -1
float maxAxis = 1
bool uiBlocksInput = false
string keyName = ""
bool isJoypadAxis = false
bool joypadUpDownFullAxis = false
bool useRawAxis = false
KeyCode positiveKey = KeyCode.None
KeyCode negativeKey = KeyCode.None
int mouseButton = 0
int clickCount = 1
float clickTimeout = 0.2f
int touchCount = 1
bool consumeFingers = true
int tabCount = 1
float tabTimeout = 0.2f
Needed needed = Needed.One
NegateInputKey [] input
ComboInputKey [] comboInput
InputHandling handling = InputHandling.Down
float inputTimeout = 0
float inputHoldTime = 0
string customName = ""
CallMethod customButton
CallMethod customAxis


bool Blocked [get, set]
bool Received [get, set]
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0

Member Function Documentation

◆ SetData()

override void ORKFramework.InputKey.SetData ( DataObject  data)

Sets the variables of the class using a ORKFramework.DataObject.

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.