io.github.bananapuncher714.radioboard.api

Interface MapDisplayProvider

All Known Implementing Classes:

GifPlayer, ImageProvider, RadioCanvas

public interface MapDisplayProvider

Interface for content that provides Frame to MapDisplay

Author:

BananaPuncher714

Method Summary

Modifier and Type	Method and Description
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	provideFor(MapDisplay display) Start providing frames for the given display
void	stopProviding() Terminate this MapDisplayProvider and stop providing frames for any display

Method Detail

getSource

Frame getSource()

Get a Frame from this provider at any time

Returns:

null if there are no new updates

interactAt

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

Interaction with an entity on the board

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

provideFor

void provideFor(MapDisplay display)

Start providing frames for the given display

Parameters:

display -

stopProviding

void stopProviding()

Terminate this MapDisplayProvider and stop providing frames for any display