org.spongepowered.api.event.entity.living.humanoid.player

Interface CooldownEvent.Set

All Superinterfaces:

Cancellable, CooldownEvent, Event, TargetEntityEvent, TargetHumanoidEvent, TargetLivingEvent, TargetPlayerEvent

Enclosing interface:

CooldownEvent

public static interface CooldownEvent.Set
extends CooldownEvent, Cancellable

Handles an ItemType being given a cooldown for a Player.

The cooldowns are all in ticks.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.entity.living.humanoid.player.CooldownEvent

CooldownEvent.End, CooldownEvent.Set

Method Summary

Modifier and Type	Method and Description
int	getNewCooldown() Gets the new cooldown the item type has for the player.
int	getOriginalNewCooldown() Gets the original new set cooldown at the beginning of the event.
OptionalInt	getStartingCooldown() Gets the cooldown the item type had beforehand, if it had one at all.
void	setNewCooldown(int ticks) Sets the new cooldown for the item type for the player.

Methods inherited from interface org.spongepowered.api.event.entity.living.humanoid.player.CooldownEvent

getItemType

Methods inherited from interface org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

getTargetEntity

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getStartingCooldown

OptionalInt getStartingCooldown()

Gets the cooldown the item type had beforehand, if it had one at all.

Returns:

The cooldown of the item type beforehand

getOriginalNewCooldown

int getOriginalNewCooldown()

Gets the original new set cooldown at the beginning of the event.

Returns:

The originally set cooldown

getNewCooldown

int getNewCooldown()

Gets the new cooldown the item type has for the player.

Returns:

The new cooldown of the item type

setNewCooldown

void setNewCooldown(int ticks)

Sets the new cooldown for the item type for the player.

Parameters:

ticks - The amount of ticks the cooldown should last for