Libraries.Interface.Vibration.VibrationArray Documentation

The VibrationArray class allows to create vibration patterns for use with the Vibration. This class also provides a number of pre-prepared patterns to make the use of the Vibration class easier.

Example Code

use Libraries.Vibration.VibrationCommand
        use Libraries.Game.Game
        use Libraries.Interface.Events.TouchListener
        use Libraries.Interface.Events.TouchEvent

        class Main is Game

            Vibration hm

            action Main
                StartGame()
            end

            action CreateGame
                AddTouchListener(me)
                hm:Initialize()
            end

            action BeganTouch(TouchEvent event)
                VibrationArray pattern
                pattern:Add(20)
                hm:VibratePattern(pattern)
            end

        end

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Add(Libraries.Interface.Vibration.VibrationCommand item)
Add(integer duration, number intensity)
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
DoubleClick()
DoublePulse()
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Get(integer index)
GetHashCode()This action gets the hash code for an object.
GetSize()
LongMedium()
LongStrong()
LongWeak()
Remove(integer index)
RemoveAll()
ShortLow()
ShortMedium()
ShortSharp()
ShortStrong()
ShortWeak()
SimplePattern(integer duration, number intensity, integer cycleLength)

Actions Documentation

Add(Libraries.Interface.Vibration.VibrationCommand item)

Parameters

Add(integer duration, number intensity)

Parameters

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.

Example Code

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

Parameters

Return

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

DoubleClick()

Return

Libraries.Interface.Vibration.VibrationArray

DoublePulse()

Return

Libraries.Interface.Vibration.VibrationArray

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.

Get(integer index)

Parameters

Return

Libraries.Interface.Vibration.VibrationCommand

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.

GetSize()

Return

integer

LongMedium()

Return

Libraries.Interface.Vibration.VibrationArray

LongStrong()

Return

Libraries.Interface.Vibration.VibrationArray

LongWeak()

Return

Libraries.Interface.Vibration.VibrationArray

Remove(integer index)

Parameters

RemoveAll()

ShortLow()

Return

Libraries.Interface.Vibration.VibrationArray

ShortMedium()

Return

Libraries.Interface.Vibration.VibrationArray

ShortSharp()

Return

Libraries.Interface.Vibration.VibrationArray

ShortStrong()

Return

Libraries.Interface.Vibration.VibrationArray

ShortWeak()

Return

Libraries.Interface.Vibration.VibrationArray

SimplePattern(integer duration, number intensity, integer cycleLength)

Parameters

Return

Libraries.Interface.Vibration.VibrationArray