Package com.csse3200.game.components.structures

Class StructureToolPicker

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.ui.UIComponent

com.csse3200.game.components.structures.StructureToolPicker

All Implemented Interfaces:

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

public class StructureToolPicker
extends UIComponent

This component can be placed onto the player and allows them to select and interact with structure tools.

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
StructureToolPicker()	Creates a new structure tool picker

Method Summary

Modifier and Type	Method	Description
void	create()	Adds actors to the stage on creation
void	draw(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)	Draw the renderable.
Tool	getSelectedTool()	Returns the currently selected tool.
void	hide()	Hides the tool picker.
void	interact(com.badlogic.gdx.math.GridPoint2 location)	Interacts with the currently selected tool.
boolean	isToolUnlocked(String toolName)	Returns the unlocked status as a boolean
boolean	isVisible()	Returns whether the tool picker is visible.
void	setSelectedTool(Tool tool)	Sets the given tool to be the selected tool.
void	show()	Shows the tool picker.
void	unlockTool(String toolName)	Unlocks a tool, adding it to the structure picker menu

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

getLayer, getZIndex

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

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

StructureToolPicker

public StructureToolPicker()

Creates a new structure tool picker

Method Details

create

public void create()

Adds actors to the stage on creation

Overrides:

create in class UIComponent

unlockTool

public void unlockTool(String toolName)

Unlocks a tool, adding it to the structure picker menu

Parameters:

toolName - - the simple name of the tool, e.g. 'Dirt Wall'

isToolUnlocked

public boolean isToolUnlocked(String toolName)

Returns the unlocked status as a boolean

Parameters:

toolName - - the simple name of the tool, e.g. 'Dirt Wall'

Returns:

boolean - true if unlocked, false if locked.

setSelectedTool

public void setSelectedTool(Tool tool)

Sets the given tool to be the selected tool.

Parameters:

tool - - the tool to be selected.

getSelectedTool

public Tool getSelectedTool()

Returns the currently selected tool.

Returns:

the selected tool.

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.

show

public void show()

Shows the tool picker.

hide

public void hide()

Hides the tool picker.

isVisible

public boolean isVisible()

Returns whether the tool picker is visible.

Returns:

whether the tool picker is visible.

interact

public void interact(com.badlogic.gdx.math.GridPoint2 location)

Interacts with the currently selected tool.

Parameters:

location - - the location being interacted with.