de.gurkenlabs.litiengine.entities

Class Trigger

java.lang.Object

de.gurkenlabs.litiengine.entities.Entity

de.gurkenlabs.litiengine.entities.CollisionEntity

de.gurkenlabs.litiengine.entities.Trigger

All Implemented Interfaces:

EntityRenderedListener, EntityRenderListener, ICollisionEntity, IEntity, IUpdateable, java.util.EventListener

public class Trigger
extends CollisionEntity
implements IUpdateable

TODO: Triggers should be able to call entity actions (similar to the current message approach)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Trigger.TriggerActivation

Field Summary

Fields inherited from class de.gurkenlabs.litiengine.entities.Entity

ANY_MESSAGE

Constructor Summary

Constructors

Constructor and Description
Trigger(Trigger.TriggerActivation activation, java.lang.String message) Instantiates a new Trigger entity.
Trigger(Trigger.TriggerActivation activation, java.lang.String message, boolean isOneTime) Instantiates a new Trigger entity.
Trigger(Trigger.TriggerActivation activation, java.lang.String message, boolean isOneTime, int cooldown) Initializes a new instance of the Trigger class.
Trigger(Trigger.TriggerActivation activation, java.lang.String name, java.lang.String message) Instantiates a new Trigger entity.
Trigger(Trigger.TriggerActivation activation, java.lang.String name, java.lang.String message, boolean isOneTime) Instantiates a new Trigger entity.

Method Summary

Modifier and Type	Method and Description
void	addActivatedListener(TriggerActivatedListener listener)
void	addActivatingCondition(TriggerActivatingCondition condition)
void	addActivator(IEntity activator)
void	addActivator(int mapId)
void	addDeactivatedListener(TriggerDeactivatedListener listener)
void	addTarget(IEntity target)
void	addTarget(int mapId)
void	addTriggerListener(TriggerListener listener)
boolean	canTrigger(ICollisionEntity entity) Checks whether the specified entity can interact with this trigger.
Trigger.TriggerActivation	getActivationType()
java.util.List<java.lang.Integer>	getActivators()
int	getCooldown()
java.lang.String	getMessage()
java.util.List<java.lang.Integer>	getTargets()
boolean	interact(IEntity sender)
boolean	isActivated()
boolean	isOneTimeTrigger()
void	removeActivatedListener(TriggerActivatedListener listener)
void	removeActivatingCondition(TriggerActivatingCondition condition)
void	removeDeactivatedListener(TriggerDeactivatedListener listener)
void	removeTriggerListener(TriggerListener listener)
void	setCooldown(int cooldown)
void	setHeight(double height)
void	setMessage(java.lang.String message)
void	setSize(double width, double height)
void	setWidth(double width)
void	update() This method is called by the game loop on all objects that are attached to the loop.

Methods inherited from class de.gurkenlabs.litiengine.entities.CollisionEntity

canCollideWith, fireCollisionEvent, getCollisionBox, getCollisionBox, getCollisionBox, getCollisionBoxAlign, getCollisionBoxCenter, getCollisionBoxHeight, getCollisionBoxValign, getCollisionBoxWidth, getCollisionType, hasCollision, onCollision, removeCollisionListener, setCollision, setCollisionBoxAlign, setCollisionBoxHeight, setCollisionBoxValign, setCollisionBoxWidth, setCollisionType, setLocation

Methods inherited from class de.gurkenlabs.litiengine.entities.Entity

actions, addController, addEntityRenderListener, addListener, addTag, addTransformListener, animations, attachControllers, behavior, canRender, detachControllers, getAngle, getBoundingBox, getCenter, getController, getControllers, getEnvironment, getHeight, getLocation, getMapId, getName, getProperties, getRenderType, getTags, getWidth, getX, getY, hasTag, isLoaded, isVisible, loaded, onMessage, onMessage, onRendered, perform, register, removed, removeEntityRenderedListener, removeEntityRenderListener, removeListener, removeMessageListener, removeTag, removeTransformListener, rendered, rendering, renderWithLayer, sendMessage, setAngle, setController, setLocation, setMapId, setName, setRenderType, setRenderWithLayer, setVisible, setX, setY, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gurkenlabs.litiengine.entities.IEntity

actions, addController, addEntityRenderListener, addListener, addTag, addTransformListener, animations, attachControllers, behavior, detachControllers, getAngle, getBoundingBox, getCenter, getController, getEnvironment, getHeight, getLocation, getMapId, getName, getProperties, getRenderType, getTags, getWidth, getX, getY, hasTag, isLoaded, isVisible, loaded, onMessage, onMessage, onRendered, perform, register, removed, removeEntityRenderedListener, removeEntityRenderListener, removeListener, removeMessageListener, removeTag, removeTransformListener, renderWithLayer, sendMessage, setAngle, setController, setLocation, setMapId, setName, setRenderType, setRenderWithLayer, setVisible, setX, setY

Constructor Detail

Trigger

public Trigger(Trigger.TriggerActivation activation,
               java.lang.String message)

Instantiates a new Trigger entity.

Parameters:

activation - The activation method for this trigger.

message - The message that gets sent by this trigger upon activation.

Trigger

public Trigger(Trigger.TriggerActivation activation,
               java.lang.String name,
               java.lang.String message)

Instantiates a new Trigger entity.

Parameters:

activation - The activation method for this trigger.

name - The name of this trigger.

message - The message that gets sent by this trigger upon activation.

Trigger

public Trigger(Trigger.TriggerActivation activation,
               java.lang.String message,
               boolean isOneTime)

Instantiates a new Trigger entity.

Parameters:

activation - The activation method for this trigger.

message - The message that gets sent by this trigger upon activation.

isOneTime - A flag, indicating whether this instance can only be triggered once.

Trigger

public Trigger(Trigger.TriggerActivation activation,
               java.lang.String name,
               java.lang.String message,
               boolean isOneTime)

Instantiates a new Trigger entity.

Parameters:

activation - The activation method for this trigger.

name - The name of this trigger.

message - The message that gets sent by this trigger upon activation.

isOneTime - A flag, indicating whether this instance can only be triggered once.

Trigger

public Trigger(Trigger.TriggerActivation activation,
               java.lang.String message,
               boolean isOneTime,
               int cooldown)

Initializes a new instance of the Trigger class.

Parameters:

activation - The activation method for this trigger.

message - The message that gets sent by this trigger upon activation.

isOneTime - A flag, indicating whether this instance can only be triggered once.

cooldown - The cooldown that needs to be respected between two activation events.

Method Detail

addTriggerListener

public void addTriggerListener(TriggerListener listener)

removeTriggerListener

public void removeTriggerListener(TriggerListener listener)

addActivatedListener

public void addActivatedListener(TriggerActivatedListener listener)

removeActivatedListener

public void removeActivatedListener(TriggerActivatedListener listener)

addActivatingCondition

public void addActivatingCondition(TriggerActivatingCondition condition)

removeActivatingCondition

public void removeActivatingCondition(TriggerActivatingCondition condition)

addDeactivatedListener

public void addDeactivatedListener(TriggerDeactivatedListener listener)

removeDeactivatedListener

public void removeDeactivatedListener(TriggerDeactivatedListener listener)

addActivator

public void addActivator(int mapId)

addActivator

public void addActivator(IEntity activator)

addTarget

public void addTarget(int mapId)

addTarget

public void addTarget(IEntity target)

getActivationType

public Trigger.TriggerActivation getActivationType()

getActivators

public java.util.List<java.lang.Integer> getActivators()

getMessage

public java.lang.String getMessage()

getTargets

public java.util.List<java.lang.Integer> getTargets()

getCooldown

public int getCooldown()

canTrigger

public boolean canTrigger(ICollisionEntity entity)

Checks whether the specified entity can interact with this trigger.

Parameters:

entity - The entity.

Returns:

True if the entity can interact with the trigger; otherwise false.

isOneTimeTrigger

public boolean isOneTimeTrigger()

isActivated

public boolean isActivated()

interact

public boolean interact(IEntity sender)

setMessage

public void setMessage(java.lang.String message)

setHeight

public void setHeight(double height)

Specified by:

setHeight in interface IEntity

Overrides:

setHeight in class CollisionEntity

setWidth

public void setWidth(double width)

Specified by:

setWidth in interface IEntity

Overrides:

setWidth in class CollisionEntity

setSize

public void setSize(double width,
                    double height)

Specified by:

setSize in interface IEntity

Overrides:

setSize in class CollisionEntity

setCooldown

public void setCooldown(int cooldown)

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.

Specified by:

update in interface IUpdateable

See Also:

ClientConfiguration.setMaxFps(int)