net.risingworld.api.events.player.gui

Class PlayerMapClickEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.gui.PlayerMapClickEvent

public class PlayerMapClickEvent
extends PlayerEvent

Called when a player clicks on a position on the map (gui).

Constructor Summary

Constructors

Constructor and Description
PlayerMapClickEvent(Player player, int mouseButton, boolean doubleClick, float worldpositionx, float worldpositionz)

Method Summary

Modifier and Type	Method and Description
int	getMouseButton() Gets the mouse button.
float	getWorldPositionX() Gets the world position (x) of the clicked position on the map.
float	getWorldPositionZ() Gets the world position (z) of the clicked position on the map.
boolean	isDoubleClick() Gets whether or not the player double clicked the map.

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

PlayerMapClickEvent

public PlayerMapClickEvent(Player player,
                           int mouseButton,
                           boolean doubleClick,
                           float worldpositionx,
                           float worldpositionz)

Method Detail

getWorldPositionX

public float getWorldPositionX()

Gets the world position (x) of the clicked position on the map.

Returns:

the x world position on the map.

getWorldPositionZ

public float getWorldPositionZ()

Gets the world position (z) of the clicked position on the map.

Returns:

the z world position on the map.

isDoubleClick

public boolean isDoubleClick()

Gets whether or not the player double clicked the map.

Returns:

true if the player double clicked the map, 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.