io.github.bananapuncher714.cartographer.core.api

Class WorldCursor

java.lang.Object

io.github.bananapuncher714.cartographer.core.api.WorldCursor

public class WorldCursor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	global
protected org.bukkit.Location	location
protected java.lang.String	name
protected org.bukkit.map.MapCursor.Type	type

Constructor Summary

Constructors

Constructor and Description
WorldCursor(org.bukkit.Location location) Construct a WorldCursor with the arguments provided.
WorldCursor(org.bukkit.Location location, org.bukkit.map.MapCursor.Type type) Construct a WorldCursor with the arguments provided.
WorldCursor(java.lang.String name, org.bukkit.Location location, org.bukkit.map.MapCursor.Type type) Construct a WorldCursor with the arguments provided.
WorldCursor(java.lang.String name, org.bukkit.Location l, org.bukkit.map.MapCursor.Type type, boolean global) Constructor for a RealWorldCursor.

Method Summary

Modifier and Type	Method and Description
org.bukkit.Location	getLocation() Get the location.
java.lang.String	getName() Get the name.
org.bukkit.map.MapCursor.Type	getType() Get the MapCursor type of the cursor.
boolean	isGlobal() Get if the cursor is global.
void	setGlobal(boolean hide) Set if the cursor is global.
void	setName(java.lang.String name) Set the name.
void	setType(org.bukkit.map.MapCursor.Type type) Set the MapCursor type of the cursor.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

location

protected final org.bukkit.Location location

type

protected org.bukkit.map.MapCursor.Type type

global

protected boolean global

Constructor Detail

WorldCursor

public WorldCursor(java.lang.String name,
                   org.bukkit.Location l,
                   org.bukkit.map.MapCursor.Type type,
                   boolean global)

Constructor for a RealWorldCursor.

Parameters:

l - The current location of whatever the cursor is tracking. Cannot be null.

type - The MapCursor type that will represent this RealWorldCursor. Cannot be null.

global - Whether or not to show this cursor if it is off-map.

WorldCursor

public WorldCursor(org.bukkit.Location location)

Construct a WorldCursor with the arguments provided.

Parameters:

location - The current location of whatever the cursor is tracking. Cannot be null.

WorldCursor

public WorldCursor(org.bukkit.Location location,
                   org.bukkit.map.MapCursor.Type type)

Construct a WorldCursor with the arguments provided.

Parameters:

location - The current location of whatever the cursor is tracking. Cannot be null.

type - The MapCursor type that will represent this RealWorldCursor. Cannot be null.

WorldCursor

public WorldCursor(java.lang.String name,
                   org.bukkit.Location location,
                   org.bukkit.map.MapCursor.Type type)

Construct a WorldCursor with the arguments provided.

Parameters:

name - Name of the cursor, can be null for none.

location - The current location of whatever the cursor is tracking. Cannot be null.

type - The MapCursor type that will represent this RealWorldCursor. Cannot be null.

Method Detail

getLocation

public org.bukkit.Location getLocation()

Get the location.

Returns:

The mutable location of this cursor. Does not mean location on the map.

getType

public org.bukkit.map.MapCursor.Type getType()

Get the MapCursor type of the cursor.

Returns:

The type that will be displayed on the map.

setType

public void setType(org.bukkit.map.MapCursor.Type type)

Set the MapCursor type of the cursor.

Parameters:

type - The type that will be displayed on the map. Cannot be null.

isGlobal

public boolean isGlobal()

Get if the cursor is global.

Returns:

If this cursor should be hidden when not on the map.

setGlobal

public void setGlobal(boolean hide)

Set if the cursor is global.

getName

public java.lang.String getName()

Get the name.

Returns:

May be null indicating no name.

setName

public void setName(java.lang.String name)

Set the name.

Parameters:

name - Can be null for none.