net.risingworld.api.events.player

Class PlayerElementInteractionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerElementInteractionEvent

All Implemented Interfaces:

Cancellable

public class PlayerElementInteractionEvent
extends PlayerEvent
implements Cancellable

Called when a player interacts (i.e. presses the interaction key) with a world element (as long as World3DModel.setInteractable(boolean) is set to true).

Constructor Summary

Constructors

Constructor and Description
PlayerElementInteractionEvent(Player player, WorldElement worldElement)

Method Summary

Modifier and Type	Method and Description
WorldElement	getWorldElement() Gets the world element the player was interacting with.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

PlayerElementInteractionEvent

public PlayerElementInteractionEvent(Player player,
                                     WorldElement worldElement)

Method Detail

getWorldElement

public WorldElement getWorldElement()

Gets the world element the player was interacting with.

Returns:

the world element.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.