## Libraries.Vibration.VibrationCommand Documentation

Inherits from: Libraries.Language.Object

## Summary

### Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetDuration()Returns the duration of the VibrationCommand, measured in seconds.
GetHashCode()This action gets the hash code for an object.
GetIntensity()Returns the intensity of the VibrationCommand, a number between 0.
SetDuration(number seconds)Sets the duration of the VibrationCommand, measured in seconds.
SetIntensity(number intensity)Sets the intensity of the VibrationCommand, a number between 0.

## 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.

Example Code

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

#### Return

integer: 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)``````

#### Return

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

### GetDuration()

Returns the duration of the VibrationCommand, measured in seconds.

Example Code

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

class Main is Game, TouchListener

Vibration vibrator

action Main
StartGame()
end

action CreateGame
AddTouchListener(me)
end

action BeganTouch(TouchEvent event)
VibrationArray array
VibrationCommand command

command:SetDuration(1)

output command:GetDuration()

array:Add(command)

vibrator:VibratePattern(array)
end

end``````

#### Return

number: The duration, measured in seconds, of the 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.

### GetIntensity()

Returns the intensity of the VibrationCommand, a number between 0.0 and 1.0.

Example Code

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

class Main is Game, TouchListener

Vibration vibrator

action Main
StartGame()
end

action CreateGame
AddTouchListener(me)
end

action BeganTouch(TouchEvent event)
VibrationArray array

VibrationCommand command

command:SetDuration(1)
command:SetIntensity(0.5)

output command:GetIntensity()

array:Add(command)

vibrator:VibratePattern(array)
end

end``````

#### Return

number: The intensity, a number between 0.0 and 1.0, of the VibrationCommand.

### SetDuration(number seconds)

Sets the duration of the VibrationCommand, measured in seconds.

Example Code

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

class Main is Game, TouchListener

Vibration vibrator

action Main
StartGame()
end

action CreateGame
AddTouchListener(me)
end

action BeganTouch(TouchEvent event)
VibrationArray array
VibrationCommand command

command:SetDuration(1)

array:Add(command)

vibrator:VibratePattern(array)
end

end``````

#### Parameters

• number seconds: The number of seconds for the VibrationCommand to vibrate for.

### SetIntensity(number intensity)

Sets the intensity of the VibrationCommand, a number between 0.0 and 1.0.

Example Code

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

class Main is Game, TouchListener

Vibration vibrator

action Main
StartGame()
end

action CreateGame
AddTouchListener(me)
end

action BeganTouch(TouchEvent event)
VibrationArray array

VibrationCommand command

command:SetDuration(1)
command:SetIntensity(0.5)

array:Add(command)

vibrator:VibratePattern(array)
end

end``````

#### Parameters

• number intensity: The intensity for the VibrationCommand, given by a number between 0.0 and 1.0, which represents the percentage of maximum intensity at which to play.