Class PlayerPostEffectsModifyEvent

java.lang.Object

fr.fidorial.event.player.PlayerPostEffectsModifyEvent

All Implemented Interfaces:

Cancellable, Event, PlayerEvent

public final class PlayerPostEffectsModifyEvent
extends Object
implements PlayerEvent, Cancellable

Fired right before a player has their post effects modified.

Cancelling the event keeps their current post effects.

Since:

0.1.0

API Note:

the event is not fired whenever the underlying list of post effects hasn't changed

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerPostEffectsModifyEvent.Cause	What triggered the change in the player's active post effects

Constructor Summary

Constructors

Constructor	Description
PlayerPostEffectsModifyEvent(Player player, PlayerPostEffectsModifyEvent.Cause cause, List<Key> currentPostEffects, List<Key> newPostEffects)	Creates an event.

Method Summary

Modifier and Type	Method	Description
PlayerPostEffectsModifyEvent.Cause	cause()	Returns what triggered the change in active post effects.
@Unmodifiable List<Key>	currentPostEffects()	Returns the current active post effects.
boolean	isCancelled()	Returns true if the action this event describes will not happen.
@Unmodifiable List<Key>	newPostEffects()	Returns the new post effects.
Player	player()	Returns the player involved in this event.
void	setCancelled(boolean cancelled)	Prevents or re-allows the action this event describes.

Methods inherited from class Object

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

Constructor Details

PlayerPostEffectsModifyEvent

@Internal
public PlayerPostEffectsModifyEvent(Player player,
 PlayerPostEffectsModifyEvent.Cause cause,
 List<Key> currentPostEffects,
 List<Key> newPostEffects)

Creates an event.

Parameters:

player - the player whose post effects are about to be changed

cause - what triggered the change in active post effects

currentPostEffects - the currently active post effects

newPostEffects - the post effects about to be applied

Since:

0.1.0

Method Details

player

public Player player()

Description copied from interface: PlayerEvent

Returns the player involved in this event.

Specified by:

player in interface PlayerEvent

Returns:

the player involved in this event

newPostEffects

public @Unmodifiable List<Key> newPostEffects()

Returns the new post effects.

Returns:

the new post effects

Since:

0.1.0

currentPostEffects

public @Unmodifiable List<Key> currentPostEffects()

Returns the current active post effects.

Returns:

the current active post effects

Since:

0.1.0

cause

public PlayerPostEffectsModifyEvent.Cause cause()

Returns what triggered the change in active post effects.

Returns:

what triggered the change in active post effects

Since:

0.1.0

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Returns true if the action this event describes will not happen.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the action this event describes will not happen

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: Cancellable

Prevents or re-allows the action this event describes.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancelled - true to prevent it