Package org.bukkit.event.entity

Class EntityToggleSwimEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.EntityToggleSwimEvent

All Implemented Interfaces:

Cancellable

public class EntityToggleSwimEvent
extends EntityEvent
implements Cancellable

Sent when an entity's swimming status is toggled.

Nested Class Summary

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

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.entity.EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
EntityToggleSwimEvent(@NotNull LivingEntity who, boolean isSwimming)

Method Summary

Modifier and Type	Method	Description
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
boolean	isCancelled()	Gets the cancellation state of this event.
boolean	isSwimming()	Returns true if the entity is now swims or false if the entity stops swimming.
void	setCancelled(boolean cancel)	Deprecated. This does nothing, the server and the client doesn't work correctly when the server try to bypass this.

Methods inherited from class org.bukkit.event.entity.EntityEvent

getEntity, getEntityType

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

EntityToggleSwimEvent

public EntityToggleSwimEvent(@NotNull
 @NotNull LivingEntity who,
 boolean isSwimming)

Method Details

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

@Deprecated
public void setCancelled(boolean cancel)

Deprecated.

This does nothing, the server and the client doesn't work correctly when the server try to bypass this. A current workaround exists. If you want to cancel the switch from the ground state to the swimming state you need to disable the sprinting flag for the player after the cancel action.

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

isSwimming

public boolean isSwimming()

Returns true if the entity is now swims or false if the entity stops swimming.

Returns:

new swimming state

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()