Libraries.Interface.Events.MouseWheelListener Documentation

The MouseWheelListener class is used to listen for and react to MouseEvents where the user has scrolled the mouse wheel. To use a MouseWheelListener in a program, users should make a new class that inherits from it and overrides ScrolledMouse.

Inherits from: Libraries.Language.Object

Actions Documentation

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()

ScrolledMouse(Libraries.Interface.Events.MouseEvent event)

The ScrolledMouse action is used to respond to MouseEvents created by scrolling the mouse wheel.

Parameters

Example

use Libraries.Game.Game
use Libraries.Interface.Events.MouseEvent
use Libraries.Interface.Events.MouseWheelListener
use Libraries.Game.Graphics.Drawable

class Main is Game, MouseWheelListener

    Drawable circle
    number scale = 1.0

    action Main
        StartGame()
    end

    action CreateGame
        circle:LoadFilledCircle(50)
        circle:SetPosition(350, 250)
        Add(circle)

        AddMouseWheelListener(me)
    end

    action ScrolledMouse(MouseEvent event)
        // A positive scroll amount indicates the wheel was scrolled upwards.
        if event:scrollAmount > 0
            scale = scale + 0.1

        // A negative scroll amount indicates the wheel was scrolled downwards.
        elseif event:scrollAmount < 0
            scale = scale - 0.1
        end

        circle:SetScaleFromCenter(scale)
    end
end