Package org.incendo.cloud.processors.cooldown

Interface Cooldown<C>

Type Parameters:

C - command sender type

All Superinterfaces:

Command.Builder.Applicable<C>

All Known Implementing Classes:

ImmutableCooldown

@Immutable
@API(status=STABLE,
     since="1.0.0")
public interface Cooldown<C>
extends Command.Builder.Applicable<C>

An instance of a cooldown for a CooldownGroup belonging to a command sender.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
default @NonNull Command.Builder<C>	applyToCommandBuilder(@NonNull Command.Builder<C> builder)
static <C> @NonNull ImmutableCooldown.DurationBuildStage<C>	builder()	Returns a new cooldown builder.
@NonNull DurationFunction<C>	duration()	Returns the cooldown duration.
default @Nullable CooldownGroup	group()	Returns the group that this instance belongs to.
static <C> @NonNull Cooldown<C>	of(@NonNull DurationFunction<C> duration)	Returns a new cooldown with the given duration using CooldownConfiguration.fallbackGroup() as the group.
static <C> @NonNull Cooldown<C>	of(@NonNull DurationFunction<C> duration, @NonNull CooldownGroup group)	Returns a new cooldown with the given duration and group.

Method Details

of

static <C> @NonNull Cooldown<C> of(@NonNull DurationFunction<C> duration)

Returns a new cooldown with the given duration using CooldownConfiguration.fallbackGroup() as the group.

Type Parameters:

C - command sender type

Parameters:

duration - the duration

Returns:

the cooldown

of

static <C> @NonNull Cooldown<C> of(@NonNull DurationFunction<C> duration,
 @NonNull CooldownGroup group)

Returns a new cooldown with the given duration and group.

Type Parameters:

C - command sender type

Parameters:

duration - the duration

group - cooldown group

Returns:

the cooldown

builder

static <C>
@NonNull ImmutableCooldown.DurationBuildStage<C> builder()

Returns a new cooldown builder.

Type Parameters:

C - command sender type

Returns:

the builder

duration

@NonNull DurationFunction<C> duration()

Returns the cooldown duration.

Returns:

the duration

group

default @Nullable CooldownGroup group()

Returns the group that this instance belongs to. If set to null then CooldownConfiguration.fallbackGroup() will be used.

Returns:

the cooldown group

applyToCommandBuilder

default @NonNull Command.Builder<C> applyToCommandBuilder(@NonNull Command.Builder<C> builder)

Specified by:

applyToCommandBuilder in interface Command.Builder.Applicable<C>