net.risingworld.api.events.general

Class ShutdownEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.general.ShutdownEvent

All Implemented Interfaces:

Cancellable

public final class ShutdownEvent
extends Event
implements Cancellable

Called when the server shuts down. This event does not get triggered when the server process was killed, when the server crashes, or when the "shutdown now" command was used (which kills the server immediately).

Constructor Summary

Constructors

Constructor and Description
ShutdownEvent()

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShutdownEvent

public ShutdownEvent()

Method Detail

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.