ParticleEffectMeta

All Superinterfaces:

EffectMeta

All Known Implementing Classes:

ParticleEffectData
```
public ParticleEffectMeta<Location,Player,Material>
extends EffectMeta
```
Handles particleEffects for players.
Version 1.1
MIT License
Copyright (c) 2017 by Shynixn
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`void`	`apply()` Plays the effect at the given location to the given players.
`void`	`apply()` Plays the effect at the given location to the given players.
`ParticleEffectMeta<Location,Player,Material>`	`copy()` Copies the current builder.
`int`	`getAmount()` Returns the amount of particles of the particleEffect.
`int`	`getBlue()` Returns the RGB color blue of the particleEffect.
`java.lang.Byte`	`getData()` Returns the data of the particleEffect.
`java.lang.String`	`getEffectName()` Returns the effect of the particleEffect.
`ParticleEffectMeta.ParticleEffectType`	`getEffectType()` Returns the particleEffectType of the particleEffect.
`int`	`getGreen()` Returns the RGB color green of the particleEffect.
`Material`	`getMaterial()` Returns the material of the particleEffect.
`double`	`getOffsetX()` Returns the offsetX of the particleEffect.
`double`	`getOffsetY()` Returns the offsetY of the particleEffect.
`double`	`getOffsetZ()` Returns the offsetZ of the particleEffect.
`int`	`getRed()` Returns the RGB color red of the particleEffect.
`double`	`getSpeed()` Returns the speed of the particleEffect.
`boolean`	`isColorParticleEffect()` Returns if the particleEffect is a color particleEffect.
`boolean`	`isMaterialParticleEffect()` Returns if the particleEffect is a materialParticleEffect.
`boolean`	`isNoteParticleEffect()` Returns if the particleEffect is a note particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setAmount()` Sets the amount of particles of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setBlue()` Sets the blue of the RGB color.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setColor()` Sets the RGB colors of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setColor()` Sets the color of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setData()` Sets the data of the material of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setEffectName()` Sets the effectType of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setEffectType()` Sets the effectType of the particlEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setGreen()` Sets the green of the RGB color.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setMaterial()` Sets the material of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setNoteColor()` Sets the color for note particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setOffset()` Sets the offset of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setOffsetX()` Sets the offsetX of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setOffsetY()` Sets the offsetY of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setOffsetZ()` Sets the offsetZ of the particleEffect.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setRed()` Sets the red of the RGB color.
`<T extends ParticleEffectMeta<Location,Player,Material>> T`	`setSpeed()` Sets the speed of the particleEffect.

Methods inherited from interface com.github.shynixn.ball.api.persistence.effect.EffectMeta
getEffectingType, setEffectingType

- Method Detail
  - setColor
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setColor()
```
    Sets the RGB colors of the particleEffect.
    
    Returns:
    
    builder
  - setColor
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setColor()
```
    Sets the color of the particleEffect.
    
    Returns:
    
    builder
  - setNoteColor
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setNoteColor()
```
    Sets the color for note particleEffect.
    
    Returns:
    
    builder
  - setAmount
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setAmount()
```
    Sets the amount of particles of the particleEffect.
    
    Returns:
    
    builder
  - setSpeed
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setSpeed()
```
    Sets the speed of the particleEffect.
    
    Returns:
    
    builder
  - setOffsetX
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setOffsetX()
```
    Sets the offsetX of the particleEffect.
    
    Returns:
    
    builder
  - setOffsetY
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setOffsetY()
```
    Sets the offsetY of the particleEffect.
    
    Returns:
    
    builder
  - setOffsetZ
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setOffsetZ()
```
    Sets the offsetZ of the particleEffect.
    
    Returns:
    
    builder
  - setOffset
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setOffset()
```
    Sets the offset of the particleEffect.
    
    Returns:
    
    instance
  - setEffectName
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setEffectName()
```
    Sets the effectType of the particleEffect.
    
    Returns:
    
    builder
  - setEffectType
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setEffectType()
```
    Sets the effectType of the particlEffect.
    
    Returns:
    
    builder
  - setBlue
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setBlue()
```
    Sets the blue of the RGB color.
    
    Returns:
    
    builder
  - setRed
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setRed()
```
    Sets the red of the RGB color.
    
    Returns:
    
    builder
  - setGreen
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setGreen()
```
    Sets the green of the RGB color.
    
    Returns:
    
    builder
  - setMaterial
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setMaterial()
```
    Sets the material of the particleEffect.
    
    Returns:
    
    builder
  - setData
```
<T extends ParticleEffectMeta<Location,Player,Material>> T setData()
```
    Sets the data of the material of the particleEffect.
    
    Returns:
    
    builder
  - getEffectName
```
java.lang.String getEffectName()
```
    Returns the effect of the particleEffect.
    
    Returns:
    
    effectName
  - getEffectType
```
ParticleEffectMeta.ParticleEffectType getEffectType()
```
    Returns the particleEffectType of the particleEffect.
    
    Returns:
    
    effectType
  - getAmount
```
int getAmount()
```
    Returns the amount of particles of the particleEffect.
    
    Returns:
    
    amount
  - getSpeed
```
double getSpeed()
```
    Returns the speed of the particleEffect.
    
    Returns:
    
    speed
  - getOffsetX
```
double getOffsetX()
```
    Returns the offsetX of the particleEffect.
    
    Returns:
    
    offsetX
  - getOffsetY
```
double getOffsetY()
```
    Returns the offsetY of the particleEffect.
    
    Returns:
    
    offsetY
  - getOffsetZ
```
double getOffsetZ()
```
    Returns the offsetZ of the particleEffect.
    
    Returns:
    
    offsetZ
  - getBlue
```
int getBlue()
```
    Returns the RGB color blue of the particleEffect.
    
    Returns:
    
    blue
  - getRed
```
int getRed()
```
    Returns the RGB color red of the particleEffect.
    
    Returns:
    
    red
  - getGreen
```
int getGreen()
```
    Returns the RGB color green of the particleEffect.
    
    Returns:
    
    green
  - getMaterial
```
Material getMaterial()
```
    Returns the material of the particleEffect.
    
    Returns:
    
    material
  - getData
```
java.lang.Byte getData()
```
    Returns the data of the particleEffect.
    
    Returns:
    
    data
  - copy
```
ParticleEffectMeta<Location,Player,Material> copy()
```
    Copies the current builder.
    
    Returns:
    
    copy
  - isColorParticleEffect
```
boolean isColorParticleEffect()
```
    Returns if the particleEffect is a color particleEffect.
    
    Returns:
    
    isColor
  - isNoteParticleEffect
```
boolean isNoteParticleEffect()
```
    Returns if the particleEffect is a note particleEffect.
    
    Returns:
    
    isNote
  - isMaterialParticleEffect
```
boolean isMaterialParticleEffect()
```
    Returns if the particleEffect is a materialParticleEffect.
    
    Returns:
    
    isMaterial
  - apply
```
void apply()
```
    Plays the effect at the given location to the given players.
  - apply
```
void apply()
```
    Plays the effect at the given location to the given players.

Interface ParticleEffectMeta<Location,Player,Material>

Method Summary

Methods inherited from interface com.github.shynixn.ball.api.persistence.effect.EffectMeta

Method Detail

setColor

setColor

setNoteColor

setAmount

setSpeed

setOffsetX

setOffsetY

setOffsetZ

setOffset

setEffectName

setEffectType

setBlue

setRed

setGreen

setMaterial

setData

getEffectName

getEffectType

getAmount

getSpeed

getOffsetX

getOffsetY

getOffsetZ

getBlue

getRed

getGreen

getMaterial

getData

copy

isColorParticleEffect

isNoteParticleEffect

isMaterialParticleEffect

apply

apply