com.github.shynixn.petblocks.api.persistence.entity

Interface ParticleEffectMeta

All Superinterfaces:

Persistenceable

public interface ParticleEffectMeta
extends Persistenceable

ParticleEffect entity.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ParticleEffectMeta.ParticleColor ParticleColors
static class	ParticleEffectMeta.ParticleEffectType

Method Summary

Modifier and Type	Method and Description
ParticleEffectMeta	copy() Copies the current object.
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.
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.
String	getMaterialName() Returns the name of the material.
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.
ParticleEffectMeta	setAmount(int amount) Sets the amount of particles of the particleEffect.
ParticleEffectMeta	setBlue(int blue) Sets the blue of the RGB color.
ParticleEffectMeta	setColor(int red, int green, int blue) Sets the RGB colors of the particleEffect.
ParticleEffectMeta	setColor(ParticleEffectMeta.ParticleColor particleColor) Sets the color of the particleEffect.
ParticleEffectMeta	setData(Byte data) Sets the data of the material of the particleEffect.
ParticleEffectMeta	setEffectName(String name) Sets the effectType of the particleEffect.
ParticleEffectMeta	setEffectType(ParticleEffectMeta.ParticleEffectType type) Sets the effectType of the particleEffect.
ParticleEffectMeta	setGreen(int green) Sets the green of the RGB color.
ParticleEffectMeta	setMaterial(Object material) Sets the material of the particleEffect.
ParticleEffectMeta	setMaterialName(String name) Sets the name of the material
ParticleEffectMeta	setNoteColor(int color) Sets the color for note particleEffect.
ParticleEffectMeta	setOffset(double offsetX, double offsetY, double offsetZ) Sets the offset of the particleEffect.
ParticleEffectMeta	setOffsetX(double offsetX) Sets the offsetX of the particleEffect.
ParticleEffectMeta	setOffsetY(double offsetY) Sets the offsetY of the particleEffect.
ParticleEffectMeta	setOffsetZ(double offsetZ) Sets the offsetZ of the particleEffect.
ParticleEffectMeta	setRed(int red) Sets the red of the RGB color.
ParticleEffectMeta	setSpeed(double speed) Sets the speed of the particleEffect.

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

getId

Method Detail

setColor

ParticleEffectMeta setColor(int red,
                            int green,
                            int blue)

Sets the RGB colors of the particleEffect.

Parameters:

red - red

green - green

blue - blue

Returns:

builder

setColor

ParticleEffectMeta setColor(ParticleEffectMeta.ParticleColor particleColor)

Sets the color of the particleEffect.

Parameters:

particleColor - particleColor

Returns:

builder

setNoteColor

ParticleEffectMeta setNoteColor(int color)

Sets the color for note particleEffect.

Parameters:

color - color

Returns:

builder

setAmount

ParticleEffectMeta setAmount(int amount)

Sets the amount of particles of the particleEffect.

Parameters:

amount - amount

Returns:

builder

setSpeed

ParticleEffectMeta setSpeed(double speed)

Sets the speed of the particleEffect.

Parameters:

speed - speed

Returns:

builder

setOffsetX

ParticleEffectMeta setOffsetX(double offsetX)

Sets the offsetX of the particleEffect.

Parameters:

offsetX - offsetX

Returns:

builder

setOffsetY

ParticleEffectMeta setOffsetY(double offsetY)

Sets the offsetY of the particleEffect.

Parameters:

offsetY - offsetY

Returns:

builder

setOffsetZ

ParticleEffectMeta setOffsetZ(double offsetZ)

Sets the offsetZ of the particleEffect.

Parameters:

offsetZ - offsetZ

Returns:

builder

setOffset

ParticleEffectMeta setOffset(double offsetX,
                             double offsetY,
                             double offsetZ)

Sets the offset of the particleEffect.

Parameters:

offsetX - offsetX

offsetY - offsetY

offsetZ - offsetZ

Returns:

instance

setEffectName

ParticleEffectMeta setEffectName(String name)

Sets the effectType of the particleEffect.

Parameters:

name - name

Returns:

builder

setEffectType

ParticleEffectMeta setEffectType(ParticleEffectMeta.ParticleEffectType type)

Sets the effectType of the particleEffect.

Parameters:

type - type

Returns:

builder

setBlue

ParticleEffectMeta setBlue(int blue)

Sets the blue of the RGB color.

Parameters:

blue - blue

Returns:

builder

setRed

ParticleEffectMeta setRed(int red)

Sets the red of the RGB color.

Parameters:

red - red

Returns:

builder

setGreen

ParticleEffectMeta setGreen(int green)

Sets the green of the RGB color.

Parameters:

green - green

Returns:

builder

setMaterial

ParticleEffectMeta setMaterial(Object material)

Sets the material of the particleEffect.

Parameters:

material - material

Returns:

builder

setMaterialName

ParticleEffectMeta setMaterialName(String name)

Sets the name of the material

Parameters:

name - name

Returns:

builder

setData

ParticleEffectMeta setData(Byte data)

Sets the data of the material of the particleEffect.

Parameters:

data - data

Returns:

builder

getEffectName

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

Object getMaterial()

Returns the material of the particleEffect.

Returns:

material

getMaterialName

String getMaterialName()

Returns the name of the material.

Returns:

material

getData

Byte getData()

Returns the data of the particleEffect.

Returns:

data

copy

ParticleEffectMeta copy()

Copies the current object.

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