Package com.csse3200.game.components.joinable

Class JoinableComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.rendering.RenderComponent

com.csse3200.game.rendering.AtlasRenderComponent

com.csse3200.game.components.joinable.JoinableComponent

All Implemented Interfaces:

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

public class JoinableComponent
extends AtlasRenderComponent

This component is used to change the texture and collision bounds of an entity depending on its neighbours.

Field Summary

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

enabled, entity, logger

Constructor Summary

Constructors

Constructor	Description
JoinableComponent(com.badlogic.gdx.graphics.g2d.TextureAtlas textures, JoinLayer layer, JoinableComponentShapes shapes)	Creates a joinable component.

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the entity is created and registered.
JoinLayer	getJoinLayer()	Retrieves the layer which is being joined on.
void	notifyNeighbours(boolean isJoined)	Notifies all the entities neighbours of a change in join status.
void	updateJoin(JoinDirection direction, boolean isJoined)	Updates whether the entity should be joining in a given direction.
void	updateTextureAtlas(com.badlogic.gdx.graphics.g2d.TextureAtlas atlas)	Changes the texture atlas being used to the atlas given.

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

draw, scaleEntity, setRegion, updateTextureAtlas

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

compareTo, dispose, getLayer, getZIndex, 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

Constructor Details

JoinableComponent

public JoinableComponent(com.badlogic.gdx.graphics.g2d.TextureAtlas textures,
 JoinLayer layer,
 JoinableComponentShapes shapes)

Creates a joinable component.

Parameters:

textures - - the textures to use for each cardinality

layer - - the layer to join on

shapes - - the collision shapes to use for each cardinality

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 RenderComponent

updateJoin

public void updateJoin(JoinDirection direction,
 boolean isJoined)

Updates whether the entity should be joining in a given direction.

Parameters:

direction - - the direction the entity should / should not be joined in.

isJoined - - whether the entity is joined in the given direction.

notifyNeighbours

public void notifyNeighbours(boolean isJoined)

Notifies all the entities neighbours of a change in join status.

Parameters:

isJoined - - whether the neighbours should or should not be joined.

getJoinLayer

public JoinLayer getJoinLayer()

Retrieves the layer which is being joined on.

Returns:

the layer being joined on.

updateTextureAtlas

public void updateTextureAtlas(com.badlogic.gdx.graphics.g2d.TextureAtlas atlas)

Changes the texture atlas being used to the atlas given.

Parameters:

atlas - - new atlas.