Class AddAdminEvent
java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.general.AddAdminEvent
- All Implemented Interfaces:
Cancellable
Called when a player is added to the admin list.
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the name of the player who was added to the admin list.Get the unique ID of the player who was added to the admin list.boolean
Determines if the event is cancelled.void
setCancelled
(boolean cancel) Cancels this event.
-
Method Details
-
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
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 interfaceCancellable
- 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.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
- set to true if you want to cancel this event.- Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
-