org.bukkit
Enum Instrument

java.lang.Object
  extended by java.lang.Enum<Instrument>
      extended by org.bukkit.Instrument
All Implemented Interfaces:
Serializable, Comparable<Instrument>

public enum Instrument
extends Enum<Instrument>


Enum Constant Summary
BASS_DRUM
          Bass drum is normally played when a note block is on top of a stone-like block
BASS_GUITAR
          Bass guitar is normally played when a note block is on top of a wooden block.
PIANO
          Piano is the standard instrument for a note block.
SNARE_DRUM
          Snare drum is normally played when a note block is on top of a sandy block.
STICKS
          Sticks are normally played when a note block is on top of a glass block.
 
Method Summary
static Instrument getByType(byte type)
          Deprecated. Magic value
 byte getType()
          Deprecated. Magic value
static Instrument valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Instrument[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

PIANO

public static final Instrument PIANO
Piano is the standard instrument for a note block.


BASS_DRUM

public static final Instrument BASS_DRUM
Bass drum is normally played when a note block is on top of a stone-like block


SNARE_DRUM

public static final Instrument SNARE_DRUM
Snare drum is normally played when a note block is on top of a sandy block.


STICKS

public static final Instrument STICKS
Sticks are normally played when a note block is on top of a glass block.


BASS_GUITAR

public static final Instrument BASS_GUITAR
Bass guitar is normally played when a note block is on top of a wooden block.

Method Detail

values

public static Instrument[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Instrument c : Instrument.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Instrument valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getType

@Deprecated
public byte getType()
Deprecated. Magic value

Returns:
The type ID of this instrument.

getByType

@Deprecated
public static Instrument getByType(byte type)
Deprecated. Magic value

Get an instrument by its type ID.

Parameters:
type - The type ID
Returns:
The instrument


Copyright © 2013. All Rights Reserved.