com.realtime.crossfire.jxclient.map

Class AnimationState

java.lang.Object

com.realtime.crossfire.jxclient.map.AnimationState

All Implemented Interfaces:

java.lang.Iterable<Location>

public class AnimationState
extends java.lang.Object
implements java.lang.Iterable<Location>

The state of an Animation on a map.

Constructor Summary

Constructors

Constructor and Description
AnimationState(@NotNull Animation animation, int index, @NotNull CfAnimationsMapListener mapListener, @NotNull ItemSet itemSet, @NotNull FacesManager facesManager) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	allocate(int tag) Adds this animation state to an item tag.
void	allocate(@NotNull Location location) Adds this animation state to a map Location.
void	free(int tag) Removes this animation state from an item tag.
void	free(@NotNull Location location) Removes this animation state from a map Location.
void	freeAllLocations() Removes this animation state from all map Locations.
@NotNull java.util.Iterator<Location>	iterator()
void	scroll(int dx, int dy, int width, int height) Scrolls all map locations.
void	setSpeed(int speed) Sets the animation speed.
void	setTickNo(int tickNo) Sets the tick number.
void	updateTickNo(int tickNo) Sets the tick number and update affected faces.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AnimationState

public AnimationState(@NotNull
                      @NotNull Animation animation,
                      int index,
                      @NotNull
                      @NotNull CfAnimationsMapListener mapListener,
                      @NotNull
                      @NotNull ItemSet itemSet,
                      @NotNull
                      @NotNull FacesManager facesManager)

Creates a new instance.

Parameters:

animation - the animation to display

index - the initial face index

mapListener - the map listener to notify of changes

itemSet - the item set to notify of changes

facesManager - the faces manager to track for updated faces

Method Detail

setSpeed

public void setSpeed(int speed)

Sets the animation speed.

Parameters:

speed - the new animation speed to set

setTickNo

public void setTickNo(int tickNo)

Sets the tick number. This function does not update the displayed face.

Parameters:

tickNo - the current tick number

updateTickNo

public void updateTickNo(int tickNo)

Sets the tick number and update affected faces.

Parameters:

tickNo - the tick number

allocate

public void allocate(@NotNull
                     @NotNull Location location)

Adds this animation state to a map Location.

Parameters:

location - the map location

allocate

public void allocate(int tag)

Adds this animation state to an item tag.

Parameters:

tag - the item tag

free

public void free(@NotNull
                 @NotNull Location location)

Removes this animation state from a map Location.

Parameters:

location - the location to free

freeAllLocations

public void freeAllLocations()

Removes this animation state from all map Locations.

free

public void free(int tag)

Removes this animation state from an item tag.

Parameters:

tag - the item tag to free

iterator

@NotNull
public @NotNull java.util.Iterator<Location> iterator()

Specified by:

iterator in interface java.lang.Iterable<Location>

scroll

public void scroll(int dx,
                   int dy,
                   int width,
                   int height)

Scrolls all map locations.

Parameters:

dx - the x distance to scroll

dy - the y distance to scroll

width - the map width

height - the map height