Package com.csse3200.game.components.hud

Class PauseMenu

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.ui.UIComponent

com.csse3200.game.components.hud.PauseMenu

All Implemented Interfaces:

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

public class PauseMenu
extends UIComponent

A pause menu component that displays when the game is paused. Shows a dimmed background and menu options.

Field Summary

Fields inherited from class com.csse3200.game.ui.UIComponent

skin, stage

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

colour

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

enabled, entity

Constructor Summary

Constructors

Constructor	Description
PauseMenu()

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.
void	draw(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)	Draw the renderable.
float	getZIndex()	Z index controls rendering order within a layer.
void	hide()	Hides the pause menu with animation
boolean	isVisible()	Returns whether the pause menu is currently visible
void	setVisible(boolean visible)	Sets the visibility of the pause menu
void	show()	Shows the pause menu with animation

Methods inherited from class com.csse3200.game.ui.UIComponent

getLayer

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

compareTo, getColour, render, setColour

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

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

PauseMenu

public PauseMenu()

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 UIComponent

show

public void show()

Shows the pause menu with animation

hide

public void hide()

Hides the pause menu with animation

setVisible

public void setVisible(boolean visible)

Sets the visibility of the pause menu

Parameters:

visible - Whether the pause menu should be visible

isVisible

public boolean isVisible()

Returns whether the pause menu is currently visible

Returns:

Whether the pause menu is currently visible

draw

public 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.

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 UIComponent

Returns:

Z index

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