net.risingworld.api.events.player

Class PlayerCustomImageUploadRequestEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerCustomImageUploadRequestEvent

All Implemented Interfaces:

Cancellable

public final class PlayerCustomImageUploadRequestEvent
extends PlayerEvent
implements Cancellable

Called when a player wants to upload a custom image (poster). If the upload is granted (i.e. the event was not cancelled), and the upload is completed (i.e. the image is fully uploaded to the server), the PlayerCustomImageUploadEvent event will be called.

See Also:

PlayerCustomImageUploadEvent

Constructor Summary

Constructors

Constructor and Description
PlayerCustomImageUploadRequestEvent(Player player, int id, java.lang.String imageName, int width, int height, int dimension)

Method Summary

Modifier and Type	Method and Description
int	getImageID() Gets the target image id.
java.lang.String	getImageName() Gets the image name.
int	getOriginalHeight() Gets the original image height.
int	getOriginalWidth() Gets the original image width.
int	getTargetDimension() Gets the target image dimension, depending on the player permission.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setImageName(java.lang.String name)
void	setTargetDimension(int dimension) Sets the target image dimension.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerCustomImageUploadRequestEvent

public PlayerCustomImageUploadRequestEvent(Player player,
                                           int id,
                                           java.lang.String imageName,
                                           int width,
                                           int height,
                                           int dimension)

Method Detail

getImageID

public int getImageID()

Gets the target image id. Note that the image isn't uploaded to the server yet at this stage, so the id is basically just "reserved" for the image.
If you want to access the image, you have to listen for the PlayerCustomImageUploadEvent event.

Returns:

the future image id.

getImageName

public java.lang.String getImageName()

Gets the image name.

Returns:

the image name.

setImageName

public void setImageName(java.lang.String name)

getOriginalWidth

public int getOriginalWidth()

Gets the original image width.

Returns:

the original image width (x)

getOriginalHeight

public int getOriginalHeight()

Gets the original image height.

Returns:

the image height (y)

getTargetDimension

public int getTargetDimension()

Gets the target image dimension, depending on the player permission. For example, if it is set to 512, the image width or height will never exceed this value.

Returns:

the target image dimension.

setTargetDimension

public void setTargetDimension(int dimension)

Sets the target image dimension. If the image size exceeds this value, the image will be resized.

Parameters:

dimension - the new target dimension.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.