java.lang.Object

de.gurkenlabs.litiengine.entities.Entity

All Implemented Interfaces:: EntityRenderedListener, EntityRenderListener, IEntity, Tweenable, java.util.EventListener

Direct Known Subclasses:: CollisionEntity, Emitter, LightSource, MapArea, SoundSource, Spawnpoint

public abstract class Entity
extends java.lang.Object
implements IEntity, EntityRenderListener, Tweenable

Field Summary
Fields
Modifier and Type Field Description
static java.lang.String ANY_MESSAGE

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`Entity()`
`protected`	`Entity(boolean renderWithLayer)`
`protected`	`Entity(int mapId)`
`protected`	`Entity(int mapId, java.lang.String name)`
`protected`	`Entity(java.lang.String name)`

Method Summary

Modifier and Type	Method	Description
`EntityActionMap`	`actions()`	All registered actions of this entity.
`void`	`addController(IEntityController controller)`
`void`	`addEntityRenderListener(EntityRenderListener listener)`	Adds the specified entity render listener to receive events and callbacks about the rendering process of entities.
`void`	`addListener(EntityListener listener)`
`void`	`addTag(java.lang.String tag)`
`void`	`addTransformListener(EntityTransformListener listener)`
`IEntityAnimationController<?>`	`animations()`	Gets the entities animation controller.
`void`	`attachControllers()`
`IBehaviorController`	`behavior()`
`boolean`	`canRender(IEntity entity)`	This method gets called before an `Entity` is about to be rendered.
`void`	`detachControllers()`
`double`	`getAngle()`
`java.awt.geom.Rectangle2D`	`getBoundingBox()`
`java.awt.geom.Point2D`	`getCenter()`
`<T extends IEntityController> T`	`getController(java.lang.Class<T> clss)`
`protected EntityControllers`	`getControllers()`
`Environment`	`getEnvironment()`	Gets the environment the entity was loaded to or null if it is not loaded.
`double`	`getHeight()`
`java.awt.geom.Point2D`	`getLocation()`
`int`	`getMapId()`
`java.lang.String`	`getName()`	Gets the name of this entity.
`ICustomPropertyProvider`	`getProperties()`
`RenderType`	`getRenderType()`
`java.util.List<java.lang.String>`	`getTags()`
`float[]`	`getTweenValues(TweenType tweenType)`	Gets one or many values from the target object associated to the given tween type.
`double`	`getWidth()`
`double`	`getX()`
`double`	`getY()`
`boolean`	`hasTag(java.lang.String tag)`
`boolean`	`isLoaded()`	Indicates whether this entity is loaded on the currently active environment.
`boolean`	`isVisible()`
`void`	`loaded(Environment environment)`	This method provides the possibility to implement behavior whenever this entity was added to the environment.
`void`	`onMessage(EntityMessageListener listener)`
`void`	`onMessage(java.lang.String message, EntityMessageListener listener)`
`void`	`onRendered(EntityRenderedListener listener)`	Adds the specified entity rendered listener to receive events when entities were rendered.
`void`	`perform(java.lang.String actionName)`	Performs an `EntityAction` that was previously registered for this entity.
`EntityAction`	`register(java.lang.String name, java.lang.Runnable action)`	Registers an `EntityAction` with the specified name.
`void`	`removed(Environment environment)`	This method provides the possibility to implement behavior whenever this entity was removed from the environment.
`void`	`removeListener(EntityListener listener)`
`void`	`removeListener(EntityMessageListener listener)`
`void`	`removeListener(EntityRenderedListener listener)`	Removes the specified entity rendered listener.
`void`	`removeListener(EntityRenderListener listener)`	Removes the specified entity render listener.
`void`	`removeListener(EntityTransformListener listener)`
`void`	`removeTag(java.lang.String tag)`
`void`	`rendered(EntityRenderEvent event)`	This method gets called after an entity was rendered.
`void`	`rendering(EntityRenderEvent event)`	This method gets called after all rendering checks have successfully passed and right before the entity is about to be rendered.
`boolean`	`renderWithLayer()`	Determines whether this entity is being rendered with the layer it's originating from.
`java.lang.String`	`sendMessage(java.lang.Object sender, java.lang.String message)`
`void`	`setAngle(double angle)`	Sets the angle (in degrees) in which the entity is directed.
`<T extends IEntityController> void`	`setController(java.lang.Class<T> clss, T controller)`
`void`	`setHeight(double height)`
`void`	`setLocation(double x, double y)`
`void`	`setLocation(java.awt.geom.Point2D location)`	Sets the map location.
`void`	`setMapId(int mapId)`	Sets an id which should only be filled when an entity gets added due to map information.
`void`	`setName(java.lang.String name)`
`void`	`setRenderType(RenderType renderType)`
`void`	`setRenderWithLayer(boolean renderWithLayer)`
`void`	`setSize(double width, double height)`
`void`	`setTweenValues(TweenType tweenType, float[] newValues)`	This method is called in a Tween's update() method to set the new interpolated values.
`void`	`setVisible(boolean visible)`
`void`	`setWidth(double width)`
`void`	`setX(double x)`
`void`	`setY(double y)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

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

Field Details
- ANY_MESSAGE
  public static final java.lang.String ANY_MESSAGE
  See Also:
  Constant Field Values
Constructor Details
- Entity
  protected Entity()
- Entity
  protected Entity(boolean renderWithLayer)
- Entity
  protected Entity(int mapId)
- Entity
  protected Entity(java.lang.String name)
- Entity
  protected Entity(int mapId, java.lang.String name)
Method Details
- addTransformListener
  public void addTransformListener(EntityTransformListener listener)
  Specified by:
  addTransformListener in interface IEntity
- removeListener
  public void removeListener(EntityTransformListener listener)
  Specified by:
  removeListener in interface IEntity
- addListener
  public void addListener(EntityListener listener)
  Specified by:
  addListener in interface IEntity
- removeListener
  public void removeListener(EntityListener listener)
  Specified by:
  removeListener in interface IEntity
- onRendered
  public void onRendered(EntityRenderedListener listener)
  Description copied from interface: IEntity
  Adds the specified entity rendered listener to receive events when entities were rendered.
  Specified by:
  onRendered in interface IEntity
  Parameters:
  listener - The listener to add.
- removeListener
  public void removeListener(EntityRenderedListener listener)
  Description copied from interface: IEntity
  Removes the specified entity rendered listener.
  Specified by:
  removeListener in interface IEntity
  Parameters:
  listener - The listener to remove.
- addEntityRenderListener
  public void addEntityRenderListener(EntityRenderListener listener)
  Description copied from interface: IEntity
  Adds the specified entity render listener to receive events and callbacks about the rendering process of entities.
  Specified by:
  addEntityRenderListener in interface IEntity
  Parameters:
  listener - The listener to add.
- removeListener
  public void removeListener(EntityRenderListener listener)
  Description copied from interface: IEntity
  Removes the specified entity render listener.
  Specified by:
  removeListener in interface IEntity
  Parameters:
  listener - The listener to remove.
- onMessage
  public void onMessage(EntityMessageListener listener)
  Specified by:
  onMessage in interface IEntity
- onMessage
  public void onMessage(java.lang.String message, EntityMessageListener listener)
  Specified by:
  onMessage in interface IEntity
- removeListener
  public void removeListener(EntityMessageListener listener)
  Specified by:
  removeListener in interface IEntity
- attachControllers
  public void attachControllers()
  Specified by:
  attachControllers in interface IEntity
- detachControllers
  public void detachControllers()
  Specified by:
  detachControllers in interface IEntity
- getProperties
  public ICustomPropertyProvider getProperties()
  Specified by:
  getProperties in interface IEntity
- getAngle
  public double getAngle()
  Specified by:
  getAngle in interface IEntity
- animations
  public IEntityAnimationController<?> animations()
  Description copied from interface: IEntity
  Gets the entities animation controller.
  Specified by:
  animations in interface IEntity
  Returns:
  The entities animation controller or null if none was registered.
  See Also:
  RenderEngine.renderEntity(java.awt.Graphics2D, IEntity)
- behavior
  public IBehaviorController behavior()
  Specified by:
  behavior in interface IEntity
- addController
  public void addController(IEntityController controller)
  Specified by:
  addController in interface IEntity
- setController
  public <T extends IEntityController> void setController(java.lang.Class<T> clss, T controller)
  Specified by:
  setController in interface IEntity
- getController
  public <T extends IEntityController> T getController(java.lang.Class<T> clss)
  Specified by:
  getController in interface IEntity
- getBoundingBox
  public java.awt.geom.Rectangle2D getBoundingBox()
  Specified by:
  getBoundingBox in interface IEntity
- getCenter
  public java.awt.geom.Point2D getCenter()
  Specified by:
  getCenter in interface IEntity
- getHeight
  public double getHeight()
  Specified by:
  getHeight in interface IEntity
- getLocation
  public java.awt.geom.Point2D getLocation()
  Specified by:
  getLocation in interface IEntity
- getMapId
  public int getMapId()
  Specified by:
  getMapId in interface IEntity
- getName
  public java.lang.String getName()
  Description copied from interface: IEntity
  Gets the name of this entity.
  Specified by:
  getName in interface IEntity
  Returns:
  The name of this entity.
- getRenderType
  public RenderType getRenderType()
  Specified by:
  getRenderType in interface IEntity
- getWidth
  public double getWidth()
  Specified by:
  getWidth in interface IEntity
- getX
  public double getX()
  Specified by:
  getX in interface IEntity
- getY
  public double getY()
  Specified by:
  getY in interface IEntity
- isVisible
  public boolean isVisible()
  Specified by:
  isVisible in interface IEntity
- setVisible
  public void setVisible(boolean visible)
  Specified by:
  setVisible in interface IEntity
- actions
  public EntityActionMap actions()
  Description copied from interface: IEntity
  All registered actions of this entity.
  Specified by:
  actions in interface IEntity
  Returns:
  The EntityActionMap that holds all registered EntityActions for this instance.
  See Also:
  EntityActionMap, IEntity.register(String, Runnable)
- perform
  public void perform(java.lang.String actionName)
  Description copied from interface: IEntity
  Performs an EntityAction that was previously registered for this entity.
  Does nothing in case no action has been registered for the specified actionName.
  Specified by:
  perform in interface IEntity
  Parameters:
  actionName - The name of the action to be performed.
  See Also:
  IEntity.actions(), IEntity.register(String, Runnable)
- register
  public EntityAction register(java.lang.String name, java.lang.Runnable action)
  Description copied from interface: IEntity
  Registers an EntityAction with the specified name. It's later possible to execute these actions on the entity by using the Entity.perform(String actionName) method.
  Specified by:
  register in interface IEntity
  Parameters:
  name - The name of the action to be registered.
  action - The action to be performed by the entity.
  Returns:
  The created EntityAction instance; or null if the name or action parameter were invalid.
  See Also:
  IEntity.perform(String), IEntity.actions()
- sendMessage
  public java.lang.String sendMessage(java.lang.Object sender, java.lang.String message)
  Specified by:
  sendMessage in interface IEntity
- setHeight
  public void setHeight(double height)
  Specified by:
  setHeight in interface IEntity
- setLocation
  public void setLocation(double x, double y)
  Specified by:
  setLocation in interface IEntity
- setLocation
  public void setLocation(java.awt.geom.Point2D location)
  Sets the map location.
  Specified by:
  setLocation in interface IEntity
  Parameters:
  location - the new map location
- setMapId
  public void setMapId(int mapId)
  Sets an id which should only be filled when an entity gets added due to map information.
  Specified by:
  setMapId in interface IEntity
  Parameters:
  mapId - The unique map ID for this IEntity
- setName
  public void setName(java.lang.String name)
  Specified by:
  setName in interface IEntity
- setRenderType
  public void setRenderType(RenderType renderType)
  Specified by:
  setRenderType in interface IEntity
- setSize
  public void setSize(double width, double height)
  Specified by:
  setSize in interface IEntity
- setWidth
  public void setWidth(double width)
  Specified by:
  setWidth in interface IEntity
- setX
  public void setX(double x)
  Specified by:
  setX in interface IEntity
- setY
  public void setY(double y)
  Specified by:
  setY in interface IEntity
- getTags
  public java.util.List<java.lang.String> getTags()
  Specified by:
  getTags in interface IEntity
- hasTag
  public boolean hasTag(java.lang.String tag)
  Specified by:
  hasTag in interface IEntity
- addTag
  public void addTag(java.lang.String tag)
  Specified by:
  addTag in interface IEntity
- removeTag
  public void removeTag(java.lang.String tag)
  Specified by:
  removeTag in interface IEntity
- getTweenValues
  public float[] getTweenValues(TweenType tweenType)
  Description copied from interface: Tweenable
  Gets one or many values from the target object associated to the given tween type. It is used by the Tween Engine to determine starting values.
  Specified by:
  getTweenValues in interface Tweenable
  Parameters:
  tweenType - The tween type of this interpolation, determining which values are modified.
  Returns:
  The array of current tween values.
- setTweenValues
  public void setTweenValues(TweenType tweenType, float[] newValues)
  Description copied from interface: Tweenable
  This method is called in a Tween's update() method to set the new interpolated values.
  Specified by:
  setTweenValues in interface Tweenable
  Parameters:
  tweenType - The tween type of this interpolation, determining which values are modified.
  newValues - The new values determined by the tween equation.
- setAngle
  public void setAngle(double angle)
  Description copied from interface: IEntity
  Sets the angle (in degrees) in which the entity is directed.
  Specified by:
  setAngle in interface IEntity
  Parameters:
  angle - the new angle in degrees
- toString
  public java.lang.String toString()
  Overrides:
  toString in class java.lang.Object
- getEnvironment
  public Environment getEnvironment()
  Description copied from interface: IEntity
  Gets the environment the entity was loaded to or null if it is not loaded.
  Specified by:
  getEnvironment in interface IEntity
  Returns:
  The entity's environment.
- loaded
  public void loaded(Environment environment)
  Description copied from interface: IEntity
  This method provides the possibility to implement behavior whenever this entity was added to the environment.
  Specified by:
  loaded in interface IEntity
  Parameters:
  environment - The environment that the entity was added to
  See Also:
  IEntity.addListener(EntityListener)
- removed
  public void removed(Environment environment)
  Description copied from interface: IEntity
  This method provides the possibility to implement behavior whenever this entity was removed from the environment.
  Specified by:
  removed in interface IEntity
  Parameters:
  environment - The environment that the entity was removed from
  See Also:
  IEntity.addListener(EntityListener)
- isLoaded
  public boolean isLoaded()
  Description copied from interface: IEntity
  Indicates whether this entity is loaded on the currently active environment.
  Specified by:
  isLoaded in interface IEntity
  Returns:
  True if the entity is loaded on the game's currently active environment; otherwise false.
  See Also:
  GameWorld.environment(), IEntity.loaded(Environment), IEntity.removed(Environment)
- renderWithLayer
  public boolean renderWithLayer()
  Description copied from interface: IEntity
  Determines whether this entity is being rendered with the layer it's originating from. This ignores the specified RenderType and makes the entity dependent upon the visibility of it's layer.
  This can only be used, of course, if the entity is related to a MapObject.
  This defaults to false if not explicitly set on the MapObject.
  Specified by:
  renderWithLayer in interface IEntity
  Returns:
  True if the entity should be rendered with the layer of the corresponding map object; otherwise false.
  See Also:
  ILayer.isVisible(), IMapObjectLayer.getMapObjects(), Environment.getEntitiesByLayer(int), Environment.getEntitiesByLayer(String)
- setRenderWithLayer
  public void setRenderWithLayer(boolean renderWithLayer)
  Specified by:
  setRenderWithLayer in interface IEntity
- rendering
  public void rendering(EntityRenderEvent event)
  Description copied from interface: EntityRenderListener
  This method gets called after all rendering checks have successfully passed and right before the entity is about to be rendered.
  Specified by:
  rendering in interface EntityRenderListener
  Parameters:
  event - The event that contains the render data.
- rendered
  public void rendered(EntityRenderEvent event)
  Description copied from interface: EntityRenderedListener
  This method gets called after an entity was rendered.
  Specified by:
  rendered in interface EntityRenderedListener
  Parameters:
  event - The event that contains the render data.
- canRender
  public boolean canRender(IEntity entity)
  Description copied from interface: EntityRenderListener
  This method gets called before an Entity is about to be rendered. Returning false prevents the rendering of the specified entity.
  Specified by:
  canRender in interface EntityRenderListener
  Parameters:
  entity - The entity to be rendered.
  Returns:
  True if the entity should be rendered; otherwise false.
- getControllers
  protected EntityControllers getControllers()

Class Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details