Libraries.Sound.MusicEvent Documentation

This class represents an event in a music track. This is the top level interface describing anything that can be put on a music track, such as Notes and Chords. This class defines constants to describe the various event types. Currently, the only event type supported is "noteOn", which is an event that will sound one or more notes.

Example Code

use Libraries.Sound.MusicEvent

MusicEvent event
event:SetEventType(0)

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
integer noteOnPublic constants. These represent the various event types.

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)

Copy()

Perform a deep copy of this object.

Return

Libraries.Language.Object: the new MusicEvent

Example

use Libraries.Sound.MusicEvent

MusicEvent event
Object newEvent = event:Copy()

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)

GetEventType()

Returns the event type for this event.

Return

integer: the event type.

Example

use Libraries.Sound.MusicEvent

MusicEvent event
output event:GetEventType()

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

SetEventType(integer eventType)

Set the event type for this event.

Parameters

  • integer eventType: the event type for this event.

Example

use Libraries.Sound.MusicEvent

MusicEvent event
event:SetEventType(0)