net.risingworld.api.events.player

Class PlayerObjectInteractionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerObjectEvent

net.risingworld.api.events.player.PlayerObjectInteractionEvent

All Implemented Interfaces:

Cancellable

public class PlayerObjectInteractionEvent
extends PlayerObjectEvent
implements Cancellable

Called when a player interacts (i.e. presses the interaction key) with a default game object (e.g. furniture). Note that this event will also be triggered when the player interacts with an object which isn't selectable by default (e.g. a table).

See Also:

PlayerElementInteractionEvent, PlayerNpcInteractionEvent

Constructor Summary

Constructors

Constructor and Description
PlayerObjectInteractionEvent(Player player, short objectid, byte variation, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, int info, byte status, boolean objectSelectable)

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Determines if the event is cancelled.
boolean	isObjectSelectable() Gets whether or not the object is actually selectable.
void	setCancelled(boolean cancel) Cancels this event.

Methods inherited from class net.risingworld.api.events.player.world.PlayerObjectEvent

getChunkPositionX, getChunkPositionY, getChunkPositionZ, getObjectDefinition, getObjectInfoID, getObjectPosition, getObjectPositionX, getObjectPositionY, getObjectPositionZ, getObjectRotation, getObjectRotationX, getObjectRotationY, getObjectRotationZ, getObjectStatus, getObjectTypeID, getObjectVariation, getPX, getPY, getPZ, getRX, getRY, getRZ

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

PlayerObjectInteractionEvent

public PlayerObjectInteractionEvent(Player player,
                                    short objectid,
                                    byte variation,
                                    int cx,
                                    int cy,
                                    int cz,
                                    short px,
                                    short py,
                                    short pz,
                                    short rx,
                                    short ry,
                                    short rz,
                                    int info,
                                    byte status,
                                    boolean objectSelectable)

Method Detail

isObjectSelectable

public boolean isObjectSelectable()

Gets whether or not the object is actually selectable. This event triggers whenever a player interacts with an object (even if it is not selectable by default), so by calling this function you can determine if the object is actually selectable (e.g. torches, doors, chairs, chests, beds etc) or not (e.g. tables, torch holder, vases, statues etc).

Returns:

true if the object is actually selectable, false if not.

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.