Package com.csse3200.game.components.story

Class StoryDisplay

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.ui.UIComponent

com.csse3200.game.components.story.StoryDisplay

All Implemented Interfaces:

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

public class StoryDisplay
extends UIComponent

A UI component for displaying the story screen. Contains all 6 background images for the StoryScreen. Is iterated through using next and back buttons. All displays can be skipped using skip button.

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
StoryDisplay(com.badlogic.gdx.graphics.Texture[] backgroundTextures, int screenNum, String storyName)

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the component is created.
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.

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

getLayer, setStage

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

compareTo, render

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

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

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

StoryDisplay

public StoryDisplay(com.badlogic.gdx.graphics.Texture[] backgroundTextures,
 int screenNum,
 String storyName)

Method Details

create

public void create()

Called when the component is created. Initializes the story UI.

Overrides:

create in class UIComponent

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