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 @Deprecated(forRemoval=true) public class PlayerSpawnChangeEvent extends PlayerEvent implements Cancellable
Deprecated, for removal: This API element is subject to removal in a future version.
use PlayerSetSpawnEvent
This event is fired when the spawn point of the player is changed.
API Note:
draft API

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    PlayerSpawnChangeEvent.Cause
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    Event.Result

  • Field Summary

    Fields inherited from class org.bukkit.event.player.PlayerEvent

    player

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerSpawnChangeEvent(@NotNull Player player, @Nullable Location newSpawn, boolean forced, @NotNull PlayerSpawnChangeEvent.Cause cause)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull PlayerSpawnChangeEvent.Cause
    getCause()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the cause of spawn change.
    static @NotNull HandlerList
    getHandlerList()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @NotNull HandlerList
    getHandlers()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @Nullable Location
    getNewSpawn()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the new spawn to be set.
    boolean
    isCancelled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the cancellation state of this event.
    boolean
    isForced()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets if the spawn position will be used regardless of bed obstruction rules.
    void
    setCancelled(boolean cancel)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the cancellation state of this event.
    void
    setForced(boolean forced)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets if the spawn position will be used regardless of bed obstruction rules.
    void
    setNewSpawn(@Nullable Location newSpawn)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the new spawn location.

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    getPlayer

    Methods inherited from class org.bukkit.event.Event

    callEvent, getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getCause

      @NotNull public @NotNull PlayerSpawnChangeEvent.Cause getCause()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the cause of spawn change.
      Returns:
      change cause

    • isForced

      public boolean isForced()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets if the spawn position will be used regardless of bed obstruction rules.
      Returns:
      true if is forced

    • setForced

      public void setForced(boolean forced)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets if the spawn position will be used regardless of bed obstruction rules.
      Parameters:
      forced - true if forced

    • getNewSpawn

      @Nullable public @Nullable Location getNewSpawn()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the new spawn to be set.
      Returns:
      new spawn location

    • setNewSpawn

      public void setNewSpawn(@Nullable @Nullable Location newSpawn)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the new spawn location.
      Parameters:
      newSpawn - new spawn location, with non-null world

    • isCancelled

      public boolean isCancelled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 @NotNull HandlerList getHandlers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getHandlers in class Event

    • getHandlerList

      @NotNull public static @NotNull HandlerList getHandlerList()
      Deprecated, for removal: This API element is subject to removal in a future version.