Libraries.Interface.Events.MouseListener Documentation

The MouseListener class is used to listen for and react to MouseEvents where the user has clicked or released a mouse button. To use a MouseListener in a program, users should make a new class that inherits from it and overrides ClickedMouse and/or ReleasedMouse.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
ClickedMouse(Libraries.Interface.Events.MouseEvent event)This action is used to respond to a MouseEvent where a mouse button was clicked.
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.
ReleasedMouse(Libraries.Interface.Events.MouseEvent event)This action is used to respond to a MouseEvent where a mouse button was released.

Actions Documentation

ClickedMouse(Libraries.Interface.Events.MouseEvent event)

This action is used to respond to a MouseEvent where a mouse button was clicked.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Events.MouseEvent
    use Libraries.Interface.Events.MouseListener

    class Main is Game, MouseListener

        action Main
            StartGame()
        end

        action CreateGame
            AddMouseListener(me)
        end

        action ClickedMouse(MouseEvent event)
            integer x = event:GetX()
            integer y = event:GetY()
            output "The mouse was clicked at " + x + ", " + y
        end
    end

Parameters

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.

ReleasedMouse(Libraries.Interface.Events.MouseEvent event)

This action is used to respond to a MouseEvent where a mouse button was released.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Events.MouseEvent
    use Libraries.Interface.Events.MouseListener

    class Main is Game, MouseListener

        action Main
            StartGame()
        end

        action CreateGame
            AddMouseListener(me)
        end

        action ReleasedMouse(MouseEvent event)
            integer x = event:GetX()
            integer y = event:GetY()
            output "The mouse was released at " + x + ", " + y
        end
    end

Parameters