Libraries.Interface.Events.KeyboardProcessor Documentation

This class is used to read KeyboardEvents from the Keyboard and send them to KeyboardListeners which have registered themselves with this processor.

Inherits from: Libraries.Language.Object

Summary

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.
GetEvents()This action returns a List of all of the events that have been stored in this KeyboardProcessor.
GetHashCode()This action gets the hash code for an object.
HasEvents()This action returns true if the KeyboardProcessor has stored any events from the Update action, or false if there are no events stored.
Update()The Update action will check if any keyboard events have occured, and if there are any, it will add them to the events list.

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.

GetEvents()

This action returns a List of all of the events that have been stored in this KeyboardProcessor. Events are stored during the Update action. The KeyboardProcessor will never remove any of its events on its own, so it is necessary for the user to manually remove events once they are finished processing them.

Return

Libraries.Containers.List:

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.

HasEvents()

This action returns true if the KeyboardProcessor has stored any events from the Update action, or false if there are no events stored.

Return

boolean:

Update()

The Update action will check if any keyboard events have occured, and if there are any, it will add them to the events list.