net.risingworld.api.events.player

Class PlayerCustomImageDeleteEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerCustomImageDeleteEvent

All Implemented Interfaces:

Cancellable

public final class PlayerCustomImageDeleteEvent
extends PlayerEvent
implements Cancellable

Called when a player wants to delete an image. Cancelling this event prevents the player from deleting this image.

Constructor Summary

Constructors

Constructor and Description
PlayerCustomImageDeleteEvent(Player player, CustomImage image)

Method Summary

Modifier and Type	Method and Description
CustomImage	getImage() Gets the custom image the player wants to delete.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

PlayerCustomImageDeleteEvent

public PlayerCustomImageDeleteEvent(Player player,
                                    CustomImage image)

Method Detail

getImage

public CustomImage getImage()

Gets the custom image the player wants to delete.

Returns:

the custom image the player wants to delete.

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.