net.risingworld.api.utils

Class ImageInformation

java.lang.Object

net.risingworld.api.utils.ImageInformation

Direct Known Subclasses:

GameImageInformation

public class ImageInformation
extends java.lang.Object

Represents an image / texture file.
It's highly recommended to create an ImageInformation object only once and reuse it every time you need it. It's safe to use the same ImageInformation reference for several players and in multiple threads.

Supported file formats: dds, jpg, jpeg, png, gif, tga

Constructor Summary

Constructors

Constructor and Description
ImageInformation(byte[] bytes)
ImageInformation(java.io.File file) Creates a new image information object and loads an image / texture from a file.
ImageInformation(Plugin plugin, java.lang.String resource) Creates a new image information object and loads an image / texture from the plugin jar file.
ImageInformation(java.lang.String filepath) Creates a new image information object and loads an image / texture from a file.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getChecksum() Gets the MD5 checksum of this file.
byte[]	getData() Gets the byte data of the file.
java.lang.String	getExtension() Gets the file extension.
java.lang.String	getFilename() Gets the filename.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageInformation

public ImageInformation(Plugin plugin,
                        java.lang.String resource)

Creates a new image information object and loads an image / texture from the plugin jar file.

Parameters:

plugin - a reference to the plugin. This is required to make sure the game loads the resource from the correct plugin jar.

resource - the path to the resource (inside the jar file).

Example: Load image "Banner.jpg" from jar file (in package rw.plugin.images)

1	// if ImageInformation is created in "Plugin" class
2	ImageInformation info = new ImageInformation(this, "/rw/plugin/images/Banner.jpg");
3	// do something with the image info

ImageInformation

public ImageInformation(java.lang.String filepath)

Creates a new image information object and loads an image / texture from a file.

Parameters:

filepath - the path to the image file on the harddrive.

See Also:

ImageInformation(java.io.File)

Example: Load image "Banner.jpg" from "assets" subfolder in plugin directory

1	ImageInformation info = new ImageInformation(getPath() + "/assets/Banner.jpg");
2	// do something with the image info

ImageInformation

public ImageInformation(java.io.File file)

Creates a new image information object and loads an image / texture from a file.

Parameters:

file - the file representing the path to the image on the harddrive.

See Also:

ImageInformation(java.lang.String)

ImageInformation

public ImageInformation(byte[] bytes)

Method Detail

getData

public byte[] getData()

Gets the byte data of the file.

Returns:

a byte array representing the file, or null if no data is set.

getFilename

public java.lang.String getFilename()

Gets the filename.

Returns:

the filename.

getExtension

public java.lang.String getExtension()

Gets the file extension.

Returns:

the file extension.

getChecksum

public java.lang.String getChecksum()

Gets the MD5 checksum of this file.

Returns:

the MD5 checksum, as a String.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object