Package dev.prozilla.pine.core.entity.prefab.particle

Class ParticlePrefab

java.lang.Object

dev.prozilla.pine.core.entity.prefab.Prefab

dev.prozilla.pine.core.entity.prefab.sprite.SpritePrefab

dev.prozilla.pine.core.entity.prefab.particle.ParticlePrefab

public class ParticlePrefab
extends SpritePrefab

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	animateSprite
protected boolean	applyTimeScale
protected VariableProperty<Color>	color
protected VariableAnimatedColorProperty	colorAnimation
static final VariableProperty<Float>	DEFAULT_LIFETIME
protected int	frameCount
protected VariableProperty<Integer>	initialFrame
protected VariableProperty<Float>	lifetime
protected VariableProperty<Float>	scale
protected VariableAnimatedFloatProperty	scaleAnimation
protected VariableProperty<Vector2f>	velocity

Fields inherited from class dev.prozilla.pine.core.entity.prefab.sprite.SpritePrefab

cropToRegion, regionOffset, regionSize, texture

Fields inherited from class dev.prozilla.pine.core.entity.prefab.Prefab

isActive, name, tag

Constructor Summary

Constructors

Constructor	Description
ParticlePrefab(TextureBase texture)
ParticlePrefab(TextureBase texture, VariableProperty<Float> lifetime)
ParticlePrefab(String texturePath)
ParticlePrefab(String texturePath, VariableProperty<Float> lifetime)

Method Summary

Modifier and Type	Method	Description
protected void	apply(Entity entity)	Adds this prefab's predefined components to a given entity and copies values from this prefab.
void	setAnimateSprite(boolean animateSprite)
void	setApplyTimeScale(boolean applyTimeScale)
void	setColor(VariableProperty<Color> color)
void	setColor(Color color)
void	setColorAlphaAnimation(Color base, EasingFunction easingFunction)	Adds an animation for the alpha value of the particle's color, going from 1f to 0f.
void	setColorAlphaAnimation(Color base, VariableProperty<Float> alphaStart, VariableProperty<Float> alphaEnd)	Adds a linear animation for the alpha value of the particle's color.
void	setColorAlphaAnimation(Color base, VariableProperty<Float> alphaStart, VariableProperty<Float> alphaEnd, EasingFunction easingFunction)	Adds an animation for the alpha value of the particle's color.
void	setColorAnimation(VariableProperty<Color> start, VariableProperty<Color> end)	Adds a linear animation for the color of the particle.
void	setColorAnimation(VariableProperty<Color> start, VariableProperty<Color> end, EasingFunction easingFunction)	Adds an animation for the color of the particle.
void	setFrame(VariableProperty<Integer> frame)
void	setFrameCount(int frameCount)
void	setInitialFrame(VariableProperty<Integer> initialFrame)
void	setLifetime(VariableProperty<Float> lifetime)
void	setScale(float scale)
void	setScale(VariableProperty<Float> scale)
void	setScaleAnimation(VariableProperty<Float> start, VariableProperty<Float> end)	Adds a linear animation for the scale of the particle.
void	setScaleAnimation(VariableProperty<Float> start, VariableProperty<Float> end, EasingFunction easingFunction)	Adds an animation for the scale of the particle.
void	setVelocity(VariableProperty<Vector2f> velocity)

Methods inherited from class dev.prozilla.pine.core.entity.prefab.sprite.SpritePrefab

setRegion

Methods inherited from class dev.prozilla.pine.core.entity.prefab.Prefab

instantiate, instantiate, setActive, setName, setTag

Methods inherited from class java.lang.Object

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

Field Details

color

protected VariableProperty<Color> color

lifetime

protected VariableProperty<Float> lifetime

velocity

protected VariableProperty<Vector2f> velocity

scale

protected VariableProperty<Float> scale

applyTimeScale

protected boolean applyTimeScale

scaleAnimation

protected VariableAnimatedFloatProperty scaleAnimation

colorAnimation

protected VariableAnimatedColorProperty colorAnimation

frameCount

protected int frameCount

animateSprite

protected boolean animateSprite

initialFrame

protected VariableProperty<Integer> initialFrame

DEFAULT_LIFETIME

public static final VariableProperty<Float> DEFAULT_LIFETIME

Constructor Details

ParticlePrefab

public ParticlePrefab(String texturePath)

ParticlePrefab

public ParticlePrefab(TextureBase texture)

ParticlePrefab

public ParticlePrefab(String texturePath,
 VariableProperty<Float> lifetime)

ParticlePrefab

public ParticlePrefab(TextureBase texture,
 VariableProperty<Float> lifetime)

Method Details

setColor

public void setColor(Color color)

Overrides:

setColor in class SpritePrefab

setColor

public void setColor(VariableProperty<Color> color)

setColorAlphaAnimation

public void setColorAlphaAnimation(Color base,
 EasingFunction easingFunction)

Adds an animation for the alpha value of the particle's color, going from 1f to 0f.

setColorAlphaAnimation

public void setColorAlphaAnimation(Color base,
 VariableProperty<Float> alphaStart,
 VariableProperty<Float> alphaEnd)

Adds a linear animation for the alpha value of the particle's color.

setColorAlphaAnimation

public void setColorAlphaAnimation(Color base,
 VariableProperty<Float> alphaStart,
 VariableProperty<Float> alphaEnd,
 EasingFunction easingFunction)

Adds an animation for the alpha value of the particle's color.

setColorAnimation

public void setColorAnimation(VariableProperty<Color> start,
 VariableProperty<Color> end)

Adds a linear animation for the color of the particle.

setColorAnimation

public void setColorAnimation(VariableProperty<Color> start,
 VariableProperty<Color> end,
 EasingFunction easingFunction)

Adds an animation for the color of the particle.

setScale

public void setScale(float scale)

Overrides:

setScale in class SpritePrefab

setScale

public void setScale(VariableProperty<Float> scale)

setScaleAnimation

public void setScaleAnimation(VariableProperty<Float> start,
 VariableProperty<Float> end)

Adds a linear animation for the scale of the particle.

setScaleAnimation

public void setScaleAnimation(VariableProperty<Float> start,
 VariableProperty<Float> end,
 EasingFunction easingFunction)

Adds an animation for the scale of the particle.

setLifetime

public void setLifetime(VariableProperty<Float> lifetime)

setVelocity

public void setVelocity(VariableProperty<Vector2f> velocity)

setFrameCount

public void setFrameCount(int frameCount)

setFrame

public void setFrame(VariableProperty<Integer> frame)

setAnimateSprite

public void setAnimateSprite(boolean animateSprite)

setInitialFrame

public void setInitialFrame(VariableProperty<Integer> initialFrame)

setApplyTimeScale

public void setApplyTimeScale(boolean applyTimeScale)

apply

protected void apply(Entity entity)

Description copied from class: Prefab

Adds this prefab's predefined components to a given entity and copies values from this prefab.

Overrides:

apply in class SpritePrefab