net.risingworld.api.events.player

Class PlayerPermissionGroupChangeEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerPermissionGroupChangeEvent

All Implemented Interfaces:

Cancellable

public class PlayerPermissionGroupChangeEvent
extends PlayerEvent
implements Cancellable

Called when the permission group of a player changes.

Constructor Summary

Constructors

Constructor and Description
PlayerPermissionGroupChangeEvent(Player player, java.lang.String oldGroup, java.lang.String newGroup)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNewPermissionGroup() Gets the name of the new permission group (the player will be assigned to).
java.lang.String	getPreviousPermissionGroup() Gets the old permission group of the player.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setNewPermissionGroup(java.lang.String group) Changes the target permission group for the player.

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

PlayerPermissionGroupChangeEvent

public PlayerPermissionGroupChangeEvent(Player player,
                                        java.lang.String oldGroup,
                                        java.lang.String newGroup)

Method Detail

getNewPermissionGroup

public java.lang.String getNewPermissionGroup()

Gets the name of the new permission group (the player will be assigned to).

Returns:

the name of the new permission group, or an empty string if the player will be removed from all groups (in this case, only the "default.permissions" applies to the player).

getPreviousPermissionGroup

public java.lang.String getPreviousPermissionGroup()

Gets the old permission group of the player. Returns an empty string if the player didn't had a group before (in this case, the player is only affected by the "default.permissions" file).

Returns:

the name of the previous permission group, or null if there was no group

setNewPermissionGroup

public void setNewPermissionGroup(java.lang.String group)

Changes the target permission group for the player. Set to "" if you want to remove the player from all groups (then he will only be affected by the "default.permissions" file).

Parameters:

group - the new group name.

Example: If player gets removed from his group, automatically assign him to a "guests" group

1	@EventMethod
2	public void onPlayerPermissionGroupChange(PlayerPermissionGroupChangeEvent evt){
3	//get the player object
4	Player player = evt.getPlayer();
5
6	//check if new group is empty (""), i.e. default/null group
7	if(evt.getNewPermissionGroup().isEmpty()){
8	//set new permission group, make sure there is a "guest.permissions" file in the groups folder
9	evt.setNewPermissionGroup("guest");
10	}
11	}

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.