Package 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 final class PlayerPermissionGroupChangeEvent extends PlayerEvent implements Cancellable
Called when the permission group of a player changes.

  • Method Details

    • getNewPermissionGroup

      public 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 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(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
      2public void onPlayerPermissionGroupChange(PlayerPermissionGroupChangeEvent evt){
      3 //Get the player object
      4 Player player = evt.getPlayer();
      5
      6 //Check if new group is null or empty (""), i.e default/null group
      7 String newPermissionGroup = evt.getNewPermissionGroup();
      8 if (newPermissionGroup == null || newPermissionGroup.isEmpty()) {
      9 //Set new permission group, make sure there is a "guest.permissions" file in the permission "groups" folder
      10 evt.setNewPermissionGroup("guest");
      11 }
      12}

    • 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.

      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - set to true if you want to cancel this event.
      Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
      1//Listener class
      2public class PlayerListener implements Listener{
      3 @EventMethod
      4 public void onEnterArea(PlayerEnterAreaEvent evt){
      5 //Now the player will not be able to enter the area, i.e.
      6 //he will be teleported back to his old position (outside the area)
      7 evt.setCancelled(true);
      8 }
      9}