de.gurkenlabs.litiengine.resources

Class Spritesheets

java.lang.Object

de.gurkenlabs.litiengine.resources.ResourcesContainer<Spritesheet>

de.gurkenlabs.litiengine.resources.Spritesheets

public final class Spritesheets
extends ResourcesContainer<Spritesheet>

Method Summary

Modifier and Type	Method and Description
Spritesheet	get(java.lang.String path) Finds Spritesheets that were previously loaded by any load method or by the sprites.info file.
Spritesheet	get(java.lang.String resourceName, boolean forceLoad) Gets the resource with the specified name.
int[]	getCustomKeyFrameDurations(Spritesheet sprite)
int[]	getCustomKeyFrameDurations(java.lang.String name)
Spritesheet	load(java.awt.image.BufferedImage image, java.lang.String path, int spriteWidth, int spriteHeight)
Spritesheet	load(ITileset tileset)
Spritesheet	load(SpritesheetInfo info)
protected Spritesheet	load(java.lang.String resourceName)
Spritesheet	load(java.lang.String path, int spriteWidth, int spriteHeight)
java.util.List<Spritesheet>	loadFrom(java.lang.String spriteInfoFile) The sprite info file must be located under the GameInfo#getSpritesDirectory() directory.
Spritesheet	remove(java.lang.String path) Removes the resource with the specified name from this container.
void	update(SpritesheetInfo info)

Methods inherited from class de.gurkenlabs.litiengine.resources.ResourcesContainer

add, addClearedListener, addContainerListener, clear, contains, contains, count, get, get, getAlias, getAll, getResources, removeClearedListener, removeContainerListener, tryGet

Methods inherited from class java.lang.Object

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

Method Detail

get

public Spritesheet get(java.lang.String path)

Finds Spritesheets that were previously loaded by any load method or by the sprites.info file.

Overrides:

get in class ResourcesContainer<Spritesheet>

Parameters:

path - The path of the spritesheet.

Returns:

The Spritesheet assotiated with the path or null if not loaded yet

get

public Spritesheet get(java.lang.String resourceName,
                       boolean forceLoad)

Description copied from class: ResourcesContainer

Gets the resource with the specified name.

If not previously loaded, this method attempts to load the resource on the fly otherwise it will be retrieved from the cache.

Overrides:

get in class ResourcesContainer<Spritesheet>

Parameters:

resourceName - The name of the game resource.

forceLoad - If set to true, cached resource (if existing) will be discarded and the resource will be freshly loaded.

Returns:

The game resource or null if not found.

getCustomKeyFrameDurations

public int[] getCustomKeyFrameDurations(java.lang.String name)

getCustomKeyFrameDurations

public int[] getCustomKeyFrameDurations(Spritesheet sprite)

load

public Spritesheet load(java.awt.image.BufferedImage image,
                        java.lang.String path,
                        int spriteWidth,
                        int spriteHeight)

load

public Spritesheet load(ITileset tileset)

load

public Spritesheet load(SpritesheetInfo info)

loadFrom

public java.util.List<Spritesheet> loadFrom(java.lang.String spriteInfoFile)

The sprite info file must be located under the GameInfo#getSpritesDirectory() directory.

Parameters:

spriteInfoFile - The path to the sprite info file.

Returns:

A list of spritesheets that were loaded from the info file.

load

public Spritesheet load(java.lang.String path,
                        int spriteWidth,
                        int spriteHeight)

remove

public Spritesheet remove(java.lang.String path)

Description copied from class: ResourcesContainer

Removes the resource with the specified name from this container.

Overrides:

remove in class ResourcesContainer<Spritesheet>

Parameters:

path - The name of the resource that should be removed.

Returns:

The removed resource.

update

public void update(SpritesheetInfo info)

load

protected Spritesheet load(java.lang.String resourceName)

Specified by:

load in class ResourcesContainer<Spritesheet>