Package com.csse3200.game.components

Class ParticleComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.components.ParticleComponent

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable, Renderable, Comparable<Renderable>

public class ParticleComponent
extends RenderComponent

Field Summary

Fields inherited from class com.csse3200.game.components.Component

enabled, entity

Constructor Summary

Constructors

Constructor	Description
ParticleComponent(ParticleEffectsConfig effectsConfig)	Creates a new EffectComponent using the effects specified in the effectsConfig.

Method Summary

Modifier and Type	Method	Description
void	create()	Loads the effects specified in the config file into a hashmap for later use.
protected void	draw(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)	Draw the renderable.
void	startEffect(String effectName)	Plays the effect which effectName maps to if it exists.
void	stopEffect(String effectName)	Stops the playing of the effect which effectName maps to if it exists.

Methods inherited from class com.csse3200.game.rendering.RenderComponent

compareTo, dispose, getLayer, getZIndex, overrideZIndex, render

Methods inherited from class com.csse3200.game.components.Component

earlyUpdate, getEntity, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate, update

Methods inherited from class java.lang.Object

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

Constructor Details

ParticleComponent

public ParticleComponent(ParticleEffectsConfig effectsConfig)

Creates a new EffectComponent using the effects specified in the effectsConfig.

Parameters:

effectsConfig - - the config file containing the effects which can be played.

Method Details

create

public void create()

Loads the effects specified in the config file into a hashmap for later use.

Overrides:

create in class RenderComponent

draw

protected void draw(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)

Description copied from class: RenderComponent

Draw the renderable. Should be called only by the renderer, not manually.

Specified by:

draw in class RenderComponent

Parameters:

batch - Batch to render to.

startEffect

public void startEffect(String effectName)

Plays the effect which effectName maps to if it exists. If effectName does not map to a loaded effect, nothing happens.

Parameters:

effectName - - the name of the effect to play as specified in the config file.

stopEffect

public void stopEffect(String effectName)

Stops the playing of the effect which effectName maps to if it exists. If effectName does not map to a loaded effect, nothing happens.

Parameters:

effectName - - the name of the effect to stop as specified in the config file.