de.gurkenlabs.litiengine.entities

Class Spawnpoint

java.lang.Object

de.gurkenlabs.litiengine.entities.Entity

de.gurkenlabs.litiengine.entities.Spawnpoint

All Implemented Interfaces:

EntityRenderedListener, EntityRenderListener, IEntity, java.util.EventListener

public class Spawnpoint
extends Entity

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Spawnpoint.EntitySpawnedListener

Field Summary

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

ANY_MESSAGE

Constructor Summary

Constructors

Constructor and Description
Spawnpoint()
Spawnpoint(Direction direction)
Spawnpoint(Direction direction, java.lang.String spawnType)
Spawnpoint(double x, double y)
Spawnpoint(int mapId, double x, double y)
Spawnpoint(int mapId, double x, double y, Direction direction)
Spawnpoint(int mapId, java.awt.geom.Point2D point)
Spawnpoint(int mapId, java.awt.geom.Point2D point, Direction direction)

Method Summary

Modifier and Type	Method and Description
Direction	getDirection()
java.lang.String	getSpawnType()
void	onSpawned(Spawnpoint.EntitySpawnedListener listener)
void	removeSpawnedListener(Spawnpoint.EntitySpawnedListener listener)
void	setDirection(Direction direction)
void	setSpawnType(java.lang.String spawnType)
boolean	spawn(IEntity entity) Spawns the specified entity to the Environment of the Spawnpoint or the currently active Environment.

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, setHeight, setLocation, setLocation, setMapId, setName, setRenderType, setRenderWithLayer, setSize, setVisible, setWidth, setX, setY, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Spawnpoint

public Spawnpoint()

Spawnpoint

public Spawnpoint(double x,
                  double y)

Spawnpoint

public Spawnpoint(int mapId,
                  double x,
                  double y)

Spawnpoint

public Spawnpoint(int mapId,
                  java.awt.geom.Point2D point)

Spawnpoint

public Spawnpoint(int mapId,
                  double x,
                  double y,
                  Direction direction)

Spawnpoint

public Spawnpoint(int mapId,
                  java.awt.geom.Point2D point,
                  Direction direction)

Spawnpoint

public Spawnpoint(Direction direction)

Spawnpoint

public Spawnpoint(Direction direction,
                  java.lang.String spawnType)

Method Detail

onSpawned

public void onSpawned(Spawnpoint.EntitySpawnedListener listener)

removeSpawnedListener

public void removeSpawnedListener(Spawnpoint.EntitySpawnedListener listener)

getDirection

public Direction getDirection()

setDirection

public void setDirection(Direction direction)

getSpawnType

public java.lang.String getSpawnType()

setSpawnType

public void setSpawnType(java.lang.String spawnType)

spawn

public boolean spawn(IEntity entity)

Spawns the specified entity to the Environment of the Spawnpoint or the currently active Environment.

Spawning will set the location of the entity to the location defined by the spawnpoint and optionally also set the angle of the entity, if a spawn direction is defined.

Parameters:

entity - The entity to spawn at the specified location.

Returns:

True if the entity was spawned; otherwise false, which is typically the case if no environment is loaded.

See Also:

GameWorld.environment()