com.github.shynixn.petblocks.api.persistence.entity.ParticleEffectMeta Maven / Gradle / Ivy
package com.github.shynixn.petblocks.api.persistence.entity;
import java.util.Collection;
/**
* 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.
*/
public interface ParticleEffectMeta extends Persistenceable {
/**
* Sets the RGB colors of the particleEffect.
*
* @param red red
* @param green green
* @param blue blue
* @return builder
*/
ParticleEffectMeta setColor(int red, int green, int blue);
/**
* Sets the color of the particleEffect.
*
* @param particleColor particleColor
* @return builder
*/
ParticleEffectMeta setColor(ParticleColor particleColor);
/**
* Sets the color for note particleEffect.
*
* @param color color
* @return builder
*/
ParticleEffectMeta setNoteColor(int color);
/**
* Sets the amount of particles of the particleEffect.
*
* @param amount amount
* @return builder
*/
ParticleEffectMeta setAmount(int amount);
/**
* Sets the speed of the particleEffect.
*
* @param speed speed
* @return builder
*/
ParticleEffectMeta setSpeed(double speed);
/**
* Sets the offsetX of the particleEffect.
*
* @param offsetX offsetX
* @return builder
*/
ParticleEffectMeta setOffsetX(double offsetX);
/**
* Sets the offsetY of the particleEffect.
*
* @param offsetY offsetY
* @return builder
*/
ParticleEffectMeta setOffsetY(double offsetY);
/**
* Sets the offsetZ of the particleEffect.
*
* @param offsetZ offsetZ
* @return builder
*/
ParticleEffectMeta setOffsetZ(double offsetZ);
/**
* Sets the offset of the particleEffect.
*
* @param offsetX offsetX
* @param offsetY offsetY
* @param offsetZ offsetZ
* @return instance
*/
ParticleEffectMeta setOffset(double offsetX, double offsetY, double offsetZ);
/**
* Sets the effectType of the particleEffect.
*
* @param name name
* @return builder
*/
ParticleEffectMeta setEffectName(String name);
/**
* Sets the effectType of the particleEffect.
*
* @param type type
* @return builder
*/
ParticleEffectMeta setEffectType(ParticleEffectType type);
/**
* Sets the blue of the RGB color.
*
* @param blue blue
* @return builder
*/
ParticleEffectMeta setBlue(int blue);
/**
* Sets the red of the RGB color.
*
* @param red red
* @return builder
*/
ParticleEffectMeta setRed(int red);
/**
* Sets the green of the RGB color.
*
* @param green green
* @return builder
*/
ParticleEffectMeta setGreen(int green);
/**
* Sets the material of the particleEffect.
*
* @param material material
* @return builder
*/
ParticleEffectMeta setMaterial(Object material);
/**
* Sets the data of the material of the particleEffect.
*
* @param data data
* @return builder
*/
ParticleEffectMeta setData(Byte data);
/**
* Returns the effect of the particleEffect.
*
* @return effectName
*/
String getEffectName();
/**
* Returns the particleEffectType of the particleEffect.
*
* @return effectType
*/
ParticleEffectType getEffectType();
/**
* Returns the amount of particles of the particleEffect.
*
* @return amount
*/
int getAmount();
/**
* Returns the speed of the particleEffect.
*
* @return speed
*/
double getSpeed();
/**
* Returns the offsetX of the particleEffect.
*
* @return offsetX
*/
double getOffsetX();
/**
* Returns the offsetY of the particleEffect.
*
* @return offsetY
*/
double getOffsetY();
/**
* Returns the offsetZ of the particleEffect.
*
* @return offsetZ
*/
double getOffsetZ();
/**
* Returns the RGB color blue of the particleEffect.
*
* @return blue
*/
int getBlue();
/**
* Returns the RGB color red of the particleEffect.
*
* @return red
*/
int getRed();
/**
* Returns the RGB color green of the particleEffect.
*
* @return green
*/
int getGreen();
/**
* Returns the material of the particleEffect.
*
* @return material
*/
Object getMaterial();
/**
* Returns the data of the particleEffect.
*
* @return data
*/
Byte getData();
/**
* Copies the current builder. Deprecated use copy() instead.
*
* @return copyOfBuilder
*/
@Deprecated
ParticleEffectMeta clone();
/**
* Copies the current object.
* @return copy.
*/
ParticleEffectMeta copy();
/**
* Returns if the particleEffect is a color particleEffect.
*
* @return isColor
*/
boolean isColorParticleEffect();
/**
* Returns if the particleEffect is a note particleEffect.
*
* @return isNote
*/
boolean isNoteParticleEffect();
/**
* Returns if the particleEffect is a materialParticleEffect.
*
* @return isMaterial
*/
boolean isMaterialParticleEffect();
/**
* Plays the effect at the given location to the given players.
*
* @param location location
* @param players players
*/
@Deprecated
void apply(Object location, Collection