Package org.bukkit.event.entity

Class EntityCombustEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.EntityCombustEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

EntityCombustByBlockEvent, EntityCombustByEntityEvent

public class EntityCombustEvent
extends EntityEvent
implements Cancellable

Called when an entity combusts.

If an Entity Combust event is cancelled, the entity will not combust.

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
EntityCombustEvent(@NotNull Entity combustee, float duration)
EntityCombustEvent(@NotNull Entity combustee, int duration)	Deprecated.

Method Summary

Modifier and Type	Method	Description
float	getDuration()
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setDuration(float duration)	The number of seconds the combustee should be alight for.
void	setDuration(int duration)	Deprecated, for removal: This API element is subject to removal in a future version. duration is now a float

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

EntityCombustEvent

@Deprecated(since="1.21")
public EntityCombustEvent(@NotNull
 @NotNull Entity combustee,
 int duration)

Deprecated.

EntityCombustEvent

public EntityCombustEvent(@NotNull
 @NotNull Entity combustee,
 float duration)

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

public void setCancelled(boolean cancel)

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

getDuration

public float getDuration()

Returns:

the amount of time (in seconds) the combustee should be alight for

setDuration

public void setDuration(float duration)

The number of seconds the combustee should be alight for.

This value will only ever increase the combustion time, not decrease existing combustion times.

Parameters:

duration - the time in seconds to be alight for.

setDuration

@Deprecated(since="1.21",
            forRemoval=true)
public void setDuration(int duration)

Deprecated, for removal: This API element is subject to removal in a future version.

duration is now a float

The number of seconds the combustee should be alight for.

This value will only ever increase the combustion time, not decrease existing combustion times.

Parameters:

duration - the time in seconds to be alight for.

See Also:

• setDuration(float)

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()