Inheritance diagram for com.realtime.crossfire.jxclient.map.AnimationState:

Collaboration diagram for com.realtime.crossfire.jxclient.map.AnimationState:

Public Member Functions
void	allocate (@NotNull final Location location)

void	allocate (final int tag)

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

void	free (@NotNull final Location location)

void	free (final int tag)

void	freeAllLocations ()

Iterator< Location >	iterator ()

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

void	setSpeed (final int speed)

void	setTickNo (final int tickNo)

void	updateTickNo (final int tickNo)

Private Member Functions
void	updateFace ()

Private Attributes
final Animation	animation

final FacesManager	facesManager

int	index

final ItemSet	itemSet

int	lastFace = -1

final Set< Location >	locations = new HashSet<>()

final CfAnimationsMapListener	mapListener

int	speed = 1

final Collection< Integer >	tags = new HashSet<>()

int	tickNo

Detailed Description

The state of an Animation on a map.

Author: Andreas Kirschbaum

Definition at line 41 of file AnimationState.java.

Constructor & Destructor Documentation

◆ AnimationState()

com.realtime.crossfire.jxclient.map.AnimationState.AnimationState	(	@NotNull final Animation	animation,
		final int	index,
		@NotNull final CfAnimationsMapListener	mapListener,
		@NotNull final ItemSet	itemSet,
		@NotNull final 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

Definition at line 108 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.animation, com.realtime.crossfire.jxclient.map.AnimationState.facesManager, com.realtime.crossfire.jxclient.animations.Animation.getFaces(), com.realtime.crossfire.jxclient.map.AnimationState.index, com.realtime.crossfire.jxclient.map.AnimationState.itemSet, and com.realtime.crossfire.jxclient.map.AnimationState.mapListener.

Here is the call graph for this function:

Member Function Documentation

◆ allocate() [1/2]

void com.realtime.crossfire.jxclient.map.AnimationState.allocate ( @NotNull final Location location )

Adds this animation state to a map Location.

Parameters

location the map location

Definition at line 177 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.lastFace, com.realtime.crossfire.jxclient.map.AnimationState.locations, com.realtime.crossfire.jxclient.map.CfAnimationsMapListener.mapFace(), and com.realtime.crossfire.jxclient.map.AnimationState.mapListener.

Here is the call graph for this function:

◆ allocate() [2/2]

void com.realtime.crossfire.jxclient.map.AnimationState.allocate ( final int tag )

Adds this animation state to an item tag.

Parameters

tag	the item tag

Definition at line 190 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.facesManager, com.realtime.crossfire.jxclient.faces.FacesManager.getFace(), com.realtime.crossfire.jxclient.map.AnimationState.itemSet, com.realtime.crossfire.jxclient.map.AnimationState.lastFace, com.realtime.crossfire.jxclient.map.AnimationState.tags, com.realtime.crossfire.jxclient.protocol.UpdItem.UPD_FACE, and com.realtime.crossfire.jxclient.items.ItemSet.updateItem().

Here is the call graph for this function:

◆ free() [1/2]

void com.realtime.crossfire.jxclient.map.AnimationState.free ( @NotNull final Location location )

Removes this animation state from a map Location.

Parameters

location the location to free

Definition at line 203 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.locations.

◆ free() [2/2]

void com.realtime.crossfire.jxclient.map.AnimationState.free ( final int tag )

Removes this animation state from an item tag.

Parameters

tag	the item tag to free

Definition at line 220 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.tags.

◆ freeAllLocations()

void com.realtime.crossfire.jxclient.map.AnimationState.freeAllLocations ( )

Removes this animation state from all map Locations.

Definition at line 212 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.locations.

◆ iterator()

Iterator<Location> com.realtime.crossfire.jxclient.map.AnimationState.iterator ( )

Definition at line 228 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.locations.

◆ scroll()

void com.realtime.crossfire.jxclient.map.AnimationState.scroll	(	final int	dx,
		final int	dy,
		final int	width,
		final 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

Definition at line 239 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.locations.

◆ setSpeed()

void com.realtime.crossfire.jxclient.map.AnimationState.setSpeed ( final int speed )

Sets the animation speed.

Parameters

speed the new animation speed to set

Definition at line 120 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.index, com.realtime.crossfire.jxclient.map.AnimationState.speed, and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

Referenced by com.realtime.crossfire.jxclient.map.AnimationSet.updateSpeed(), and com.realtime.crossfire.jxclient.map.AnimationMap.updateSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTickNo()

void com.realtime.crossfire.jxclient.map.AnimationState.setTickNo ( final int tickNo )

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

Parameters

tickNo the current tick number

Definition at line 136 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.tickNo.

◆ updateFace()

void com.realtime.crossfire.jxclient.map.AnimationState.updateFace ( )

private

Updates the map or item face from the state.

Definition at line 158 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.setSpeed(), and com.realtime.crossfire.jxclient.map.AnimationState.updateTickNo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateTickNo()

void com.realtime.crossfire.jxclient.map.AnimationState.updateTickNo ( final int tickNo )

Sets the tick number and update affected faces.

Parameters

tickNo the tick number

Definition at line 144 of file AnimationState.java.

References com.realtime.crossfire.jxclient.map.AnimationState.animation, com.realtime.crossfire.jxclient.animations.Animation.getFaces(), com.realtime.crossfire.jxclient.map.AnimationState.index, com.realtime.crossfire.jxclient.map.AnimationState.speed, com.realtime.crossfire.jxclient.map.AnimationState.tickNo, and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

Here is the call graph for this function:

Member Data Documentation

◆ animation

final Animation com.realtime.crossfire.jxclient.map.AnimationState.animation

private

The Animation to display.

Definition at line 47 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.AnimationState(), com.realtime.crossfire.jxclient.map.AnimationState.updateFace(), and com.realtime.crossfire.jxclient.map.AnimationState.updateTickNo().

◆ facesManager

final FacesManager com.realtime.crossfire.jxclient.map.AnimationState.facesManager

private

The FacesManager to track for updated faces.

Definition at line 65 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.allocate(), com.realtime.crossfire.jxclient.map.AnimationState.AnimationState(), and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

◆ index

int com.realtime.crossfire.jxclient.map.AnimationState.index

private

The face index currently shown. May contain values between 0 and speed*animation.getFaces() (exclusive).

Definition at line 81 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.AnimationState(), com.realtime.crossfire.jxclient.map.AnimationState.setSpeed(), com.realtime.crossfire.jxclient.map.AnimationState.updateFace(), and com.realtime.crossfire.jxclient.map.AnimationState.updateTickNo().

◆ itemSet

final ItemSet com.realtime.crossfire.jxclient.map.AnimationState.itemSet

private

The ItemSet to notify of changes.

Definition at line 59 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.allocate(), com.realtime.crossfire.jxclient.map.AnimationState.AnimationState(), and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

◆ lastFace

int com.realtime.crossfire.jxclient.map.AnimationState.lastFace = -1

private

Records the last known face. Used to suppress redundant map updates.

Definition at line 86 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.allocate(), and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

◆ locations

final Set<Location> com.realtime.crossfire.jxclient.map.AnimationState.locations = new HashSet<>()

private

All map locations this animation is displayed at.

Definition at line 92 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.allocate(), com.realtime.crossfire.jxclient.map.AnimationState.free(), com.realtime.crossfire.jxclient.map.AnimationState.freeAllLocations(), com.realtime.crossfire.jxclient.map.AnimationState.iterator(), com.realtime.crossfire.jxclient.map.AnimationState.scroll(), and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

◆ mapListener

final CfAnimationsMapListener com.realtime.crossfire.jxclient.map.AnimationState.mapListener

private

The CfAnimationsMapListener to notify of changes.

Definition at line 53 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.allocate(), com.realtime.crossfire.jxclient.map.AnimationState.AnimationState(), and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

◆ speed

int com.realtime.crossfire.jxclient.map.AnimationState.speed = 1

private

The animation speed.

Definition at line 70 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.setSpeed(), com.realtime.crossfire.jxclient.map.AnimationState.updateFace(), and com.realtime.crossfire.jxclient.map.AnimationState.updateTickNo().

◆ tags

final Collection<Integer> com.realtime.crossfire.jxclient.map.AnimationState.tags = new HashSet<>()

private

All item tags this animation is displayed at.

Definition at line 98 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.allocate(), com.realtime.crossfire.jxclient.map.AnimationState.free(), and com.realtime.crossfire.jxclient.map.AnimationState.updateFace().

◆ tickNo

int com.realtime.crossfire.jxclient.map.AnimationState.tickNo

private

The face was updated last in this tick number.

Definition at line 75 of file AnimationState.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationState.setTickNo(), and com.realtime.crossfire.jxclient.map.AnimationState.updateTickNo().

The documentation for this class was generated from the following file:

src/network/src/main/java/com/realtime/crossfire/jxclient/map/AnimationState.java

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AnimationState()

Member Function Documentation

◆ allocate() [1/2]

◆ allocate() [2/2]

◆ free() [1/2]

◆ free() [2/2]

◆ freeAllLocations()

◆ iterator()

◆ scroll()

◆ setSpeed()

◆ setTickNo()

◆ updateFace()

◆ updateTickNo()

Member Data Documentation

◆ animation

◆ facesManager

◆ index

◆ itemSet

◆ lastFace

◆ locations

◆ mapListener

◆ speed

◆ tags

◆ tickNo