Package games.stendhal.client.sprite

Class TilesetGroupAnimationMap

java.lang.Object

games.stendhal.client.sprite.TilesetGroupAnimationMap

public class TilesetGroupAnimationMap
extends Object

A group of tileset animation maps. This might normally be called TilesetsAnimationMap, but is less likely to mix-up with TilesetAnimationMap.

Constructor Summary

Constructors

Constructor	Description
TilesetGroupAnimationMap()	Create a map of tileset animation maps.

Method Summary

Modifier and Type	Method	Description
TilesetAnimationMap	get(String name)	Get a named tileset map.
void	load(InputStream in)	Load tileset mappings from a file.

Methods inherited from class java.lang.Object

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

Constructor Details

TilesetGroupAnimationMap

public TilesetGroupAnimationMap()

Create a map of tileset animation maps.

Method Details

get

public TilesetAnimationMap get(String name)

Get a named tileset map.

Parameters:

name - The name of the tileset.

Returns:

An tileset animation map, or null if one does not exists.

load

public void load(InputStream in)
          throws IOException

Load tileset mappings from a file. This doesn't not first clear any existing entries.

The file format consists of one line per entry. Blank lines and those starting with '#' (a comment) are ignored. The line format is as follows:
tileset index frame:frame[:frame]...

Spaces may be any whitespace. The index may also be *, which indicates that an entry should be added using each frame as a mapped index. The mapped index or frame index(s) maybe be appended by @delay, where delay is a value in milliseconds of for the duration of the frame (or the default for all frames, if specified for mapped index).

Parameters:

in - The input stream.

Throws:

IOException - If an I/O error occurred.