Package com.csse3200.game.entities

Class PlaceableEntity

java.lang.Object

com.csse3200.game.entities.Entity

com.csse3200.game.entities.PlaceableEntity

Direct Known Subclasses:

Fissure, Gate, Turret, Wall

public class PlaceableEntity
extends Entity

Field Summary

Fields inherited from class com.csse3200.game.entities.Entity

components

Constructor Summary

Constructors

Constructor	Description
PlaceableEntity(int width, int height)

Method Summary

Modifier and Type	Method	Description
int	getHeight()
int	getWidth()
PlaceableEntity	irremovable()	This function uses the builder pattern to allow the programmer to make a placeable entity irremovable
boolean	is_irremovable()
void	placed()	This function is called when a PlaceableEntity is placed via the structure placement service.
void	removed()	This function is called when a PlaceableEntity is removed via the structure placement service.
void	willPlace()	This function is called when a PlaceableEntity is going to be placed via the structure placement service.
void	willRemove()	This function is called when a PlaceableEntity is going to be removed via the structure placement service.

Methods inherited from class com.csse3200.game.entities.Entity

addComponent, create, dispose, earlyUpdate, equals, getCenterPosition, getComponent, getComponents, getEntityType, getEvents, getGridPosition, getId, getPosition, getScale, hashCode, scaleHeight, scaleWidth, setEnabled, setEntityType, setPosition, setPosition, setPosition, setScale, setScale, toString, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PlaceableEntity

public PlaceableEntity(int width,
 int height)

Method Details

getWidth

public int getWidth()

getHeight

public int getHeight()

irremovable

public PlaceableEntity irremovable()

This function uses the builder pattern to allow the programmer to make a placeable entity irremovable

Returns:

The placeable entity

placed

public void placed()

This function is called when a PlaceableEntity is placed via the structure placement service. Override this method to implement specific functionality when placed.

removed

public void removed()

This function is called when a PlaceableEntity is removed via the structure placement service. Override this method to implement specific functionality when removed.

willPlace

public void willPlace()

This function is called when a PlaceableEntity is going to be placed via the structure placement service. Override this method to implement specific functionality when the entity is about to be placed.

willRemove

public void willRemove()

This function is called when a PlaceableEntity is going to be removed via the structure placement service. Override this method to implement specific functionality when the entity is about to be removed.

is_irremovable

public boolean is_irremovable()