Libraries.Interface.Events.KeyboardEvent Documentation

The KeyboardEvent class represents an event on the keyboard, which is caused by the user pushing down or releasing a key. This class also contains constants for the possible keys that may have been pressed or released.

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
integer INSERT
integer DOWN
integer U
integer NUM_5
integer J
integer F9
integer D
integer ESCAPE
integer NUMPAD_6
integer F12
integer keyCodeThe keyCode corresponds to one of the constant values in this class. The default value of 0 is equal to the "UNKNOWN" constant.
integer H
integer A
integer END
integer F4
integer GRAVE
integer RELEASED_KEY
integer F11
integer T
integer X
integer Q
integer F2
integer NUM_8
integer E
integer SHIFT_RIGHT
integer Y
integer NUM_7
integer NUM_0
integer NUMPAD_2
integer META_LEFT
integer eventTypeThis is either PRESSED_KEY or RELEASED_KEY.
integer COLON
integer ALT_RIGHT
integer V
integer ANY_KEY
integer C
integer F10
integer SHIFT_LEFT
integer F7
integer R
integer F6
integer B
integer M
integer F
integer EQUALS
integer CONTROL_RIGHT
integer NUM_4
integer I
integer META_RIGHT
integer RIGHT
integer NUMPAD_MINUS
integer NUMPAD_3
integer NUMPAD_5
integer O
integer SEMICOLON
integer FORWARD_DELETE
integer NUM_2
integer CAPS_LOCK
integer LEFT
integer BACKSPACE
integer NUMPAD_DECIMAL
integer HOME
integer PAGE_UP
integer F8
integer NUMPAD_9
integer PAUSE
integer S
integer NUMPAD_1
integer NUMPAD_7
integer NUMPAD_STAR
integer NUM_LOCK
integer UNKNOWN
integer F1
integer L
integer NUMPAD_ENTER
integer G
integer PAGE_DOWN
integer ENTER
integer NUMPAD_8
integer POWER
integer NUMPAD_EQUALS
integer CONTROL_LEFT
integer TAB
integer PRINT_SCREEN
integer SPACE
integer NUM_3
integer W
integer NUM_1
integer UP
integer MINUS
integer ALT_LEFT
integer NUMPAD_PLUS
integer F3
integer K
integer NUMPAD_0
integer N
integer PERIOD
integer RIGHT_BRACKET
integer NUMPAD_4
integer Z
integer SCROLL_LOCK
integer COMMA
integer NUM_6
integer BACKSLASH
integer LEFT_BRACKET
integer PRESSED_KEY
integer SLASH
integer F5
integer APOSTROPHE
integer CLEAR
integer NUMPAD_SLASH
integer pressCountHow many key presses have occurred in a short period of time, including this event (if it is a PRESSED_KEY event).
integer P
integer NUM_9

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetPressCount()This action returns how many times the key described by this event has been recently pressed.
ToText(integer keycode, boolean shiftPressed)This action will return the text value represented by a particular key.
ToText(integer keycode)This action will return the text value represented by a particular key.
ToTextShift(integer keycode)This action will return the text value represented by a particular key.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetPressCount()

This action returns how many times the key described by this event has been recently pressed. The time considered to be "recent" is defined by the ApplicationConfiguration (if keyboard input is relevant to the application type). The value returned includes the key being pressed as part of this event, if the event is a PRESSED_KEY event - e.g., if a key is pressed exactly once, the value returned is 1. If a key is pressed twice in rapid succession, the value returned will be 2.

Return

integer: How many times the key has been recently pressed.

ToText(integer keycode, boolean shiftPressed)

This action will return the text value represented by a particular key. The boolean represents whether the text should use the shift-keyed value, e.g., the "A" key on the keyboard can represent the text "a" if shiftPressed is false, or "A" if shiftPressed is true.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Events.KeyboardEvent
    use Libraries.Interface.Events.KeyboardListener
    use Libraries.Game.InputMonitor

    class Main is Game, KeyboardListener

        InputMonitor monitor

        action Main
            StartGame()
        end

        action CreateGame
            AddKeyboardListener(me)
        end

        action PressedKey(KeyboardEvent event)
            boolean shift = monitor:IsKeyPressed(event:SHIFT_LEFT) or monitor:IsKeyPressed(event:SHIFT_RIGHT)
            text key = event:ToText(event:keyCode, shift)
            output "The pressed key was " + key + "."
        end
    end

Parameters

Return

text:

ToText(integer keycode)

This action will return the text value represented by a particular key. The returned text value assumes that the shift key is not being held down.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Events.KeyboardEvent
    use Libraries.Interface.Events.KeyboardListener

    class Main is Game, KeyboardListener

        action Main
            StartGame()
        end

        action CreateGame
            AddKeyboardListener(me)
        end

        action PressedKey(KeyboardEvent event)
            text key = event:ToText(event:keyCode)
            output "The pressed key was " + key + "."
        end
    end

Parameters

Return

text:

ToTextShift(integer keycode)

This action will return the text value represented by a particular key. The returned text value assumes that the shift key is being held down.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Events.KeyboardEvent
    use Libraries.Interface.Events.KeyboardListener

    class Main is Game, KeyboardListener

        action Main
            StartGame()
        end

        action CreateGame
            AddKeyboardListener(me)
        end

        action PressedKey(KeyboardEvent event)
            text key = event:ToTextShift(event:keyCode)
            output "The pressed key was " + key + "."
        end
    end

Parameters

Return

text: