io.github.bananapuncher714.radioboard.providers.canvas

Class RadioCanvas

java.lang.Object

io.github.bananapuncher714.radioboard.providers.canvas.RadioCanvas

All Implemented Interfaces:

MapDisplayProvider

public class RadioCanvas
extends java.lang.Object
implements MapDisplayProvider

A simple canvas that allows modification through RadioIcons

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
RadioCanvas(int width, int height) Construct a blank canvas
RadioCanvas(int width, int height, java.awt.Image image) Construct a new canvas with the given image as the background

Method Summary

Modifier and Type	Method and Description
java.util.List<RadioIcon>	getIcons()
Frame	getSource() Get a Frame from this provider at any time
void	interactAt(org.bukkit.entity.Entity entity, DisplayInteract action, int x, int y) Interaction with an entity on the board
void	loadIcon(RadioIcon icon, int x, int y) Load a given icon at specific coordinates
void	provideFor(MapDisplay display) Start providing frames for the given display
void	stopProviding() Terminate this MapDisplayProvider and stop providing frames for any display
void	unloadIcon(RadioIcon icon) Unload a given RadioIcon and remove it completely
void	update(RadioIcon icon) Update and send a radio icon, calls update(RadioIcon, boolean)
void	update(RadioIcon icon, boolean send) Update an icon and optionally update the map display; follows the same principle as updateBuffer() but more complicated
void	updateBuffer() Update the buffer entirely without sending an update

Methods inherited from class java.lang.Object

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

Constructor Detail

RadioCanvas

public RadioCanvas(int width,
                   int height)

Construct a blank canvas

Parameters:

width -

height -

RadioCanvas

public RadioCanvas(int width,
                   int height,
                   java.awt.Image image)

Construct a new canvas with the given image as the background

Parameters:

width -

height -

image -

Method Detail

getSource

public Frame getSource()

Description copied from interface: MapDisplayProvider

Get a Frame from this provider at any time

Specified by:

getSource in interface MapDisplayProvider

Returns:

null if there are no new updates

interactAt

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

Description copied from interface: MapDisplayProvider

Interaction with an entity on the board

Specified by:

interactAt in interface MapDisplayProvider

Parameters:

entity - Either a player or a projectile

action - Will only be DisplayInteract.PROJECTILE if entity is a projectile

x - The X relative to the top left corner

y - The Y relative to the top left corner

loadIcon

public void loadIcon(RadioIcon icon,
                     int x,
                     int y)

Load a given icon at specific coordinates

Parameters:

icon -

x -

y -

update

public void update(RadioIcon icon)

Update and send a radio icon, calls update(RadioIcon, boolean)

Parameters:

icon -

update

public void update(RadioIcon icon,
                   boolean send)

Update an icon and optionally update the map display; follows the same principle as updateBuffer() but more complicated

Parameters:

icon -

send -

updateBuffer

public void updateBuffer()

Update the buffer entirely without sending an update

unloadIcon

public void unloadIcon(RadioIcon icon)

Unload a given RadioIcon and remove it completely

Parameters:

icon -

getIcons

public java.util.List<RadioIcon> getIcons()

provideFor

public void provideFor(MapDisplay display)

Description copied from interface: MapDisplayProvider

Start providing frames for the given display

Specified by:

provideFor in interface MapDisplayProvider

stopProviding

public void stopProviding()

Description copied from interface: MapDisplayProvider

Terminate this MapDisplayProvider and stop providing frames for any display

Specified by:

stopProviding in interface MapDisplayProvider