Package com.deco2800.game.components.Environmental

Class CollisionEffectComponent

java.lang.Object

com.deco2800.game.components.Component

com.deco2800.game.components.Environmental.CollisionEffectComponent

public class CollisionEffectComponent
extends Component

class containing collision effects defined by the CollisionEffect enum Entities implementing this must also implement ColliderComponent, PhysicsComponent and EnvironmentalComponent To make the effect AoE, a hitboxcomponent must also be added (change the size of hitboxcomponent to change AoE) At this stage, only speed is supported as an AoE effect By default, collision effects impact both players and NPCs. Use SetEffectTarget() to change this.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CollisionEffectComponent.CollisionEffect	Collision effect
static enum	CollisionEffectComponent.EffectTarget	Effect target

Field Summary

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

enabled, entity

Constructor Summary

Constructors

Constructor	Description
CollisionEffectComponent(CollisionEffectComponent.CollisionEffect collisionEffect, float speedModifier)

Method Summary

Modifier and Type	Method	Description
void	create()	initialise the collisionEffect.
CollisionEffectComponent.CollisionEffect	getCollisionEffect()
boolean	isAoe()	honestly just put this in to test.
void	setAoe(boolean AoE)	Sets AoE value to true - used in checks to confirm how to implement collision effect Will do nothing if the entity has no HitboxComponent attached (to avoid null pointer issues later on)
CollisionEffectComponent	setCollisionEffect(CollisionEffectComponent.CollisionEffect effect)	sets collision effect.
void	setDamage(int damage)
void	setEffectTarget(CollisionEffectComponent.EffectTarget target)	sets the entity/ies to be effected
void	setKnockbackForce(float knockbackForce)

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

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

CollisionEffectComponent

public CollisionEffectComponent(CollisionEffectComponent.CollisionEffect collisionEffect,
 float speedModifier)

Method Details

create

public void create()

initialise the collisionEffect. Note this happens after entity has been attached damage and knockbackforce should be set separately, using setDamage() and setKnockbackForce() damage knocks back by default; set knockbackforce to zero to avoid this

Overrides:

create in class Component

getCollisionEffect

public CollisionEffectComponent.CollisionEffect getCollisionEffect()

setDamage

public void setDamage(int damage)

setAoe

public void setAoe(boolean AoE)

Sets AoE value to true - used in checks to confirm how to implement collision effect Will do nothing if the entity has no HitboxComponent attached (to avoid null pointer issues later on)

Parameters:

AoE - whether the effect should be AoE or not

isAoe

public boolean isAoe()

honestly just put this in to test.

Returns:

whether this component uses AoE or collision

setKnockbackForce

public void setKnockbackForce(float knockbackForce)

setEffectTarget

public void setEffectTarget(CollisionEffectComponent.EffectTarget target)

sets the entity/ies to be effected

Parameters:

target - the target effect, from EffectTarget enum (PLAYER/NPC/ALL)

setCollisionEffect

public CollisionEffectComponent setCollisionEffect(CollisionEffectComponent.CollisionEffect effect)

sets collision effect. Requires entity to be attached to ColliderComponent Note that this changes ColliderComponent behaviour - may need to change this depending on desired behaviour

Parameters:

effect - the effect to set, defined in CollisionEffectComponent.SetCollisionEffect enum

Returns:

CollisionEffectComponent