net.risingworld.api.events.player.gui

Class PlayerGuiElementClickEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.gui.PlayerGuiElementClickEvent

public class PlayerGuiElementClickEvent
extends PlayerEvent

Called when a player clicks on a gui element. This does only work if GuiElement.setClickable(boolean) was set to true.

Constructor Summary

Constructors

Constructor and Description
PlayerGuiElementClickEvent(Player player, GuiElement guiElement, boolean doubleClick, int mouseButton, float mouseXAbs, float mouseYAbs, float mouseXRel, float mouseYRel)

Method Summary

Modifier and Type	Method and Description
float	getAbsoluteMousePositionX() Gets the absolute x (horizontal) position of the mouse cursor (inside the gui element).
float	getAbsoluteMousePositionY() Gets the absolute y (vertical) position of the mouse cursor (inside the gui element).
GuiElement	getGuiElement() Gets the gui element the player has clicked.
int	getMouseButton() Gets the mouse button.
float	getRelativeMousePositionX() Gets the relative (0.0-1.0) x (horizontal) position of the mouse cursor (inside the gui element).
float	getRelativeMousePositionY() Gets the relative (0.0-1.0) y (vertical) position of the mouse cursor (inside the gui element).
boolean	isDoubleClick() Gets whether or not the player double clicked the gui element.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerGuiElementClickEvent

public PlayerGuiElementClickEvent(Player player,
                                  GuiElement guiElement,
                                  boolean doubleClick,
                                  int mouseButton,
                                  float mouseXAbs,
                                  float mouseYAbs,
                                  float mouseXRel,
                                  float mouseYRel)

Method Detail

getGuiElement

public GuiElement getGuiElement()

Gets the gui element the player has clicked.

Returns:

the gui element.

isDoubleClick

public boolean isDoubleClick()

Gets whether or not the player double clicked the gui element.

Returns:

true if the player double clicked the gui element, false if it was just a single click.

getMouseButton

public int getMouseButton()

Gets the mouse button. Typically 0 for the left mouse button, 1 for the right mouse button (higher numbers for additional mouse buttons).

Returns:

the mouse button.

getAbsoluteMousePositionX

public float getAbsoluteMousePositionX()

Gets the absolute x (horizontal) position of the mouse cursor (inside the gui element).

Returns:

the absolute x mouse position.

getAbsoluteMousePositionY

public float getAbsoluteMousePositionY()

Gets the absolute y (vertical) position of the mouse cursor (inside the gui element).

Returns:

the absolute y mouse position.

getRelativeMousePositionX

public float getRelativeMousePositionX()

Gets the relative (0.0-1.0) x (horizontal) position of the mouse cursor (inside the gui element).

Returns:

the relative x mouse position.

getRelativeMousePositionY

public float getRelativeMousePositionY()

Gets the relative (0.0-1.0) y (vertical) position of the mouse cursor (inside the gui element).

Returns:

the relative y mouse position.