com.quartercode.quarterbukkit.api.particle
Class ParticleDescription

java.lang.Object
  extended by com.quartercode.quarterbukkit.api.particle.ParticleDescription

public class ParticleDescription
extends java.lang.Object

This class describes the look of one particle run.


Constructor Summary
ParticleDescription()
          Creates a new empty particle description.
ParticleDescription(org.bukkit.Color... colors)
          Creates a new particle description and sets the particle Colors as an array/vararg.
ParticleDescription(java.util.List<org.bukkit.Color> colors)
          Creates a new particle description and sets the particle Colors as a List.
ParticleDescription(ParticleShape shape)
          Creates a new particle description and sets the ParticleShape.
ParticleDescription(ParticleShape shape, org.bukkit.Color... colors)
          Creates a new particle description and sets the ParticleShape and the particle Colors as an array/vararg.
ParticleDescription(ParticleShape shape, java.util.List<org.bukkit.Color> colors)
          Creates a new particle description and sets the ParticleShape and the particle Colors as a List.
 
Method Summary
 ParticleDescription addColor(org.bukkit.Color color)
          Adds a particle Color.
 ParticleDescription addFadeColor(org.bukkit.Color fadeColor)
          Adds a fade particle Color.
 java.util.List<org.bukkit.Color> getColors()
          Returns the particle Colors.
 java.util.List<org.bukkit.Color> getFadeColors()
          Returns the fade particle Colors.
 ParticleShape getShape()
          Returns the ParticleShape.
 ParticleDescription removeColor(org.bukkit.Color color)
          Removes a particle Color.
 ParticleDescription removeFadeColor(org.bukkit.Color fadeColor)
          Removes a fade particle Color.
 ParticleDescription setColors(org.bukkit.Color... colors)
          Sets the particle Colors as an array/vararg.
 ParticleDescription setColors(java.util.List<org.bukkit.Color> colors)
          Sets the particle Colors as a List.
 ParticleDescription setFadeColors(org.bukkit.Color... fadeColors)
          Sets the fade particle Colors as an array/vararg.
 ParticleDescription setFadeColors(java.util.List<org.bukkit.Color> fadeColors)
          Sets the fade particle Colors as a List.
 ParticleDescription setShape(ParticleShape shape)
          Sets the ParticleShape.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParticleDescription

public ParticleDescription()
Creates a new empty particle description.


ParticleDescription

public ParticleDescription(ParticleShape shape)
Creates a new particle description and sets the ParticleShape.

Parameters:
shape - The ParticleShape.

ParticleDescription

public ParticleDescription(org.bukkit.Color... colors)
Creates a new particle description and sets the particle Colors as an array/vararg.

Parameters:
colors - The particle Colors as an array/vararg.

ParticleDescription

public ParticleDescription(java.util.List<org.bukkit.Color> colors)
Creates a new particle description and sets the particle Colors as a List.

Parameters:
colors - The particle Colors as a List.

ParticleDescription

public ParticleDescription(ParticleShape shape,
                           org.bukkit.Color... colors)
Creates a new particle description and sets the ParticleShape and the particle Colors as an array/vararg.

Parameters:
shape - The ParticleShape.
colors - The particle Colors as an array/vararg.

ParticleDescription

public ParticleDescription(ParticleShape shape,
                           java.util.List<org.bukkit.Color> colors)
Creates a new particle description and sets the ParticleShape and the particle Colors as a List.

Parameters:
shape - The ParticleShape.
colors - The particle Colors as a List.
Method Detail

getShape

public ParticleShape getShape()
Returns the ParticleShape.

Returns:
The ParticleShape.

setShape

public ParticleDescription setShape(ParticleShape shape)
Sets the ParticleShape.

Parameters:
shape - The ParticleShape.
Returns:
This particle description.

getColors

public java.util.List<org.bukkit.Color> getColors()
Returns the particle Colors.

Returns:
This particle description.

setColors

public ParticleDescription setColors(org.bukkit.Color... colors)
Sets the particle Colors as an array/vararg.

Parameters:
colors - The particle Colors as an array/vararg.
Returns:
This particle description.

setColors

public ParticleDescription setColors(java.util.List<org.bukkit.Color> colors)
Sets the particle Colors as a List.

Parameters:
colors - The particle Colors as a List.
Returns:
This particle description.

addColor

public ParticleDescription addColor(org.bukkit.Color color)
Adds a particle Color.

Parameters:
color - The particle Color to add.
Returns:
This particle description.

removeColor

public ParticleDescription removeColor(org.bukkit.Color color)
Removes a particle Color.

Parameters:
color - The particle Color to remove.
Returns:
This particle description.

getFadeColors

public java.util.List<org.bukkit.Color> getFadeColors()
Returns the fade particle Colors.

Returns:
The fade particle Colors.

setFadeColors

public ParticleDescription setFadeColors(org.bukkit.Color... fadeColors)
Sets the fade particle Colors as an array/vararg.

Parameters:
fadeColors - The fade particle Colors as an array/vararg.
Returns:
This particle description.

setFadeColors

public ParticleDescription setFadeColors(java.util.List<org.bukkit.Color> fadeColors)
Sets the fade particle Colors as a List.

Parameters:
fadeColors - The fade particle Colors as a List.
Returns:
This particle description.

addFadeColor

public ParticleDescription addFadeColor(org.bukkit.Color fadeColor)
Adds a fade particle Color.

Parameters:
fadeColor - The fade particle Color to add.
Returns:
This particle description.

removeFadeColor

public ParticleDescription removeFadeColor(org.bukkit.Color fadeColor)
Removes a fade particle Color.

Parameters:
fadeColor - The fade particle Color to remove.
Returns:
This particle description.