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

Actions Documentation

ClickedMouse(Libraries.Interface.Events.MouseEvent event)

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

Parameters

Example

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

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.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

ReleasedMouse(Libraries.Interface.Events.MouseEvent event)

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

Parameters

Example

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