Class Prop

java.lang.Object

de.gurkenlabs.litiengine.entities.Entity

de.gurkenlabs.litiengine.entities.CollisionEntity

de.gurkenlabs.litiengine.entities.CombatEntity

de.gurkenlabs.litiengine.entities.Prop

All Implemented Interfaces:

EntityRenderedListener, EntityRenderListener, ICollisionEntity, ICombatEntity, IEntity, Tweenable, EventListener

public class Prop
extends CombatEntity

A static/destructible scenery entity rendered from a sprite. Props extend CombatEntity so they can take damage and be destroyed, and support optional shadow rendering, sprite flipping/rotation and quality-based scaling.

Field Summary

Fields inherited from class CombatEntity

DEFAULT_HITPOINTS

Fields inherited from class Entity

ANY_MESSAGE

Constructor Summary

Constructors

Constructor	Description
Prop(double x, double y, String spritesheetName)	Instantiates a new Prop entity.
Prop(double x, double y, String spritesheetName, Material material)	Instantiates a new Prop entity.
Prop(Point2D location, String spritesheetName)	Instantiates a new Prop entity.
Prop(Point2D location, String spritesheetName, Material material)	Instantiates a new Prop entity.
Prop(String spritesheetName)	Instantiates a new Prop entity.

Method Summary

Modifier and Type	Method	Description
protected IEntityAnimationController<?>	createAnimationController()	Creates the animation controller used to render this prop.
boolean	flipHorizontally()	Returns whether this prop's sprite is flipped horizontally.
boolean	flipVertically()	Returns whether this prop's sprite is flipped vertically.
Material	getMaterial()	Gets the material of this prop.
Rotation	getSpriteRotation()	Gets the sprite rotation applied to this prop.
String	getSpritesheetName()	Gets the name of the spritesheet used to render this prop.
PropState	getState()	Gets the state.
boolean	isAddShadow()	Returns whether this prop should cast a shadow.
boolean	isDead()	Checks if is dead.
boolean	isScaling()	Returns whether this prop's sprite is scaled to its bounding box.
void	setAddShadow(boolean addShadow)	Sets whether this prop should cast a shadow.
void	setFlipHorizontally(boolean flipHorizontally)	Sets whether this prop's sprite is flipped horizontally.
void	setFlipVertically(boolean flipVertically)	Sets whether this prop's sprite is flipped vertically.
void	setMaterial(Material material)	Sets the material of this prop.
void	setScaling(boolean scaling)	Sets whether this prop's sprite should be scaled to its bounding box.
void	setSpriteRotation(Rotation spriteRotation)	Sets the sprite rotation applied to this prop.
void	setSpritesheetName(String spriteName)	Sets the name of the spritesheet used to render this prop and updates the animation controller.
String	toString()

Methods inherited from class CombatEntity

addCombatEntityListener, die, fireDeathEvent, getAppliedEffects, getHitBox, getHitPoints, getTarget, getTeam, getTweenValues, hit, hit, isFriendly, isIndestructible, isNeutral, onDeath, onHit, onResurrect, removeCombatEntityListener, removeListener, removeListener, removeListener, resurrect, setIndestructible, setTarget, setTeam, setTweenValues, wasHit

Methods inherited from class CollisionEntity

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

Methods inherited from class 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, onActionPerformed, onMessage, onMessage, onRendered, perform, register, removeActionPerformedListener, removed, removeListener, removeListener, removeListener, removeListener, removeListener, removeTag, rendered, rendering, renderWithLayer, sendMessage, setAngle, setController, setLocation, setMapId, setName, setRenderType, setRenderWithLayer, setVisible, setX, setY

Methods inherited from class Object

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

Methods inherited from interface ICollisionEntity

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

Methods inherited from interface 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, onActionPerformed, onMessage, onMessage, onRendered, perform, register, removeActionPerformedListener, removed, removeListener, removeListener, removeListener, removeListener, removeListener, removeTag, renderWithLayer, scripts, sendMessage, setAngle, setController, setHeight, setLocation, setLocation, setMapId, setName, setRenderType, setRenderWithLayer, setSize, setVisible, setWidth, setX, setY

Constructor Details

Prop

public Prop(String spritesheetName)

Instantiates a new Prop entity.

Parameters:

spritesheetName - The spritesheet name of this prop.

Prop

public Prop(double x,
 double y,
 String spritesheetName)

Instantiates a new Prop entity.

Parameters:

x - The x-coordinate of this prop.

y - The y-coordinate of this prop.

spritesheetName - The spritesheet name of this prop.

Prop

public Prop(double x,
 double y,
 String spritesheetName,
 Material material)

Instantiates a new Prop entity.

Parameters:

x - The x-coordinate of this prop.

y - The y-coordinate of this prop.

spritesheetName - The spritesheet name of this prop.

material - The material of this prop.

Prop

public Prop(Point2D location,
 String spritesheetName)

Instantiates a new Prop entity.

Parameters:

location - The location of this prop.

spritesheetName - The spritesheet name of this prop.

Prop

public Prop(Point2D location,
 String spritesheetName,
 Material material)

Instantiates a new Prop entity.

Parameters:

location - The location of this prop.

spritesheetName - The spritesheet name of this prop.

material - The material of this prop.

Method Details

getMaterial

public Material getMaterial()

Gets the material of this prop.

Returns:

the material

getSpritesheetName

public String getSpritesheetName()

Gets the name of the spritesheet used to render this prop.

Returns:

the spritesheet name

getState

public PropState getState()

Gets the state.

Returns:

the state

isAddShadow

public boolean isAddShadow()

Returns whether this prop should cast a shadow.

Returns:

true if a shadow is rendered

isScaling

public boolean isScaling()

Returns whether this prop's sprite is scaled to its bounding box.

Returns:

true if scaling is enabled

flipHorizontally

public boolean flipHorizontally()

Returns whether this prop's sprite is flipped horizontally.

Returns:

true if flipped horizontally

flipVertically

public boolean flipVertically()

Returns whether this prop's sprite is flipped vertically.

Returns:

true if flipped vertically

getSpriteRotation

public Rotation getSpriteRotation()

Gets the sprite rotation applied to this prop.

Returns:

the sprite rotation

setMaterial

public void setMaterial(Material material)

Sets the material of this prop.

Parameters:

material - the material to set

setSpritesheetName

public void setSpritesheetName(String spriteName)

Sets the name of the spritesheet used to render this prop and updates the animation controller.

Parameters:

spriteName - the new spritesheet name

setAddShadow

public void setAddShadow(boolean addShadow)

Sets whether this prop should cast a shadow.

Parameters:

addShadow - true to render a shadow

setScaling

public void setScaling(boolean scaling)

Sets whether this prop's sprite should be scaled to its bounding box.

Parameters:

scaling - true to enable scaling

isDead

public boolean isDead()

Description copied from class: CombatEntity

Checks if is dead.

Specified by:

isDead in interface ICombatEntity

Overrides:

isDead in class CombatEntity

Returns:

true, if is dead

setSpriteRotation

public void setSpriteRotation(Rotation spriteRotation)

Sets the sprite rotation applied to this prop.

Parameters:

spriteRotation - the rotation to set

setFlipHorizontally

public void setFlipHorizontally(boolean flipHorizontally)

Sets whether this prop's sprite is flipped horizontally.

Parameters:

flipHorizontally - true to flip horizontally

setFlipVertically

public void setFlipVertically(boolean flipVertically)

Sets whether this prop's sprite is flipped vertically.

Parameters:

flipVertically - true to flip vertically

toString

public String toString()

Overrides:

toString in class Entity

createAnimationController

protected IEntityAnimationController<?> createAnimationController()

Creates the animation controller used to render this prop. Subclasses may override this method to provide a custom controller implementation.

Returns:

the new animation controller

classentitiesapijava