Package com.csse3200.game.components

Class ActionIndicatorComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.rendering.TextureRenderComponent

com.csse3200.game.components.ActionIndicatorComponent

All Implemented Interfaces:

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

public class ActionIndicatorComponent
extends TextureRenderComponent

A UI component that displays a tutorial image and corresponding key as text.

Field Summary

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

enabled, entity, prio

Constructor Summary

Constructors

Constructor	Description
ActionIndicatorComponent(String imagePath, String keyText)

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the entity is created and registered.
void	dispose()	Called when the component is disposed.
protected void	draw(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)	Draw the renderable.

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

getRotation, getTexture, scaleEntity, setOrigin, setRotation, setTexture

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

compareTo, getLayer, getZIndex, render, setLayer

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

earlyUpdate, getEntity, getPrio, 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

ActionIndicatorComponent

public ActionIndicatorComponent(String imagePath,
 String keyText)

Parameters:

imagePath - Path to the texture for the action's image.

keyText - The text for the action being performed (used to get the keymap)

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

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.

Overrides:

draw in class TextureRenderComponent

Parameters:

batch - Batch to render to.

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 com.badlogic.gdx.utils.Disposable

Overrides:

dispose in class RenderComponent