PlayerWarpMenuEvent (PlayerWarps-API 7.4.1 API)

java.lang.Object

org.bukkit.event.Event

com.olziedev.playerwarps.api.events.WarpEvent

com.olziedev.playerwarps.api.events.menu.PlayerWarpMenuEvent

All Implemented Interfaces:: Cancellable

public class PlayerWarpMenuEvent extends WarpEvent

Event that is triggered before a menu is opened.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

PlayerWarpMenuEvent.MenuType

List of all possible menu types.

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

Constructors

Constructor

Description

PlayerWarpMenuEvent(WPlayer player, String title, PlayerWarpMenuEvent.MenuType type)

This event is triggered before a menu is opened.
Method Summary

Modifier and Type

Method

Description

static HandlerList

getHandlerList()

HandlerList

getHandlers()

WPlayer

getPlayer()

String

getTitle()

PlayerWarpMenuEvent.MenuType

getType()

void

setTitle(String title)

Methods inherited from class com.olziedev.playerwarps.api.events.WarpEvent
acceptCallback, callEvent, getPlayerWarpsAPI, isCancelled, isWaitingForCallback, postEvent, postEvent, setCancelled, setEventCallback, waitForCallback

Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PlayerWarpMenuEvent
  
  public PlayerWarpMenuEvent(WPlayer player, String title, PlayerWarpMenuEvent.MenuType type)
  
  This event is triggered before a menu is opened.
  
  Parameters:
  
  player - The player that is opening the menu.
  
  title - The title of the menu.
  
  type - The type of menu that is being opened.
Method Details
- getHandlerList
  
  public static HandlerList getHandlerList()
- getHandlers
  
  @Nonnull public HandlerList getHandlers()
  
  Specified by:
  
  getHandlers in class Event
- getPlayer
  
  public WPlayer getPlayer()
  
  Returns:
  
  The player that is opening the menu.
- getType
  
  public PlayerWarpMenuEvent.MenuType getType()
  
  Returns:
  
  The type of menu that is being opened.
- getTitle
  
  public String getTitle()
  
  Returns:
  
  The title of the menu
- setTitle
  
  public void setTitle(String title)
  
  Parameters:
  
  title - The title of the menu.