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

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.
GetHashCode()This action gets the hash code for an object.
ScrolledMouse(Libraries.Interface.Events.MouseEvent event)The ScrolledMouse action is used to respond to MouseEvents created by scrolling the mouse wheel.

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.

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.

ScrolledMouse(Libraries.Interface.Events.MouseEvent event)

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

Parameters