Libraries.Interface.Events.MouseWheelListener

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.

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.

Example Code

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

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)

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

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

Example Code

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