Package dev.esophose.playerparticles.styles

Class ParticleStyleCompanion

java.lang.Object

dev.esophose.playerparticles.styles.DefaultParticleStyle

dev.esophose.playerparticles.styles.ParticleStyleCompanion

All Implemented Interfaces:

ParticleStyle

public class ParticleStyleCompanion
extends DefaultParticleStyle

Field Summary

Fields inherited from class dev.esophose.playerparticles.styles.DefaultParticleStyle

playerParticles

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParticleStyleCompanion()

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	getGuiIconMaterialNames()
java.util.List<PParticle>	getParticles(ParticlePair particle, org.bukkit.Location location)	Gets all the particles to display based on the style's logic
protected void	loadSettings(CommentedFileConfiguration config)	Loads the settings for this style
protected void	setDefaultSettings(CommentedFileConfiguration config)	Sets the default settings for this style
void	updateTimers()	Used to update timers for animations, called once per particle tick

Methods inherited from class dev.esophose.playerparticles.styles.DefaultParticleStyle

canBeFixed, canToggleWithCombat, canToggleWithMovement, getFixedEffectOffset, getGuiIconMaterial, getInternalName, getName, isEnabled, loadSettings, setIfNotExists

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.esophose.playerparticles.styles.ParticleStyle

getParticles, hasLongRangeVisibility

Constructor Details

ParticleStyleCompanion

protected ParticleStyleCompanion()

Method Details

getParticles

public java.util.List<PParticle> getParticles(ParticlePair particle, org.bukkit.Location location)

Description copied from interface: ParticleStyle

Gets all the particles to display based on the style's logic

Parameters:

particle - The ParticlePair that contains the particle's data

location - The central location of the particles

Returns:

A List of PParticles to spawn

updateTimers

public void updateTimers()

Description copied from interface: ParticleStyle

Used to update timers for animations, called once per particle tick

getGuiIconMaterialNames

protected java.util.List<java.lang.String> getGuiIconMaterialNames()

Specified by:

getGuiIconMaterialNames in class DefaultParticleStyle

Returns:

A list of Strings to try to turn into Materials

setDefaultSettings

protected void setDefaultSettings(CommentedFileConfiguration config)

Description copied from class: DefaultParticleStyle

Sets the default settings for this style

Specified by:

setDefaultSettings in class DefaultParticleStyle

Parameters:

config - The config to save to

loadSettings

protected void loadSettings(CommentedFileConfiguration config)

Description copied from class: DefaultParticleStyle

Loads the settings for this style

Specified by:

loadSettings in class DefaultParticleStyle

Parameters:

config - The config to load from