Package io.github.thebusybiscuit.slimefun4.api.events

Class WaypointCreateEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.github.thebusybiscuit.slimefun4.api.events.WaypointCreateEvent

All Implemented Interfaces:

Cancellable

public class WaypointCreateEvent
extends PlayerEvent
implements Cancellable

A WaypointCreateEvent is called when a Player creates a new waypoint. Either manually or through dying with an emergency transmitter.

Author:

TheBusyBiscuit

See Also:

• GPSNetwork
• TeleportationManager
• Waypoint

Nested Class Summary

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
WaypointCreateEvent(Player player, String name, Location location)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Location	getLocation()	This returns the Location of the waypoint that should be created.
String	getName()	This returns the name of the waypoint.
boolean	isCancelled()
boolean	isDeathpoint()	This method returns whether this waypoint was created by an Emergency Transmitter.
void	setCancelled(boolean cancel)
void	setLocation(Location loc)	This sets the Location of the waypoint.
void	setName(String name)	This sets the name of the waypoint to the given argument.

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

getPlayer

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

WaypointCreateEvent

public WaypointCreateEvent(@Nonnull
 Player player,
 @Nonnull
 String name,
 @Nonnull
 Location location)

Method Details

getLocation

@Nonnull
public Location getLocation()

This returns the Location of the waypoint that should be created.

Returns:

The Location of this waypoint

setLocation

public void setLocation(@Nonnull
 Location loc)

This sets the Location of the waypoint. The Location may never be null!

Parameters:

loc - The Location to set

getName

@Nonnull
public String getName()

This returns the name of the waypoint.

Returns:

The name of this waypoint

setName

public void setName(@Nonnull
 String name)

This sets the name of the waypoint to the given argument.

Parameters:

name - The name for this waypoint

isDeathpoint

public boolean isDeathpoint()

This method returns whether this waypoint was created by an Emergency Transmitter. This should mean that our Player has died.

Returns:

Whether this is a deathpoint

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface Cancellable

getHandlerList

@Nonnull
public static HandlerList getHandlerList()

getHandlers

@Nonnull
public HandlerList getHandlers()

Specified by:

getHandlers in class Event