Package com.deco2800.game.components.Guidebook

Class GuidebookDisplay

java.lang.Object

com.deco2800.game.components.Component

com.deco2800.game.rendering.RenderComponent

com.deco2800.game.ui.UIComponent

com.deco2800.game.components.Guidebook.GuidebookDisplay

All Implemented Interfaces:

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

public class GuidebookDisplay
extends UIComponent

Field Summary

Fields

Modifier and Type	Field	Description
static GuidebookStatus	bookStatus
static int	currentPage
static final int	MAX_PAGES

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

skin, stage

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

enabled, entity

Constructor Summary

Constructors

Constructor	Description
GuidebookDisplay()

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the entity is created and registered.
com.badlogic.gdx.scenes.scene2d.ui.Table[]	displayBook()	Displays the guidebook according to the state defined in GuidebookDisplay.bookStatus
void	dispose()	Called when the component is disposed.
void	draw(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)	Draw the renderable.
String	format(String labelContent, int numberPerLine)	Formats a String based on the maximum number of character required per line and places a newline character (i.e., \n) in between line blocks of total character counter less than or equal to the provided number per line
com.badlogic.gdx.scenes.scene2d.ui.Table[]	getGuidebook()
float	getZIndex()	Z index controls rendering order within a layer.
static com.badlogic.gdx.scenes.scene2d.ui.Label	textLabel(String text, int textColour, float fontSize)

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

getLayer, getSkin

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

compareTo, render

Methods inherited from class com.deco2800.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.deco2800.game.rendering.Renderable

render

Field Details

bookStatus

public static GuidebookStatus bookStatus

MAX_PAGES

public static final int MAX_PAGES

currentPage

public static int currentPage

Constructor Details

GuidebookDisplay

public GuidebookDisplay()

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

getGuidebook

public com.badlogic.gdx.scenes.scene2d.ui.Table[] getGuidebook()

displayBook

public com.badlogic.gdx.scenes.scene2d.ui.Table[] displayBook()

Displays the guidebook according to the state defined in GuidebookDisplay.bookStatus

format

public String format(String labelContent,
 int numberPerLine)

Formats a String based on the maximum number of character required per line and places a newline character (i.e., \n) in between line blocks of total character counter less than or equal to the provided number per line

Parameters:

labelContent - : the string to format

numberPerLine - : the maximum character count per line

Returns:

a formatted string as per the description above.

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

textLabel

public static com.badlogic.gdx.scenes.scene2d.ui.Label textLabel(String text,
 int textColour,
 float fontSize)