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 ColorProperty	color
protected VariableAnimatedColorProperty	colorAnimation
static final FixedFloatProperty	DEFAULT_LIFETIME
protected int	frameCount
protected IntProperty	initialFrame
protected FloatProperty	lifetime
protected FloatProperty	scale
protected VariableAnimatedFloatProperty	scaleAnimation
protected Vector2fProperty	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

children, isActive, name, tag

Constructor Summary

Constructors

Constructor	Description
ParticlePrefab(TextureAsset texture)
ParticlePrefab(TextureAsset texture, FloatProperty lifetime)
ParticlePrefab(String texturePath)
ParticlePrefab(String texturePath, FloatProperty 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(ColorProperty 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, FloatProperty alphaStart, FloatProperty alphaEnd)	Adds a linear animation for the alpha value of the particle's color.
void	setColorAlphaAnimation(Color base, FloatProperty alphaStart, FloatProperty alphaEnd, EasingFunction easingFunction)	Adds an animation for the alpha value of the particle's color.
void	setColorAnimation(ColorProperty start, ColorProperty end)	Adds a linear animation for the color of the particle.
void	setColorAnimation(ColorProperty start, ColorProperty end, EasingFunction easingFunction)	Adds an animation for the color of the particle.
void	setFrame(IntProperty frame)
void	setFrameCount(int frameCount)
void	setInitialFrame(IntProperty initialFrame)
void	setLifetime(FloatProperty lifetime)
void	setScale(Vector2f scale)
void	setScale(FloatProperty scale)
void	setScaleAnimation(FloatProperty start, FloatProperty end)	Adds a linear animation for the scale of the particle.
void	setScaleAnimation(FloatProperty start, FloatProperty end, EasingFunction easingFunction)	Adds an animation for the scale of the particle.
void	setVelocity(Vector2fProperty 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

addChild, addChildren, addChildren, instantiate, instantiate, removeChild, 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 ColorProperty color

lifetime

protected FloatProperty lifetime

velocity

protected Vector2fProperty velocity

scale

protected FloatProperty scale

applyTimeScale

protected boolean applyTimeScale

scaleAnimation

protected VariableAnimatedFloatProperty scaleAnimation

colorAnimation

protected VariableAnimatedColorProperty colorAnimation

frameCount

protected int frameCount

animateSprite

protected boolean animateSprite

initialFrame

protected IntProperty initialFrame

DEFAULT_LIFETIME

public static final FixedFloatProperty DEFAULT_LIFETIME

Constructor Details

ParticlePrefab

public ParticlePrefab(String texturePath)

ParticlePrefab

public ParticlePrefab(TextureAsset texture)

ParticlePrefab

public ParticlePrefab(String texturePath,
 FloatProperty lifetime)

ParticlePrefab

public ParticlePrefab(TextureAsset texture,
 FloatProperty lifetime)

Method Details

setColor

public void setColor(Color color)

Overrides:

setColor in class SpritePrefab

setColor

public void setColor(ColorProperty 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,
 FloatProperty alphaStart,
 FloatProperty alphaEnd)

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

setColorAlphaAnimation

public void setColorAlphaAnimation(Color base,
 FloatProperty alphaStart,
 FloatProperty alphaEnd,
 EasingFunction easingFunction)

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

setColorAnimation

public void setColorAnimation(ColorProperty start,
 ColorProperty end)

Adds a linear animation for the color of the particle.

setColorAnimation

public void setColorAnimation(ColorProperty start,
 ColorProperty end,
 EasingFunction easingFunction)

Adds an animation for the color of the particle.

setScale

public void setScale(Vector2f scale)

Overrides:

setScale in class SpritePrefab

setScale

public void setScale(FloatProperty scale)

setScaleAnimation

public void setScaleAnimation(FloatProperty start,
 FloatProperty end)

Adds a linear animation for the scale of the particle.

setScaleAnimation

public void setScaleAnimation(FloatProperty start,
 FloatProperty end,
 EasingFunction easingFunction)

Adds an animation for the scale of the particle.

setLifetime

public void setLifetime(FloatProperty lifetime)

setVelocity

public void setVelocity(Vector2fProperty velocity)

setFrameCount

public void setFrameCount(int frameCount)

setFrame

public void setFrame(IntProperty frame)

setAnimateSprite

public void setAnimateSprite(boolean animateSprite)

setInitialFrame

public void setInitialFrame(IntProperty 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