Crossfire JXClient, Trunk
Public Member Functions | Static Private Member Functions | Private Attributes | List of all members
com.realtime.crossfire.jxclient.map.AnimationMap Class Reference
Collaboration diagram for com.realtime.crossfire.jxclient.map.AnimationMap:
Collaboration graph

Public Member Functions

void add (@NotNull final Location location, @NotNull final AnimationState animationState)
 
void clear ()
 
void remove (@NotNull final Location location)
 
void scroll (final int dx, final int dy, final int width, final int height)
 
void updateSpeed (@NotNull final Location location, final int speed)
 

Static Private Member Functions

static void freeAnimationState (@Nullable final AnimationState animationState, @NotNull final Location location)
 

Private Attributes

final Map< Location, AnimationStateanimations = new HashMap<>()
 

Detailed Description

Maintains AnimationState instances for map locations.

Author
Andreas Kirschbaum

Definition at line 36 of file AnimationMap.java.

Member Function Documentation

◆ add()

void com.realtime.crossfire.jxclient.map.AnimationMap.add ( @NotNull final Location  location,
@NotNull final AnimationState  animationState 
)

Adds a new AnimationState to a Location. If the location was not empty, the previous animation state is freed.

Parameters
locationthe location to add to
animationStatethe animation state to add

Definition at line 58 of file AnimationMap.java.

References com.realtime.crossfire.jxclient.map.AnimationMap.animations, and com.realtime.crossfire.jxclient.map.AnimationMap.freeAnimationState().

Referenced by com.realtime.crossfire.jxclient.map.CfAnimations.mapAdd().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clear()

void com.realtime.crossfire.jxclient.map.AnimationMap.clear ( )

Forgets all state.

Definition at line 48 of file AnimationMap.java.

References com.realtime.crossfire.jxclient.map.AnimationMap.animations.

Referenced by com.realtime.crossfire.jxclient.map.CfAnimations.mapClear().

Here is the caller graph for this function:

◆ freeAnimationState()

static void com.realtime.crossfire.jxclient.map.AnimationMap.freeAnimationState ( @Nullable final AnimationState  animationState,
@NotNull final Location  location 
)
staticprivate

Calls AnimationState#free(Location).

Parameters
animationStatethe instance to call
free()
on or
null
to do nothing
locationthe location to pass

Definition at line 110 of file AnimationMap.java.

Referenced by com.realtime.crossfire.jxclient.map.AnimationMap.add(), and com.realtime.crossfire.jxclient.map.AnimationMap.remove().

Here is the caller graph for this function:

◆ remove()

void com.realtime.crossfire.jxclient.map.AnimationMap.remove ( @NotNull final Location  location)

Clears a Location.

Parameters
locationthe location to clear

Definition at line 67 of file AnimationMap.java.

References com.realtime.crossfire.jxclient.map.AnimationMap.animations, and com.realtime.crossfire.jxclient.map.AnimationMap.freeAnimationState().

Referenced by com.realtime.crossfire.jxclient.map.CfAnimations.mapRemove().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scroll()

void com.realtime.crossfire.jxclient.map.AnimationMap.scroll ( final int  dx,
final int  dy,
final int  width,
final int  height 
)

Scrolls all locations.

Parameters
dxthe x distance to scroll
dythe y distance to scroll
widththe map width
heightthe map height

Definition at line 93 of file AnimationMap.java.

References com.realtime.crossfire.jxclient.map.AnimationMap.animations.

Referenced by com.realtime.crossfire.jxclient.map.CfAnimations.mapScroll().

Here is the caller graph for this function:

◆ updateSpeed()

void com.realtime.crossfire.jxclient.map.AnimationMap.updateSpeed ( @NotNull final Location  location,
final int  speed 
)

Updates the animation speed value of a Location.

Parameters
locationthe location to update
speedthe new animation speed

Definition at line 76 of file AnimationMap.java.

References com.realtime.crossfire.jxclient.map.AnimationMap.animations, and com.realtime.crossfire.jxclient.map.AnimationState.setSpeed().

Referenced by com.realtime.crossfire.jxclient.map.CfAnimations.mapUpdateSpeed().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ animations

final Map<Location, AnimationState> com.realtime.crossfire.jxclient.map.AnimationMap.animations = new HashMap<>()
private

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