io.github.bananapuncher714.radioboard.api

Class MapDisplay

java.lang.Object

io.github.bananapuncher714.radioboard.api.MapDisplay

Direct Known Subclasses:

RBoard

public abstract class MapDisplay
extends java.lang.Object

Simple class for virtual displays

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
MapDisplay(java.lang.String id, int startId, int mapWidth, int mapHeight)

Method Summary

Modifier and Type	Method and Description
void	addObserver(RadioObserver... obs) Add an observer
abstract void	clear() Clear this map's buffer completely
java.lang.String	getId() Simple any case string identifier
int	getMapHeight() Height of this display in map lengths
int	getMapId() Top left map id
int	getMapWidth() Width of this display in map lengths
MapDisplayProvider	getSource() Get the MapDisplayProvider
boolean	isObserving(RadioObserver observer) Check if an observer is observing this map; does not necessarily have to be online
void	onClick(org.bukkit.entity.Entity entity, DisplayInteract action, int id, int x, int y) On interact, either a player or a projectile
void	removeObserver(RadioObserver... obs) Remove an observer, if they are observing
void	removeObservers() Remove all observers
void	setSource(MapDisplayProvider provider) Set the MapDisplayProvider
void	terminate() Kill this MapDisplay
abstract void	update() Update either the MapDisplayProvider's current frame or the buffer
abstract void	update(Frame frame) Update the display with a given frame
abstract void	update(RadioObserver... observers) Update for the specified observers only; they do NOT have to be observing

Methods inherited from class java.lang.Object

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

Constructor Detail

MapDisplay

public MapDisplay(java.lang.String id,
                  int startId,
                  int mapWidth,
                  int mapHeight)

Method Detail

getId

public java.lang.String getId()

Simple any case string identifier

Returns:

getMapId

public int getMapId()

Top left map id

Returns:

getMapWidth

public int getMapWidth()

Width of this display in map lengths

Returns:

getMapHeight

public int getMapHeight()

Height of this display in map lengths

Returns:

getSource

public MapDisplayProvider getSource()

Get the MapDisplayProvider

Returns:

setSource

public void setSource(MapDisplayProvider provider)

Set the MapDisplayProvider

Parameters:

provider -

terminate

public void terminate()

Kill this MapDisplay

addObserver

public void addObserver(RadioObserver... obs)

Add an observer

Parameters:

obs -

removeObserver

public void removeObserver(RadioObserver... obs)

Remove an observer, if they are observing

Parameters:

obs -

isObserving

public boolean isObserving(RadioObserver observer)

Check if an observer is observing this map; does not necessarily have to be online

Parameters:

observer - An observer

Returns:

removeObservers

public void removeObservers()

Remove all observers

onClick

public void onClick(org.bukkit.entity.Entity entity,
                    DisplayInteract action,
                    int id,
                    int x,
                    int y)

On interact, either a player or a projectile

Parameters:

entity - The entity that interacts, should only be a projectile if action is DisplayInteract.PROJECTILE

action - The action that occurs

id - The id of the map pressed

x - The X relative to the map

y - The Y relative to the map

clear

public abstract void clear()

Clear this map's buffer completely

update

public abstract void update()

Update either the MapDisplayProvider's current frame or the buffer

update

public abstract void update(RadioObserver... observers)

Update for the specified observers only; they do NOT have to be observing

Parameters:

observers - An array of observers

update

public abstract void update(Frame frame)

Update the display with a given frame

Parameters:

frame - An arbitary frame