Package com.deco2800.game.rendering

Class ParticleRenderComponent

java.lang.Object
com.deco2800.game.components.Component
com.deco2800.game.rendering.RenderComponent
com.deco2800.game.rendering.ParticleRenderComponent
All Implemented Interfaces:
Disposable, Renderable, java.lang.Comparable<Renderable>
public class ParticleRenderComponent
extends RenderComponent
Render particle effect for entities.

Usages: ParticleRenderComponent particle = new ParticleRenderComponent("path.party"); entity.addComponent(particle);

Start particle effect: particle.startEffect();

  • Constructor Details

    • ParticleRenderComponent

      public ParticleRenderComponent​(java.lang.String texturePath)
      Constructor of particle effect
      Parameters:
      texturePath - the path of .party file

  • Method Details

    • create

      public void create()
      Description copied from class: Component
      Called when the entity is created and registered. Initial logic such as calls to GetComponent should be made here, not in the constructor which is called before an entity is finished.
      Overrides:
      create in class RenderComponent

    • getZIndex

      public float getZIndex()
      Set the zIndex of the entity according to the y coordinate of the entity and the original zIndex.

      If zIndex is not set originally, then The smaller the Y value, the higher the Z index, so that closer entities are drawn in front.

      If zIndex has been set, zIndex will not change.

      Specified by:
      getZIndex in interface Renderable
      Overrides:
      getZIndex in class RenderComponent
      Returns:
      The drawing priority of the current entity

    • isEffectStart

      public boolean isEffectStart()
      get if the particle effect is start, for test.
      Returns:

    • startEffect

      public void startEffect()
      Start the particle effect on this entity

    • draw

      protected void draw​(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.

    • getParticlePlayTime

      public float getParticlePlayTime()
      Get the playing time of the animation
      Returns:
      float The time the animation has been played (seconds).

    • dispose

      public void dispose()
      Description copied from class: Component
      Called when the component is disposed. Dispose of any internal resources here.
      Specified by:
      dispose in interface Disposable
      Overrides:
      dispose in class RenderComponent