com.github.shynixn.petblocks.bukkit.logic.persistence.entity

Class ParticleEffectData

java.lang.Object

com.github.shynixn.petblocks.bukkit.logic.persistence.entity.PersistenceObject

com.github.shynixn.petblocks.bukkit.logic.persistence.entity.ParticleEffectData

All Implemented Interfaces:

com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta, com.github.shynixn.petblocks.api.persistence.entity.Persistenceable, org.bukkit.configuration.serialization.ConfigurationSerializable

public class ParticleEffectData
extends PersistenceObject
implements com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta, org.bukkit.configuration.serialization.ConfigurationSerializable

Copyright 2017 Shynixn

Do not remove this header!

Version 1.0

MIT License

Copyright (c) 2016

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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleColor, com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleEffectType

Constructor Summary

Constructors

Constructor and Description
ParticleEffectData() Initializes a new ParticleEffectData
ParticleEffectData(Map<String,Object> items) Parses the potioneffect out of the map
ParticleEffectData(String effectName, int amount, double speed, double offsetX, double offsetY, double offsetZ) Initializes a new ParticleEffectData with the given params

Method Summary

Modifier and Type	Method and Description
void	apply(Object location) Plays the effect at the given location to the given players.
void	apply(Object location, Collection<Object> players) Plays the effect at the given location to the given players.
void	applyTo(org.bukkit.Location location, org.bukkit.entity.Player... players) Plays the effect at the given location to the given players.
ParticleEffectData	clone() Copies the current builder
boolean	equals(Object o) Checks if 2 builders are equal
int	getAmount() Returns the amount of particles of the particleEffect
int	getBlue() Returns the RGB color blue of the particleEffect
Byte	getData() Returns the data of the particleEffect
String	getEffectName() Returns the effect of the particleEffect
com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleEffectType	getEffectType() Returns the particleEffectType of the particleEffect
int	getGreen() Returns the RGB color green of the particleEffect
Object	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
static com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleEffectType	getParticleEffectFromName(String name) Returns the particleEffectType from name
static String	getParticlesText() Returns a text of all particleEffects to let the user easily view them
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
Map<String,Object>	serialize() Serializes the particleEffect data to be stored to the filesystem
ParticleEffectData	setAmount(int amount) Sets the amount of particles of the particleEffect
ParticleEffectData	setBlue(int blue) Sets the blue of the RGB color
ParticleEffectData	setColor(int red, int green, int blue) Sets the RGB colors of the particleEffect
ParticleEffectData	setColor(com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleColor particleColor) Sets the color of the particleEffect
ParticleEffectData	setData(Byte data) Sets the data of the material of the particleEffect
ParticleEffectData	setEffectName(String name) Sets the effectType of the particleEffect
ParticleEffectData	setEffectType(com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleEffectType type) Sets the effectType of the particlEffect
ParticleEffectData	setGreen(int green) Sets the green of the RGB color
ParticleEffectData	setMaterial(Object material) Sets the material of the particleEffect
ParticleEffectData	setNoteColor(int color) Sets the color for note particleEffect
ParticleEffectData	setOffset(double offsetX, double offsetY, double offsetZ) Sets the offset of the particleEffect
ParticleEffectData	setOffsetX(double offsetX) Sets the offsetX of the particleEffect
ParticleEffectData	setOffsetY(double offsetY) Sets the offsetY of the particleEffect
ParticleEffectData	setOffsetZ(double offsetZ) Sets the offsetZ of the particleEffect
ParticleEffectData	setRed(int red) Sets the red of the RGB color
ParticleEffectData	setSpeed(double speed) Sets the speed of the particleEffect
<T extends Enum<T>> T	toParticle(Class<?> clazz) Converts the effect to a bukkitParticle
String	toString() Displays the builder as string

Methods inherited from class com.github.shynixn.petblocks.bukkit.logic.persistence.entity.PersistenceObject

getId, setId

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.shynixn.petblocks.api.persistence.entity.Persistenceable

getId

Constructor Detail

ParticleEffectData

public ParticleEffectData()

Initializes a new ParticleEffectData

ParticleEffectData

public ParticleEffectData(String effectName,
                          int amount,
                          double speed,
                          double offsetX,
                          double offsetY,
                          double offsetZ)

Initializes a new ParticleEffectData with the given params

Parameters:

effectName - effect

amount - amount

speed - speed

offsetX - x

offsetY - y

offsetZ - z

ParticleEffectData

public ParticleEffectData(Map<String,Object> items)
                   throws Exception

Parses the potioneffect out of the map

Parameters:

items - items

Throws:

Exception - mapParseException

Method Detail

setColor

public ParticleEffectData setColor(int red,
                                   int green,
                                   int blue)

Sets the RGB colors of the particleEffect

Specified by:

setColor in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

red - red

green - green

blue - blue

Returns:

builder

setColor

public ParticleEffectData setColor(com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleColor particleColor)

Sets the color of the particleEffect

Specified by:

setColor in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

particleColor - particleColor

Returns:

builder

setNoteColor

public ParticleEffectData setNoteColor(int color)

Sets the color for note particleEffect

Specified by:

setNoteColor in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

color - color

Returns:

builder

setAmount

public ParticleEffectData setAmount(int amount)

Sets the amount of particles of the particleEffect

Specified by:

setAmount in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

amount - amount

Returns:

builder

setSpeed

public ParticleEffectData setSpeed(double speed)

Sets the speed of the particleEffect

Specified by:

setSpeed in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

speed - speed

Returns:

builder

setOffsetX

public ParticleEffectData setOffsetX(double offsetX)

Sets the offsetX of the particleEffect

Specified by:

setOffsetX in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

offsetX - offsetX

Returns:

builder

setOffsetY

public ParticleEffectData setOffsetY(double offsetY)

Sets the offsetY of the particleEffect

Specified by:

setOffsetY in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

offsetY - offsetY

Returns:

builder

setOffsetZ

public ParticleEffectData setOffsetZ(double offsetZ)

Sets the offsetZ of the particleEffect

Specified by:

setOffsetZ in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

offsetZ - offsetZ

Returns:

builder

setOffset

public ParticleEffectData setOffset(double offsetX,
                                    double offsetY,
                                    double offsetZ)

Sets the offset of the particleEffect

Specified by:

setOffset in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

offsetX - offsetX

offsetY - offsetY

offsetZ - offsetZ

Returns:

instance

setEffectName

public ParticleEffectData setEffectName(String name)

Sets the effectType of the particleEffect

Specified by:

setEffectName in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

name - name

Returns:

builder

setEffectType

public ParticleEffectData setEffectType(com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleEffectType type)

Sets the effectType of the particlEffect

Specified by:

setEffectType in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

type - type

Returns:

builder

setBlue

public ParticleEffectData setBlue(int blue)

Sets the blue of the RGB color

Specified by:

setBlue in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

blue - blue

Returns:

builder

setRed

public ParticleEffectData setRed(int red)

Sets the red of the RGB color

Specified by:

setRed in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

red - red

Returns:

builder

setGreen

public ParticleEffectData setGreen(int green)

Sets the green of the RGB color

Specified by:

setGreen in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

green - green

Returns:

builder

setMaterial

public ParticleEffectData setMaterial(Object material)

Sets the material of the particleEffect

Specified by:

setMaterial in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

material - material

Returns:

builder

setData

public ParticleEffectData setData(Byte data)

Sets the data of the material of the particleEffect

Specified by:

setData in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

data - data

Returns:

builder

getEffectName

public String getEffectName()

Returns the effect of the particleEffect

Specified by:

getEffectName in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

effectName

getEffectType

public com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleEffectType getEffectType()

Returns the particleEffectType of the particleEffect

Specified by:

getEffectType in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

effectType

getAmount

public int getAmount()

Returns the amount of particles of the particleEffect

Specified by:

getAmount in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

amount

getSpeed

public double getSpeed()

Returns the speed of the particleEffect

Specified by:

getSpeed in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

speed

getOffsetX

public double getOffsetX()

Returns the offsetX of the particleEffect

Specified by:

getOffsetX in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

offsetX

getOffsetY

public double getOffsetY()

Returns the offsetY of the particleEffect

Specified by:

getOffsetY in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

offsetY

getOffsetZ

public double getOffsetZ()

Returns the offsetZ of the particleEffect

Specified by:

getOffsetZ in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

offsetZ

getBlue

public int getBlue()

Returns the RGB color blue of the particleEffect

Specified by:

getBlue in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

blue

getRed

public int getRed()

Returns the RGB color red of the particleEffect

Specified by:

getRed in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

red

getGreen

public int getGreen()

Returns the RGB color green of the particleEffect

Specified by:

getGreen in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

green

getMaterial

public Object getMaterial()

Returns the material of the particleEffect

Specified by:

getMaterial in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

material

getData

public Byte getData()

Returns the data of the particleEffect

Specified by:

getData in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

data

clone

public ParticleEffectData clone()

Copies the current builder

Specified by:

clone in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Overrides:

clone in class Object

Returns:

copyOfBuilder

toParticle

public <T extends Enum<T>> T toParticle(Class<?> clazz)

Converts the effect to a bukkitParticle

Type Parameters:

T - Particle

Parameters:

clazz - Clazz to be given for compatibility

Returns:

bukkitParticle

isColorParticleEffect

public boolean isColorParticleEffect()

Returns if the particleEffect is a color particleEffect

Specified by:

isColorParticleEffect in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

isColor

isNoteParticleEffect

public boolean isNoteParticleEffect()

Returns if the particleEffect is a note particleEffect

Specified by:

isNoteParticleEffect in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

isNote

isMaterialParticleEffect

public boolean isMaterialParticleEffect()

Returns if the particleEffect is a materialParticleEffect

Specified by:

isMaterialParticleEffect in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Returns:

isMaterial

apply

public void apply(Object location,
                  Collection<Object> players)

Plays the effect at the given location to the given players.

Specified by:

apply in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

location - location

players - players

apply

public void apply(Object location)

Plays the effect at the given location to the given players.

Specified by:

apply in interface com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta

Parameters:

location - location

applyTo

public void applyTo(org.bukkit.Location location,
                    org.bukkit.entity.Player... players)

Plays the effect at the given location to the given players.

Parameters:

location - location

players - players

equals

public boolean equals(Object o)

Checks if 2 builders are equal

Overrides:

equals in class Object

Parameters:

o - secondBuilder

Returns:

isSame

toString

public String toString()

Displays the builder as string

Overrides:

toString in class Object

Returns:

string

serialize

public Map<String,Object> serialize()

Serializes the particleEffect data to be stored to the filesystem

Specified by:

serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializable

Returns:

serializedContent

getParticlesText

public static String getParticlesText()

Returns a text of all particleEffects to let the user easily view them

Returns:

potionEffects

getParticleEffectFromName

public static com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta.ParticleEffectType getParticleEffectFromName(String name)

Returns the particleEffectType from name

Parameters:

name - name

Returns:

particleEffectType