Package io.github.thebusybiscuit.slimefun4.api.gps

Class Waypoint

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.gps.Waypoint

public class Waypoint
extends Object

A Waypoint represents a named Location that was created by a Player. It can be used via a Teleporter.

Author:

TheBusyBiscuit

See Also:

• WaypointCreateEvent
• GPSNetwork
• TeleportationManager
• Teleporter

Constructor Summary

Constructors

Constructor	Description
Waypoint(PlayerProfile profile, String id, Location loc, String name)	Deprecated. Use Waypoint(UUID, String, Location, String) instead
Waypoint(UUID ownerId, String id, Location loc, String name)	This constructs a new Waypoint object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ItemStack	getIcon()	This method returns the ItemStack icon for this Waypoint.
String	getId()	This method returns the unique identifier for this Waypoint.
Location	getLocation()	This returns the Location of this Waypoint
String	getName()	This returns the name of this Waypoint.
PlayerProfile	getOwner()	Deprecated. Use getOwnerId() instead
UUID	getOwnerId()	This returns the owner's UUID of the Waypoint.
int	hashCode()
boolean	isDeathpoint()	This method returns whether this Waypoint is a Deathpoint.

Methods inherited from class java.lang.Object

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

Constructor Details

Waypoint

@Deprecated
@ParametersAreNonnullByDefault
public Waypoint(PlayerProfile profile,
 String id,
 Location loc,
 String name)

Deprecated.

Use Waypoint(UUID, String, Location, String) instead

This constructs a new Waypoint object.

Parameters:

profile - The owning PlayerProfile

id - The unique id for this Waypoint

loc - The Location of the Waypoint

name - The name of this Waypoint

Waypoint

@ParametersAreNonnullByDefault
public Waypoint(UUID ownerId,
 String id,
 Location loc,
 String name)

This constructs a new Waypoint object.

Parameters:

ownerId - The owning Player's UUID

id - The unique id for this Waypoint

loc - The Location of the Waypoint

name - The name of this Waypoint

Method Details

getOwnerId

@Nonnull
public UUID getOwnerId()

This returns the owner's UUID of the Waypoint.

Returns:

The corresponding owner's UUID

getOwner

@Nonnull
@Deprecated
public PlayerProfile getOwner()

Deprecated.

Use getOwnerId() instead

This returns the owner of the Waypoint.

Returns:

The corresponding PlayerProfile

getId

@Nonnull
public String getId()

This method returns the unique identifier for this Waypoint.

Returns:

The Waypoint id

getName

@Nonnull
public String getName()

This returns the name of this Waypoint.

Returns:

The name of this Waypoint

getLocation

@Nonnull
public Location getLocation()

This returns the Location of this Waypoint

Returns:

The Waypoint Location

isDeathpoint

public boolean isDeathpoint()

This method returns whether this Waypoint is a Deathpoint.

Returns:

Whether this is a Deathpoint

getIcon

@Nonnull
public ItemStack getIcon()

This method returns the ItemStack icon for this Waypoint. The icon is dependent on the World.Environment the Waypoint is in and whether it is a Deathpoint.

Returns:

The ItemStack icon for this Waypoint

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object