com.realtime.crossfire.jxclient.map

Class MapUpdaterState

java.lang.Object

com.realtime.crossfire.jxclient.map.MapUpdaterState

All Implemented Interfaces:

com.realtime.crossfire.jxclient.faces.FacesManagerListener, CrossfireTickListener, CrossfireUpdateMapListener, java.util.EventListener

public class MapUpdaterState
extends java.lang.Object
implements CrossfireTickListener, CrossfireUpdateMapListener, com.realtime.crossfire.jxclient.faces.FacesManagerListener

Update a CfMap model from protocol commands.

The map updater is called from two threads: the ClientSocket reading commands received from the Crossfire server, and FileCacheFaceQueue reading faces from the (file) cache. Synchronization is by sync and applies to the whole map model map.

Constructor Summary

Constructors

Constructor and Description
MapUpdaterState(@NotNull com.realtime.crossfire.jxclient.faces.FacesManager facesManager, @NotNull com.realtime.crossfire.jxclient.animations.Animations animations, @NotNull CfAnimations cfAnimations) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addCrossfireMapListener(@NotNull com.realtime.crossfire.jxclient.map.MapListener listener) Adds a listener to notify about changed map squares.
void	addCrossfireMapScrollListener(@NotNull com.realtime.crossfire.jxclient.map.MapScrollListener listener) Adds a listener to notify about scrolled maps.
void	addCrossfireNewmapListener(@NotNull com.realtime.crossfire.jxclient.map.NewmapListener listener) Adds a listener to notify about cleared maps.
void	addMapSizeListener(@NotNull com.realtime.crossfire.jxclient.map.MapSizeListener listener) Adds a listener to be notified about map size changes.
void	faceUpdated(@NotNull com.realtime.crossfire.jxclient.faces.Face face)
@NotNull com.realtime.crossfire.jxclient.map.CfMap	getMap() Returns the current map instance.
int	getMapHeight() Returns the height of the visible map area.
int	getMapWidth() Returns the width of the visible map area.
void	magicMap(int x, int y, byte[][] data) Part of "magicmap" parsing: set the magic map color.
void	mapAnimation(@NotNull com.realtime.crossfire.jxclient.map.Location location, int animationNum, int animationType) Part of "map2" parsing: set the animation of a cell.
void	mapAnimationSpeed(@NotNull com.realtime.crossfire.jxclient.map.Location location, int animationSpeed) Part of "map2" parsing: set the animation speed.
@NotNull java.lang.Object	mapBegin() Parsing of a "map2" command has been started.
void	mapClear(int x, int y) Part of "map2" parsing: clear a cell.
void	mapDarkness(int x, int y, int darkness) Part of "map2" parsing: change the darkness of a cell.
void	mapEnd() Parsing of "map2" has been finished.
void	mapEnd(boolean alwaysProcess) Finishes processing of a set of map square changes.
void	mapFace(@NotNull com.realtime.crossfire.jxclient.map.Location location, int faceNum) Part of "map2" parsing: set the face of a cell.
void	mapFace(@NotNull com.realtime.crossfire.jxclient.map.Location location, int faceNum, boolean clearAnimation) Updates a map square by changing a face.
void	mapScroll(int dx, int dy) Part of "map2" parsing: scroll the map view.
void	mapSmooth(@NotNull com.realtime.crossfire.jxclient.map.Location location, int smooth) Part of "map2" parsing: set the smooth level.
void	newMap(int mapWidth, int mapHeight) A "newmap" command has been received.
void	removeCrossfireMapListener(@NotNull com.realtime.crossfire.jxclient.map.MapListener listener) Removes a listener to notify about changed map squares.
void	removeCrossfireMapScrollListener(@NotNull com.realtime.crossfire.jxclient.map.MapScrollListener listener) Removes a listener to notify about scrolled maps.
void	removeCrossfireNewmapListener(@NotNull com.realtime.crossfire.jxclient.map.NewmapListener listener) Removes a listener to notify about cleared maps.
void	removeMapSizeListener(@NotNull com.realtime.crossfire.jxclient.map.MapSizeListener listener) Removes a listener to be notified about map size changes.
void	reset() Resets the animation state.
void	tick(int tickNo) A "tick" command has been received.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapUpdaterState

public MapUpdaterState(@NotNull
                       @NotNull com.realtime.crossfire.jxclient.faces.FacesManager facesManager,
                       @NotNull
                       @NotNull com.realtime.crossfire.jxclient.animations.Animations animations,
                       @NotNull
                       @NotNull CfAnimations cfAnimations)

Creates a new instance.

Parameters:

facesManager - the faces manager to track for updated faces

animations - the known animations

cfAnimations - the animations manager to use

Method Detail

addCrossfireMapListener

public void addCrossfireMapListener(@NotNull
                                    @NotNull com.realtime.crossfire.jxclient.map.MapListener listener)

Adds a listener to notify about changed map squares.

Parameters:

listener - the listener to add

removeCrossfireMapListener

public void removeCrossfireMapListener(@NotNull
                                       @NotNull com.realtime.crossfire.jxclient.map.MapListener listener)

Removes a listener to notify about changed map squares.

Parameters:

listener - the listener to remove

addCrossfireNewmapListener

public void addCrossfireNewmapListener(@NotNull
                                       @NotNull com.realtime.crossfire.jxclient.map.NewmapListener listener)

Adds a listener to notify about cleared maps.

Parameters:

listener - the listener to add

removeCrossfireNewmapListener

public void removeCrossfireNewmapListener(@NotNull
                                          @NotNull com.realtime.crossfire.jxclient.map.NewmapListener listener)

Removes a listener to notify about cleared maps.

Parameters:

listener - the listener to remove

addCrossfireMapScrollListener

public void addCrossfireMapScrollListener(@NotNull
                                          @NotNull com.realtime.crossfire.jxclient.map.MapScrollListener listener)

Adds a listener to notify about scrolled maps.

Parameters:

listener - the listener to add

removeCrossfireMapScrollListener

public void removeCrossfireMapScrollListener(@NotNull
                                             @NotNull com.realtime.crossfire.jxclient.map.MapScrollListener listener)

Removes a listener to notify about scrolled maps.

Parameters:

listener - the listener to remove

addMapSizeListener

public void addMapSizeListener(@NotNull
                               @NotNull com.realtime.crossfire.jxclient.map.MapSizeListener listener)

Adds a listener to be notified about map size changes.

Parameters:

listener - the listener to add

removeMapSizeListener

public void removeMapSizeListener(@NotNull
                                  @NotNull com.realtime.crossfire.jxclient.map.MapSizeListener listener)

Removes a listener to be notified about map size changes.

Parameters:

listener - the listener to remove

reset

public void reset()

Resets the animation state.

mapBegin

@NotNull
public @NotNull java.lang.Object mapBegin()

Description copied from interface: CrossfireUpdateMapListener

Parsing of a "map2" command has been started.

Specified by:

mapBegin in interface CrossfireUpdateMapListener

Returns:

the synchronization object which must be synchronized while calling any other function (except newMap())

mapClear

public void mapClear(int x,
                     int y)

Description copied from interface: CrossfireUpdateMapListener

Part of "map2" parsing: clear a cell.

Specified by:

mapClear in interface CrossfireUpdateMapListener

Parameters:

x - the x-coordinate

y - the y-coordinate

mapFace

public void mapFace(@NotNull
                    @NotNull com.realtime.crossfire.jxclient.map.Location location,
                    int faceNum)

Description copied from interface: CrossfireUpdateMapListener

Part of "map2" parsing: set the face of a cell.

Specified by:

mapFace in interface CrossfireUpdateMapListener

Parameters:

location - the location

faceNum - the face ID

mapFace

public void mapFace(@NotNull
                    @NotNull com.realtime.crossfire.jxclient.map.Location location,
                    int faceNum,
                    boolean clearAnimation)

Updates a map square by changing a face.

Parameters:

location - the location to update

faceNum - the face to set; 0 clears the square

clearAnimation - whether an animation should be cleared

mapAnimation

public void mapAnimation(@NotNull
                         @NotNull com.realtime.crossfire.jxclient.map.Location location,
                         int animationNum,
                         int animationType)

Description copied from interface: CrossfireUpdateMapListener

Part of "map2" parsing: set the animation of a cell.

Specified by:

mapAnimation in interface CrossfireUpdateMapListener

Parameters:

location - the location

animationNum - the animation ID

animationType - the animation type

mapAnimationSpeed

public void mapAnimationSpeed(@NotNull
                              @NotNull com.realtime.crossfire.jxclient.map.Location location,
                              int animationSpeed)

Description copied from interface: CrossfireUpdateMapListener

Part of "map2" parsing: set the animation speed.

Specified by:

mapAnimationSpeed in interface CrossfireUpdateMapListener

Parameters:

location - the location

animationSpeed - the animation speed

mapSmooth

public void mapSmooth(@NotNull
                      @NotNull com.realtime.crossfire.jxclient.map.Location location,
                      int smooth)

Description copied from interface: CrossfireUpdateMapListener

Part of "map2" parsing: set the smooth level.

Specified by:

mapSmooth in interface CrossfireUpdateMapListener

Parameters:

location - the location

smooth - the smooth value

mapDarkness

public void mapDarkness(int x,
                        int y,
                        int darkness)

Description copied from interface: CrossfireUpdateMapListener

Part of "map2" parsing: change the darkness of a cell.

Specified by:

mapDarkness in interface CrossfireUpdateMapListener

Parameters:

x - the x-coordinate

y - the y-coordinate

darkness - the darkness value

magicMap

public void magicMap(int x,
                     int y,
                     byte[][] data)

Description copied from interface: CrossfireUpdateMapListener

Part of "magicmap" parsing: set the magic map color.

Specified by:

magicMap in interface CrossfireUpdateMapListener

Parameters:

x - the x-coordinate

y - the y-coordinate

data - the magic map data (y, x); must not be changed

mapEnd

public void mapEnd()

Description copied from interface: CrossfireUpdateMapListener

Parsing of "map2" has been finished.

Specified by:

mapEnd in interface CrossfireUpdateMapListener

mapEnd

public void mapEnd(boolean alwaysProcess)

Finishes processing of a set of map square changes. Notifies listeners about changes.

Parameters:

alwaysProcess - if set, notify listeners even if no changes are present

mapScroll

public void mapScroll(int dx,
                      int dy)

Description copied from interface: CrossfireUpdateMapListener

Part of "map2" parsing: scroll the map view.

Specified by:

mapScroll in interface CrossfireUpdateMapListener

Parameters:

dx - the x-distance

dy - the y-distance

faceUpdated

public void faceUpdated(@NotNull
                        @NotNull com.realtime.crossfire.jxclient.faces.Face face)

Specified by:

faceUpdated in interface com.realtime.crossfire.jxclient.faces.FacesManagerListener

newMap

public void newMap(int mapWidth,
                   int mapHeight)

Description copied from interface: CrossfireUpdateMapListener

A "newmap" command has been received.

Specified by:

newMap in interface CrossfireUpdateMapListener

Parameters:

mapWidth - the map width

mapHeight - the map height

getMap

@NotNull
public @NotNull com.realtime.crossfire.jxclient.map.CfMap getMap()

Returns the current map instance.

Returns:

the current map instance

getMapWidth

public int getMapWidth()

Returns the width of the visible map area.

Returns:

the width of the visible map area

getMapHeight

public int getMapHeight()

Returns the height of the visible map area.

Returns:

the height of the visible map area

tick

public void tick(int tickNo)

Description copied from interface: CrossfireTickListener

A "tick" command has been received.

Specified by:

tick in interface CrossfireTickListener

Parameters:

tickNo - the current tick