Package com.csse3200.game.ui

Class UIComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.ui.UIComponent

All Implemented Interfaces:

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

Direct Known Subclasses:

ControlsMenuDisplay, CoordinatesDisplay, CutsceneDisplay, DialogueComponent, DimComponent, EndCreditsDisplay, EntityIndicator, GameAreaDisplay, GameTimeDisplay, HealthDisplay, HungerBar, IntroDisplay, InventoryDisplay, LoseScreenDisplay, MainMenuDisplay, MissionDisplay, OxygenDisplay, PerformanceDisplay, PlantInfoDisplayComponent, PlayerStatsDisplay, ProgressBar, SettingsMenuDisplay, ShipDisplay, TerminalDisplay, ToggleableMap, ToolbarDisplay, WinScreenDisplay

public abstract class UIComponent
extends RenderComponent
implements Renderable

A generic component for rendering onto the ui.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.badlogic.gdx.scenes.scene2d.ui.Skin	skin
protected com.badlogic.gdx.scenes.scene2d.Stage	stage

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

enabled, entity

Constructor Summary

Constructors

Constructor	Description
UIComponent()

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the entity is created and registered.
int	getLayer()	Layer to be rendered in.
float	getZIndex()	Z index controls rendering order within a layer.

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

compareTo, dispose, draw, render

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.csse3200.game.rendering.Renderable

render

Field Details

skin

protected static final com.badlogic.gdx.scenes.scene2d.ui.Skin skin

stage

protected com.badlogic.gdx.scenes.scene2d.Stage stage

Constructor Details

UIComponent

public UIComponent()

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

getLayer

public int getLayer()

Description copied from interface: Renderable

Layer to be rendered in. Higher layers will be rendered on top of lower layers.

Specified by:

getLayer in interface Renderable

Overrides:

getLayer in class RenderComponent

Returns:

layer

getZIndex

public float getZIndex()

Description copied from interface: Renderable

Z index controls rendering order within a layer. Higher Z index is drawn on top.

Specified by:

getZIndex in interface Renderable

Overrides:

getZIndex in class RenderComponent

Returns:

Z index