de.gurkenlabs.litiengine.graphics.animation

Class CreatureAnimationController<T extends Creature>

java.lang.Object

de.gurkenlabs.litiengine.graphics.animation.AnimationController

de.gurkenlabs.litiengine.graphics.animation.EntityAnimationController<T>

de.gurkenlabs.litiengine.graphics.animation.CreatureAnimationController<T>

All Implemented Interfaces:

IEntityController, IAnimationController, IEntityAnimationController, IUpdateable

public class CreatureAnimationController<T extends Creature>
extends EntityAnimationController<T>

This AnimationController implementation provides animation rules that use naming conventions to provide Animations for Creature implementations. The spritesheet images need to be named according to the following conventions in order to be automatically used by this controller:

• getSpritePrefix()-idle-{DIRECTION}.{EXTENSION}
• getSpritePrefix()-walk-{DIRECTION}.{EXTENSION}

Where {DIRECTION} refers to a value of the Direction enum and getSpritePrefix() refers to the current sprite prefix of the entity. {EXTENSION} refers to a value of the ImageFormat enum.

See Also:

Creature, Direction, IEntity.getName()

Nested Class Summary

Nested classes/interfaces inherited from class de.gurkenlabs.litiengine.graphics.animation.EntityAnimationController

EntityAnimationController.AnimationRule

Constructor Summary

Constructors

Constructor and Description
CreatureAnimationController(T entity, Animation defaultAnimation)
CreatureAnimationController(T entity, boolean useFlippedSpritesAsFallback)
CreatureAnimationController(T entity, boolean useFlippedSpritesAsFallback, Animation defaultAnimation, Animation... animations)

Method Summary

Modifier and Type	Method and Description
Animation	flipAnimation(Spritesheet spriteToFlip, java.lang.String newSpriteName)
protected java.lang.String	getCurrentAnimationName() This method evaluates the current animation name that depends on certain properties of the EntityAnimationController.getEntity().
static java.lang.String	getSpriteName(Creature creature, CreatureAnimationState state)
static java.lang.String	getSpriteName(Creature creature, CreatureAnimationState state, Direction direction)
protected java.lang.String	getSpritePrefix()
boolean	isAutoScaling()

Methods inherited from class de.gurkenlabs.litiengine.graphics.animation.EntityAnimationController

addAnimationRule, getDefaultSpritePrefixes, getEntity, scaleSprite, scaleSprite, setAutoScaling, setSpritePrefix, update

Methods inherited from class de.gurkenlabs.litiengine.graphics.animation.AnimationController

add, add, addListener, attach, buildCurrentCacheKey, detach, getAffineTransform, getAnimation, getAnimations, getCurrentAnimation, getCurrentSprite, getCurrentSprite, getDefaultAnimation, getImageEffects, hasAnimation, isPlaying, playAnimation, remove, remove, removeListener, setAffineTransform, setDefaultAnimation

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gurkenlabs.litiengine.graphics.animation.IAnimationController

add, add, addListener, getAffineTransform, getAnimation, getAnimations, getCurrentAnimation, getCurrentSprite, getCurrentSprite, getDefaultAnimation, getImageEffects, hasAnimation, isPlaying, playAnimation, remove, remove, removeListener, setAffineTransform, setDefaultAnimation

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

attach, detach

Constructor Detail

CreatureAnimationController

public CreatureAnimationController(T entity,
                                   boolean useFlippedSpritesAsFallback)

CreatureAnimationController

public CreatureAnimationController(T entity,
                                   Animation defaultAnimation)

CreatureAnimationController

public CreatureAnimationController(T entity,
                                   boolean useFlippedSpritesAsFallback,
                                   Animation defaultAnimation,
                                   Animation... animations)

Method Detail

isAutoScaling

public boolean isAutoScaling()

Specified by:

isAutoScaling in interface IEntityAnimationController

Overrides:

isAutoScaling in class EntityAnimationController<T extends Creature>

flipAnimation

public Animation flipAnimation(Spritesheet spriteToFlip,
                               java.lang.String newSpriteName)

getSpritePrefix

protected java.lang.String getSpritePrefix()

Overrides:

getSpritePrefix in class EntityAnimationController<T extends Creature>

getCurrentAnimationName

protected java.lang.String getCurrentAnimationName()

This method evaluates the current animation name that depends on certain properties of the EntityAnimationController.getEntity(). Overwriting this method allows to specify more sophisticated animations.

Returns:

The name of the current animation that should be played

getSpriteName

public static java.lang.String getSpriteName(Creature creature,
                                             CreatureAnimationState state)

getSpriteName

public static java.lang.String getSpriteName(Creature creature,
                                             CreatureAnimationState state,
                                             Direction direction)