io.github.nucleuspowered.nucleus.api.core

Interface NucleusWarmupManagerService

public interface NucleusWarmupManagerService

Manages the warmups.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusWarmupManagerService.WarmupTask Represents a task that will execute after some time.

Method Summary

Modifier and Type	Method and Description
boolean	awaitingExecution(org.spongepowered.api.entity.living.player.Player player) Whether there is a task awaiting execution.
boolean	cancel(org.spongepowered.api.entity.living.player.Player player) Cancels a task by Player
void	executeAfter(org.spongepowered.api.entity.living.player.Player target, java.time.Duration duration, NucleusWarmupManagerService.WarmupTask runnable) Executes a task after the specified time, if the target does not move or run a command.
void	executeAfter(org.spongepowered.api.entity.living.player.Player target, java.time.Duration duration, NucleusWarmupManagerService.WarmupTask runnable, boolean sendMessage) Executes a task after the specified time, if the target does not move or run a command.
void	executeAfterAsync(org.spongepowered.api.entity.living.player.Player target, java.time.Duration duration, NucleusWarmupManagerService.WarmupTask runnable) Executes a task after the specified time, if the target does not move or run a command.
void	executeAfterAsync(org.spongepowered.api.entity.living.player.Player target, java.time.Duration duration, NucleusWarmupManagerService.WarmupTask runnable, boolean sendMessage) Executes a task after the specified time, if the target does not move or run a command.

Method Detail

executeAfter

void executeAfter(org.spongepowered.api.entity.living.player.Player target,
                  java.time.Duration duration,
                  NucleusWarmupManagerService.WarmupTask runnable)

Executes a task after the specified time, if the target does not move or run a command.

Parameters:

target - The Player to execute the task on.

duration - The Duration to wait.

runnable - The NucleusWarmupManagerService.WarmupTask to execute.

executeAfter

void executeAfter(org.spongepowered.api.entity.living.player.Player target,
                  java.time.Duration duration,
                  NucleusWarmupManagerService.WarmupTask runnable,
                  boolean sendMessage)

Executes a task after the specified time, if the target does not move or run a command.

Parameters:

target - The Player to execute the task on.

duration - The Duration to wait.

runnable - The NucleusWarmupManagerService.WarmupTask to execute.

sendMessage - if to send a message indicating a warmup startup.

executeAfterAsync

void executeAfterAsync(org.spongepowered.api.entity.living.player.Player target,
                       java.time.Duration duration,
                       NucleusWarmupManagerService.WarmupTask runnable)

Executes a task after the specified time, if the target does not move or run a command. The task will be run off the main thread

Parameters:

target - The Player to execute the task on.

duration - The Duration to wait.

runnable - The NucleusWarmupManagerService.WarmupTask to execute

executeAfterAsync

void executeAfterAsync(org.spongepowered.api.entity.living.player.Player target,
                       java.time.Duration duration,
                       NucleusWarmupManagerService.WarmupTask runnable,
                       boolean sendMessage)

Executes a task after the specified time, if the target does not move or run a command. The task will be run off the main thread

Parameters:

target - The Player to execute the task on.

duration - The Duration to wait.

runnable - The NucleusWarmupManagerService.WarmupTask to execute.

sendMessage - if to send a message indicating a warmup startup.

cancel

boolean cancel(org.spongepowered.api.entity.living.player.Player player)

Cancels a task by Player

Parameters:

player - The player that this task is attached to.

Returns:

true if cancelled, false otherwise

awaitingExecution

boolean awaitingExecution(org.spongepowered.api.entity.living.player.Player player)

Whether there is a task awaiting execution.

Parameters:

player - The player

Returns:

true if so