Package io.github.thebusybiscuit.slimefun4.api.events

Class ClimbingPickLaunchEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.github.thebusybiscuit.slimefun4.api.events.ClimbingPickLaunchEvent

All Implemented Interfaces:

Cancellable

public class ClimbingPickLaunchEvent
extends PlayerEvent
implements Cancellable

An Event that is called whenever a Player has used a ClimbingPick on a climbable surface.

Author:

Linox

See Also:

• ClimbingPick

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
ClimbingPickLaunchEvent(Player player, Vector velocity, ClimbingPick pick, ItemStack itemStack, Block block)

Method Summary

Modifier and Type	Method	Description
Block	getBlock()	This returns the Block that was climbed.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
ItemStack	getItemStack()	This returns the ItemStack that was used.
ClimbingPick	getPick()	This returns the ClimbingPick that was used.
Vector	getVelocity()	This returns the velocity Vector that was applied to the Player who used the ClimbingPick.
boolean	isCancelled()
void	setCancelled(boolean cancel)
void	setVelocity(Vector velocity)	Use this to change the velocity Vector applied to the Player.

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

ClimbingPickLaunchEvent

@ParametersAreNonnullByDefault
public ClimbingPickLaunchEvent(Player player,
 Vector velocity,
 ClimbingPick pick,
 ItemStack itemStack,
 Block block)

Method Details

getVelocity

@Nonnull
public Vector getVelocity()

This returns the velocity Vector that was applied to the Player who used the ClimbingPick.

Returns:

The Vector of the applied velocity

setVelocity

public void setVelocity(@Nonnull
 Vector velocity)

Use this to change the velocity Vector applied to the Player.

Parameters:

velocity - The Vector velocity to apply

getPick

@Nonnull
public ClimbingPick getPick()

This returns the ClimbingPick that was used.

Returns:

The ClimbingPick that was used

getItemStack

@Nonnull
public ItemStack getItemStack()

This returns the ItemStack that was used.

Returns:

The ItemStack that was used

getBlock

@Nonnull
public Block getBlock()

This returns the Block that was climbed.

Returns:

The Block that was climbed

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface Cancellable

getHandlerList

@Nonnull
public static HandlerList getHandlerList()

getHandlers

@Nonnull
public HandlerList getHandlers()

Specified by:

getHandlers in class Event