Package com.csse3200.game.components.cutscenes

Class CutsceneDisplay

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.ui.UIComponent

com.csse3200.game.components.cutscenes.CutsceneDisplay

All Implemented Interfaces:

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

public class CutsceneDisplay
extends UIComponent

Field Summary

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

skin, stage

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

enabled, entity

Constructor Summary

Constructors

Constructor	Description
CutsceneDisplay(String dialogue, Cutscene cutscene, Cutscene.CutsceneType cutsceneType)	Creates a cutscene display using the given parameters

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.
void	recoverExternalUI()	Recovers the UI components that were removed back onto the screen
void	removeExternalUI()	Removes the UI components on the screen so that cutscene is not so cluttered
void	spawnCutsceneDisplay()	Spawns all the UI elements for the cutscene display

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

getLayer, getZIndex

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

compareTo, 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

Constructor Details

CutsceneDisplay

public CutsceneDisplay(String dialogue,
 Cutscene cutscene,
 Cutscene.CutsceneType cutsceneType)

Creates a cutscene display using the given parameters

Parameters:

dialogue - the dialogue that will be displayed

cutscene - the cutscene object that created the cutscene display

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

spawnCutsceneDisplay

public void spawnCutsceneDisplay()

Spawns all the UI elements for the cutscene display

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

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.

removeExternalUI

public void removeExternalUI()

Removes the UI components on the screen so that cutscene is not so cluttered

recoverExternalUI

public void recoverExternalUI()

Recovers the UI components that were removed back onto the screen