Libraries.Game.InputSet Documentation
Inherits from: Libraries.Language.Object
Summary
Variable Summary Table
| Variables | Description |
|---|---|
| integer TOUCH_MOVEMENT_INPUT | |
| integer SHIFT | |
| integer META | KEYBOARD_INPUT: BEGIN: When the key is first pressed down. CONTINUE: Each frame that the key is held down. FINISH: When the key is released. FINISH_UNCAUGHT: When the key is released, if it wasn't used as part of a keypress combination. MOUSE_INPUT: BEGIN: When the mouse button is first clicked. CONTINUE: Each frame that the button is held down. FINISH: When the button is released. FINISH_UNCAUGHT: N/A MOUSE_WHEEL_INPUT: BEGIN: When the mouse wheel moves. (Wheel movement is non-continuous - each movement is registered, but there's typically no "smooth transition" as in begin/finish) CONTINUE: N/A FINISH: N/A FINISH_UNCAUGHT: N/A MOUSE_MOVEMENT_INPUT: BEGIN: When the mouse first moves onto an Item. CONTINUE: Each mouse movement, whether on the same Item or not. FINISH: When the mouse moves off of an Item. FINISH_UNCAUGHT: N/A TOUCH_INPUT: BEGIN: When a finger first presses down. CONTINUE: Each frame a finger is touching the screen. FINISH: When the finger is removed from the screen. FINISH_UNCAUGHT: N/A DRAG_INPUT: BEGIN: When the mouse begins to move while holding a button down. CONTINUE: Each frame where the mouse moves while still holding the button. FINISH: When the mouse button is released. |
| integer FINISH_UNCAUGHT | |
| integer FINISH | |
| integer MOUSE_INPUT | |
| integer MOUSE_MOVEMENT_INPUT | |
| integer DRAG_ITEM_INPUT | |
| integer MOUSE_WHEEL_INPUT | |
| integer TEXT_INPUT | |
| integer CONTINUE | |
| integer TOUCH_INPUT | |
| integer BEGIN | |
| integer KEYBOARD_INPUT | KEYBOARD_INPUT: BEGIN: When the key is first pressed down. CONTINUE: Each frame that the key is held down. FINISH: When the key is released. FINISH_UNCAUGHT: When the key is released, if it wasn't used as part of a keypress combination. MOUSE_INPUT: BEGIN: When the mouse button is first clicked. CONTINUE: Each frame that the button is held down. FINISH: When the button is released. FINISH_UNCAUGHT: N/A MOUSE_WHEEL_INPUT: BEGIN: When the mouse wheel moves. (Wheel movement is non-continuous - each movement is registered, but there's typically no "smooth transition" as in begin/finish) CONTINUE: N/A FINISH: N/A FINISH_UNCAUGHT: N/A MOUSE_MOVEMENT_INPUT: BEGIN: When the mouse first moves onto an Item. CONTINUE: Each mouse movement, whether on the same Item or not. FINISH: When the mouse moves off of an Item. FINISH_UNCAUGHT: N/A TOUCH_INPUT: BEGIN: When a finger first presses down. CONTINUE: Each frame a finger is touching the screen. FINISH: When the finger is removed from the screen. FINISH_UNCAUGHT: N/A DRAG_INPUT: BEGIN: When the mouse begins to move while holding a button down. CONTINUE: Each frame where the mouse moves while still holding the button. FINISH: When the mouse button is released. |
| integer CONTROL | |
| integer ALT | |
| integer DROP_ITEM_INPUT |
Actions Summary Table
Actions Documentation
AddModifier(integer modifier)
Parameters
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Copy()
This sets the raw bitmask. It intentionally has a nasty technical to warn the user that this action should not be used unless you really, really, know what you are doing.
Return
Empty()
EmptyModifiers()
Equals(Libraries.Game.InputSet set)
Parameters
Return
boolean
Equals(Libraries.Language.Object o)
Parameters
Return
boolean
GetDisplayName()
Return
text
GetHashCode()
Return
integer
GetInputTrigger()
Return
integer
GetInputType()
Return
integer
GetInputValue()
Return
integer
GetModifiers()
Return
HasModifier(integer modifier)
Parameters
Return
boolean
RemoveModifier(integer modifier)
Parameters
Set(Libraries.Game.InputSet set)
Parameters
SetBitMask(integer value)
This sets the raw bitmask. It intentionally has a nasty technical to warn the user that this action should not be used unless you really, really, know what you are doing.
Parameters
SetDragItemInput()
SetDropItemInput()
SetEventCount(integer count)
Parameters
SetInputTrigger(integer type)
Parameters
SetInputType(integer type)
Parameters
SetInputValue(integer value)
Parameters
SetKeyboardInput(integer key)
Parameters
SetMouseInput(integer mouseButton)
Parameters
SetMouseMovementInput(integer mouseButton)
Parameters
ToText()
Return
text