Package com.csse3200.game.components

Class ProximityActivationComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.components.ProximityActivationComponent

Direct Known Subclasses:

FOVComponent

public class ProximityActivationComponent
extends Component

This component can be used to call an entry or exit method when on of the tracking entities enters or exits a proximity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProximityActivationComponent.ProximityFunc

Field Summary

Fields

Modifier and Type	Field	Description
protected final ProximityActivationComponent.ProximityFunc	entered
protected final ProximityActivationComponent.ProximityFunc	exited
protected final float	radius

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

enabled, entity, logger

Constructor Summary

Constructors

Constructor	Description
ProximityActivationComponent(float radius, ProximityActivationComponent.ProximityFunc entered, ProximityActivationComponent.ProximityFunc exited)
ProximityActivationComponent(float radius, Entity entity, ProximityActivationComponent.ProximityFunc entered, ProximityActivationComponent.ProximityFunc exited)
ProximityActivationComponent(float radius, List<Entity> entities, ProximityActivationComponent.ProximityFunc entered, ProximityActivationComponent.ProximityFunc exited)

Method Summary

Modifier and Type	Method	Description
boolean	entityIsInProximity(Entity entity)
void	update()	Checks whether the entity has entered or exited the radius calls the relevant method if so.

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

create, dispose, earlyUpdate, getEntity, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

radius

protected final float radius

entered

protected final ProximityActivationComponent.ProximityFunc entered

exited

protected final ProximityActivationComponent.ProximityFunc exited

Constructor Details

ProximityActivationComponent

public ProximityActivationComponent(float radius,
 Entity entity,
 ProximityActivationComponent.ProximityFunc entered,
 ProximityActivationComponent.ProximityFunc exited)

ProximityActivationComponent

public ProximityActivationComponent(float radius,
 List<Entity> entities,
 ProximityActivationComponent.ProximityFunc entered,
 ProximityActivationComponent.ProximityFunc exited)

ProximityActivationComponent

public ProximityActivationComponent(float radius,
 ProximityActivationComponent.ProximityFunc entered,
 ProximityActivationComponent.ProximityFunc exited)

Method Details

update

public void update()

Checks whether the entity has entered or exited the radius calls the relevant method if so.

Overrides:

update in class Component

entityIsInProximity

public boolean entityIsInProximity(Entity entity)