Package org.bukkit.event.player

Class PlayerSpawnChangeEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerSpawnChangeEvent
All Implemented Interfaces:
Cancellable
@Experimental public class PlayerSpawnChangeEvent extends PlayerEvent implements Cancellable
This event is fired when the spawn point of the player is changed.
API Note:
draft API

  • Constructor Details

  • Method Details

    • getCause

      @NotNull public PlayerSpawnChangeEvent.Cause getCause()
      Gets the cause of spawn change.
      Returns:
      change cause

    • isForced

      public boolean isForced()
      Gets if the spawn position will be used regardless of bed obstruction rules.
      Returns:
      true if is forced

    • setForced

      public void setForced(boolean forced)
      Sets if the spawn position will be used regardless of bed obstruction rules.
      Parameters:
      forced - true if forced

    • getNewSpawn

      @Nullable public Location getNewSpawn()
      Gets the new spawn to be set.
      Returns:
      new spawn location

    • setNewSpawn

      public void setNewSpawn(@Nullable Location newSpawn)
      Sets the new spawn location.
      Parameters:
      newSpawn - new spawn location, with non-null world

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if this event is cancelled

    • setCancelled

      public void setCancelled(boolean cancel)
      Description copied from interface: Cancellable
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event

    • getHandlers

      @NotNull public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event

    • getHandlerList

      @NotNull public static HandlerList getHandlerList()