Class FlickWaypoint

java.lang.Object

net.flick.serverapi.FlickWaypoint

public final class FlickWaypoint
extends Object

A server-defined waypoint shown by Flick Client (beam, icon, name and distance). Waypoints exist only for the current connection; adding a waypoint with an existing id replaces it.

FlickWaypoint wp = FlickWaypoint.builder("ctf_red_flag")
        .name("Red flag")
        .location(flagLocation)
        .color(0xFF5555)
        .icon(WaypointIcon.FLAG)
        .build();
FlickAPI.get().addWaypoint(player, wp);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlickWaypoint.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_NAME

Method Summary

Modifier and Type	Method	Description
boolean	beam()
static FlickWaypoint.Builder	builder(String id)
int	color()	RGB (0xRRGGBB).
String	dimension()
static String	dimensionOf(org.bukkit.World world)	Dimension key for a Bukkit world (minecraft:overworld, minecraft:the_nether, ...).
long	durationMs()	Client-side expiry in ms after it is received (0 = until removed / disconnect).
WaypointIcon	icon()
String	id()
String	name()
boolean	temporary()	Removed by the client once the player is within 4 blocks.
double	x()
double	y()
double	z()

Methods inherited from class Object

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

Field Details

MAX_NAME

public static final int MAX_NAME

See Also:

• Constant Field Values

Method Details

builder

public static FlickWaypoint.Builder builder(String id)

id

public String id()

name

public String name()

dimension

public String dimension()

x

public double x()

y

public double y()

z

public double z()

color

public int color()

RGB (0xRRGGBB).

icon

public WaypointIcon icon()

beam

public boolean beam()

temporary

public boolean temporary()

Removed by the client once the player is within 4 blocks.

durationMs

public long durationMs()

Client-side expiry in ms after it is received (0 = until removed / disconnect).

dimensionOf

public static String dimensionOf(org.bukkit.World world)

Dimension key for a Bukkit world (minecraft:overworld, minecraft:the_nether, ...).