Package dev.cerus.maps.api

Class MapScreen

java.lang.Object

dev.cerus.maps.api.MapScreen

public class MapScreen
extends Object

Represents an array of clientside maps that form a screen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MapScreen.HitBox

Constructor Summary

Constructors

Constructor	Description
MapScreen(int id, VersionAdapter versionAdapter, int w, int h)
MapScreen(int id, VersionAdapter versionAdapter, int w, int h, ClientsideMap[][] mapArray)

Method Summary

Modifier and Type	Method	Description
void	addMarker(Marker marker)	Add a marker
void	calculateHitBox()	Recalculate the hit box of this screen
void	clearMarkers()	Remove all markers
void	despawnFrames(org.bukkit.entity.Player... players)	Remove the frames
void	destroyFrames(org.bukkit.entity.Player... players)
int[][]	getFrameIds()
Frame[][]	getFrames()
MapGraphics<MapScreen,ClientsideMap[][]>	getGraphics()
int	getHeight()
MapScreen.HitBox	getHitBox()
int	getId()
org.bukkit.Location	getLocation()
Collection<Marker>	getMarkers()
int	getWidth()
void	removeMarker(Marker marker)	Remove a marker
void	sendFrames(org.bukkit.entity.Player... players)	Send the frame updates to the players
void	sendMaps(boolean full)	Send the map data to all online players
void	sendMaps(boolean full, Collection<? extends org.bukkit.entity.Player> players)	Send the map data to the specified players
void	sendMaps(boolean full, org.bukkit.entity.Player... players)	Send the map data to the specified players
void	sendMarkers(org.bukkit.entity.Player... players)
void	setFrameIds(int[][] frameIds)	Deprecated.
void	setFrames(Frame[][] frames)
void	setHitBox(MapScreen.HitBox hitBox)
void	setLocation(org.bukkit.Location location)
void	spawnFrames(org.bukkit.entity.Player... players)	Spawn the frames
void	useFastGraphics(boolean b)

Methods inherited from class java.lang.Object

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

Constructor Details

MapScreen

public MapScreen(int id,
 VersionAdapter versionAdapter,
 int w,
 int h)

MapScreen

public MapScreen(int id,
 VersionAdapter versionAdapter,
 int w,
 int h,
 ClientsideMap[][] mapArray)

Method Details

addMarker

public void addMarker(Marker marker)

Add a marker

Parameters:

marker - The marker to add

removeMarker

public void removeMarker(Marker marker)

Remove a marker

Parameters:

marker - The marker to remove

clearMarkers

public void clearMarkers()

Remove all markers

sendMaps

public void sendMaps(boolean full)

Send the map data to all online players

Parameters:

full - True if full map data should be sent

sendMaps

public void sendMaps(boolean full,
 Collection<? extends org.bukkit.entity.Player> players)

Send the map data to the specified players

Parameters:

full - True if full map data should be sent

players - The receivers

sendMaps

public void sendMaps(boolean full,
 org.bukkit.entity.Player... players)

Send the map data to the specified players

Parameters:

full - True if full map data should be sent

players - The receivers

sendMarkers

public void sendMarkers(org.bukkit.entity.Player... players)

sendFrames

public void sendFrames(org.bukkit.entity.Player... players)

Send the frame updates to the players

Parameters:

players - The receivers

spawnFrames

public void spawnFrames(org.bukkit.entity.Player... players)

Spawn the frames

Parameters:

players - The receivers

despawnFrames

public void despawnFrames(org.bukkit.entity.Player... players)

Remove the frames

Parameters:

players - The receivers

destroyFrames

public void destroyFrames(org.bukkit.entity.Player... players)

getId

public int getId()

getWidth

public int getWidth()

getHeight

public int getHeight()

useFastGraphics

public void useFastGraphics(boolean b)

getGraphics

public MapGraphics<MapScreen,ClientsideMap[][]> getGraphics()

getFrames

public Frame[][] getFrames()

setFrames

public void setFrames(Frame[][] frames)

getFrameIds

public int[][] getFrameIds()

setFrameIds

@Deprecated
public void setFrameIds(int[][] frameIds)

Deprecated.

getMarkers

public Collection<Marker> getMarkers()

getLocation

public org.bukkit.Location getLocation()

setLocation

public void setLocation(org.bukkit.Location location)

calculateHitBox

public void calculateHitBox()

Recalculate the hit box of this screen

getHitBox

public MapScreen.HitBox getHitBox()

setHitBox

public void setHitBox(MapScreen.HitBox hitBox)