net.risingworld.api.utils

Class GameImageInformation

java.lang.Object

net.risingworld.api.utils.ImageInformation

net.risingworld.api.utils.GameImageInformation

public class GameImageInformation
extends ImageInformation

Represents a game texture / image, i.e. a texture which already exists in the game by default (e.g. block textures or world textures).
It's highly recommended to create an GameImageInformation object only once and reuse it every time you need it. It's safe to use the same GameImageInformation reference for several players and in multiple threads.

Constructor Summary

Constructors

Constructor and Description
GameImageInformation(java.lang.String type, java.lang.String name) Creates a new game image information object.

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

GameImageInformation

public GameImageInformation(java.lang.String type,
                            java.lang.String name)

Creates a new game image information object. Creates a new image information object and loads an image / texture from the plugin jar file. If the resource was not found, the resource path will be treated as a file path instead and the game tries to load the image / texture from the file.
Note: If you provide a wrong file name, the game uses a fallback texture.

Parameters:

type - the texture type, or more precisely, the folder in the game assets. E.g. for block textures, the type would be "Constructions", for items, it would be "Items", for world textures, it would be "World", for ores, it would be "World/Ores" etc.
You find the structure of the game textures in the "textures.jar" file in your game directory/data/assets (the .jar file can be opened with a zip program).

name - the texture name. For example "woodmodern_material_0.dds" for the modern object wood texture (see texture.jar file in your game assets for all texture names).

Example: Use tree bark texture ("bark_0.dds" in the "Vegetations/Barks" folder)

1	GameImageInformation info = new GameImageInformation("Vegetations/Barks", "bark_0.dds");
2	// do something with the game image info

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