net.risingworld.api.events.general

Class AddAdminEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.general.AddAdminEvent

All Implemented Interfaces:

Cancellable

public final class AddAdminEvent
extends Event
implements Cancellable

Called when a player is added to the admin list.

Constructor Summary

Constructors

Constructor and Description
AddAdminEvent(java.lang.String playername, long playerUID)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPlayerName() Gets the name of the player who was added to the admin list.
long	getPlayerUID() Get the unique ID of the player who was added to the admin list.
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

AddAdminEvent

public AddAdminEvent(java.lang.String playername,
                     long playerUID)

Method Detail

getPlayerUID

public long getPlayerUID()

Get the unique ID of the player who was added to the admin list. This player isn't necessarily connected to the server.

Returns:

the global unique ID of the player who was added to the admin list.

getPlayerName

public java.lang.String getPlayerName()

Gets the name of the player who was added to the admin list. If the player is currently not connected to the server, this returns null (in this case, you can only rely on the playerUID).

Returns:

the name of the player who was added to the admin list, or null if this player isn't online at the moment.

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.