org.bukkit.map.MapCursorCollection Class Reference

Represents all the map cursors on a MapCanvas. More...

Public Member Functions
int	size ()
	Get the amount of cursors in this collection.
MapCursor	getCursor (int index)
	Get a cursor from this collection.
boolean	removeCursor (MapCursor cursor)
	Remove a cursor from the collection.
MapCursor	addCursor (MapCursor cursor)
	Add a cursor to the collection.
MapCursor	addCursor (int x, int y, byte direction)
	Add a cursor to the collection.
MapCursor	addCursor (int x, int y, byte direction, byte type)
	Add a cursor to the collection.
MapCursor	addCursor (int x, int y, byte direction, byte type, boolean visible)
	Add a cursor to the collection.

Detailed Description

Represents all the map cursors on a MapCanvas.

Like MapCanvas, a MapCursorCollection is linked to a specific MapRenderer.

Definition at line 10 of file MapCursorCollection.java.

Member Function Documentation

MapCursor org.bukkit.map.MapCursorCollection.addCursor

(

MapCursor

cursor

)

Add a cursor to the collection.

Parameters

cursor

The MapCursor to add.

Returns

The MapCursor that was passed.

Definition at line 49 of file MapCursorCollection.java.

Referenced by org.bukkit.map.MapCursorCollection.addCursor().

MapCursor org.bukkit.map.MapCursorCollection.addCursor	(	int	x,
		int	y,
		byte	direction
	)

Add a cursor to the collection.

Parameters

x	The x coordinate, from -128 to 127.
y	The y coordinate, from -128 to 127.
direction	The facing of the cursor, from 0 to 15.

Returns

The newly added MapCursor.

Definition at line 62 of file MapCursorCollection.java.

References org.bukkit.map.MapCursorCollection.addCursor().

MapCursor org.bukkit.map.MapCursorCollection.addCursor	(	int	x,
		int	y,
		byte	direction,
		byte	type
	)

Add a cursor to the collection.

Parameters

x	The x coordinate, from -128 to 127.
y	The y coordinate, from -128 to 127.
direction	The facing of the cursor, from 0 to 15.
type	The type (color/style) of the map cursor.

Returns

The newly added MapCursor.

Definition at line 75 of file MapCursorCollection.java.

References org.bukkit.map.MapCursorCollection.addCursor().

MapCursor org.bukkit.map.MapCursorCollection.addCursor	(	int	x,
		int	y,
		byte	direction,
		byte	type,
		boolean	visible
	)

Add a cursor to the collection.

Parameters

x	The x coordinate, from -128 to 127.
y	The y coordinate, from -128 to 127.
direction	The facing of the cursor, from 0 to 15.
type	The type (color/style) of the map cursor.
visible	Whether the cursor is visible.

Returns

The newly added MapCursor.

Definition at line 89 of file MapCursorCollection.java.

References org.bukkit.map.MapCursorCollection.addCursor().

MapCursor org.bukkit.map.MapCursorCollection.getCursor

(

int

index

)

Get a cursor from this collection.

Parameters

index

The index of the cursor.

Returns

The MapCursor.

Definition at line 29 of file MapCursorCollection.java.

boolean org.bukkit.map.MapCursorCollection.removeCursor

(

MapCursor

cursor

)

Remove a cursor from the collection.

Parameters

cursor

The MapCursor to remove.

Returns

Whether the cursor was removed successfully.

Definition at line 39 of file MapCursorCollection.java.

int org.bukkit.map.MapCursorCollection.size

(

)

Get the amount of cursors in this collection.

Returns

The size of this collection.

Definition at line 19 of file MapCursorCollection.java.

---

The documentation for this class was generated from the following file:

• org/bukkit/map/MapCursorCollection.java