io.github.bananapuncher714.radioboard.providers.canvas

Interface RadioIcon

All Known Implementing Classes:

RadioIconButton, RadioIconCloud, RadioIconGif, RadioIconImage, RadioIconSwitch

public interface RadioIcon

Can be added to RadioCanvas to display images

Author:

BananaPuncher714

Method Summary

Modifier and Type	Method and Description
int[]	getDisplay() Get the main representation of this icon
int	getHeight() Get the overall height of this icon
int	getWidth() Get the overall width of this icon
void	init(RadioCanvas provider) Called when a RadioCanvas is ready to receive input from this icon
void	onClick(org.bukkit.entity.Entity entity, DisplayInteract action, int x, int y) Called interaction from either a player or a projectile
void	terminate() Called when the RadioCanvas is disabling itself; Most likely end of use

Method Detail

getDisplay

int[] getDisplay()

Get the main representation of this icon

Returns:

An image with size width * height in an int color array

getWidth

int getWidth()

Get the overall width of this icon

Returns:

getHeight

int getHeight()

Get the overall height of this icon

Returns:

init

void init(RadioCanvas provider)

Called when a RadioCanvas is ready to receive input from this icon

Parameters:

provider - A RadioCanvas

onClick

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

Called interaction from either a player or a projectile

Parameters:

entity - The entity, either a player or a projectile

action - Will always be a player unless action is DisplayInteract.PROJECTILE

x - The X coordinate of the click relative to the top left of this icon

y - The Y coordinate of the click relative to the top left of this icon

terminate

void terminate()

Called when the RadioCanvas is disabling itself; Most likely end of use