io.github.bananapuncher714.radioboard.providers.canvas

Class RadioIconButton

java.lang.Object

io.github.bananapuncher714.radioboard.providers.canvas.RadioIconButton

All Implemented Interfaces:

RadioIcon

public class RadioIconButton
extends java.lang.Object
implements RadioIcon

A button that stays pressed for a certain amount of time and can run a command

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
RadioIconButton(int[] unclicked, int[] clicked, int width, java.lang.String command, long delay)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RadioIconButton

public RadioIconButton(int[] unclicked,
                       int[] clicked,
                       int width,
                       java.lang.String command,
                       long delay)

Method Detail

getWidth

public int getWidth()

Description copied from interface: RadioIcon

Get the overall width of this icon

Specified by:

getWidth in interface RadioIcon

Returns:

getHeight

public int getHeight()

Description copied from interface: RadioIcon

Get the overall height of this icon

Specified by:

getHeight in interface RadioIcon

Returns:

getDisplay

public int[] getDisplay()

Description copied from interface: RadioIcon

Get the main representation of this icon

Specified by:

getDisplay in interface RadioIcon

Returns:

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

init

public void init(RadioCanvas provider)

Description copied from interface: RadioIcon

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

Specified by:

init in interface RadioIcon

Parameters:

provider - A RadioCanvas

onClick

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

Description copied from interface: RadioIcon

Called interaction from either a player or a projectile

Specified by:

onClick in interface RadioIcon

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

public void terminate()

Description copied from interface: RadioIcon

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

Specified by:

terminate in interface RadioIcon