net.risingworld.api.utils

Interface CustomImage

public interface CustomImage

Represents a custom image (i.e. "Poster") which was uploaded by a client.

Method Summary

Modifier and Type	Method and Description
long	getCreationDate()
byte[]	getData() Gets the image PNG data as a byte array.
int	getID() Gets the image id.
java.lang.String	getName() Gets the image name.
int	getOriginalHeight()
int	getOriginalWidth()
int	getPlayerDbID() Gets the database id of the player who uploaded the image.
long	getPlayerUID() Gets the UID of the player who uploaded this image.
boolean	isReady() Gets whether or not the image is "ready", i.e. if it has been fully uploaded to the server.

Method Detail

getID

int getID()

Gets the image id.

Returns:

the unique image id.

getName

java.lang.String getName()

Gets the image name.

Returns:

the original name of the image file.

getData

byte[] getData()

Gets the image PNG data as a byte array. If the image isn't fully uploaded to the server yet, this function returns null.

Returns:

the image data, or null if the client is still uploading the image to the server.

See Also:

Utils.ImageUtils.byteArrayToBufferedImage(byte[])

isReady

boolean isReady()

Gets whether or not the image is "ready", i.e. if it has been fully uploaded to the server. If the image is not ready, you cannot access the image data yet.

Returns:

true if the image is ready (fully uploaded), or false if the client is currently still uploading the image.

getPlayerUID

long getPlayerUID()

Gets the UID of the player who uploaded this image.

Returns:

the player UID.

getPlayerDbID

int getPlayerDbID()

Gets the database id of the player who uploaded the image.

Returns:

the player database id.

getCreationDate

long getCreationDate()

getOriginalWidth

int getOriginalWidth()

getOriginalHeight

int getOriginalHeight()