com.cjcrafter.foliascheduler

Interface EntitySchedulerImplementation

public interface EntitySchedulerImplementation

Represents a scheduler that can schedule tasks to be run on an entity.

The entity scheduler can return null if the entity you are scheduling on is no longer valid (e.g. has been removed from the world). In these cases, you can specify the `retired` runnable to execute code conditionally if the entity is retired before a task is run.

Method Summary

Modifier and Type	Method and Description
default boolean	execute(@NotNull java.lang.Runnable run) Schedules a task to be run on the next tick.
boolean	execute(@NotNull java.lang.Runnable run, @Nullable java.lang.Runnable retired, long delay) Schedules a task to be run immediately.
default @Nullable TaskImplementation<java.lang.Void>	run(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer) Schedules a task to be run on the next tick.
default @Nullable TaskImplementation<java.lang.Void>	run(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, @Nullable java.lang.Runnable retired) Schedules a task to be run on the next tick.
default <T> @Nullable TaskImplementation<T>	run(@NotNull java.util.function.Function<TaskImplementation<T>,T> function) Schedules a task to be run on the next tick.
<T> @Nullable TaskImplementation<T>	run(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, @Nullable java.lang.Runnable retired) Schedules a task to be run on the next tick.
default @Nullable TaskImplementation<java.lang.Void>	run(@NotNull java.lang.Runnable runnable) Schedules a task to be run on the next tick.
default @Nullable TaskImplementation<java.lang.Void>	run(@NotNull java.lang.Runnable runnable, @Nullable java.lang.Runnable retired) Schedules a task to be run on the next tick.
default @Nullable TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long delay, long period) Schedules a task to be run after a delay.
default @Nullable TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, @Nullable java.lang.Runnable retired, long delay, long period) Schedules a task to be run after a delay.
default <T> @Nullable TaskImplementation<T>	runAtFixedRate(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long delay, long period) Schedules a task to be run after a delay.
<T> @Nullable TaskImplementation<T>	runAtFixedRate(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, @Nullable java.lang.Runnable retired, long delay, long period) Schedules a task to be run after a delay.
default @Nullable TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.lang.Runnable runnable, long delay, long period) Schedules a task to be run after a delay.
default @Nullable TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.lang.Runnable runnable, @Nullable java.lang.Runnable retired, long delay, long period) Schedules a task to be run after a delay.
default @Nullable TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long delay) Schedules a task to be run after a delay.
default @Nullable TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, @Nullable java.lang.Runnable retired, long delay) Schedules a task to be run after a delay.
default <T> @Nullable TaskImplementation<T>	runDelayed(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long delay) Schedules a task to be run after a delay.
<T> @Nullable TaskImplementation<T>	runDelayed(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, @Nullable java.lang.Runnable retired, long delay) Schedules a task to be run after a delay.
default @Nullable TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.lang.Runnable runnable, long delay) Schedules a task to be run after a delay.
default @Nullable TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.lang.Runnable runnable, @Nullable java.lang.Runnable retired, long delay) Schedules a task to be run after a delay.

Method Detail

execute

boolean execute(@NotNull
                @NotNull java.lang.Runnable run,
                @Nullable
                @Nullable java.lang.Runnable retired,
                long delay)

Schedules a task to be run immediately.

Parameters:

run - The task to run.

retired - The task to run if the entity is retired.

delay - The delay before the callback is run.

execute

default boolean execute(@NotNull
                        @NotNull java.lang.Runnable run)

Schedules a task to be run on the next tick.

Parameters:

run - The task to run.

run

@Nullable
<T> @Nullable TaskImplementation<T> run(@NotNull
                                                  @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                  @Nullable
                                                  @Nullable java.lang.Runnable retired)

Schedules a task to be run on the next tick.

Parameters:

function - The task to run.

retired - The task to run if the entity is retired.

Returns:

The task that was scheduled.

run

@Nullable
default @Nullable TaskImplementation<java.lang.Void> run(@NotNull
                                                                   @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                   @Nullable
                                                                   @Nullable java.lang.Runnable retired)

Schedules a task to be run on the next tick.

Parameters:

consumer - The task to run.

Returns:

The task that was scheduled.

run

@Nullable
default @Nullable TaskImplementation<java.lang.Void> run(@NotNull
                                                                   @NotNull java.lang.Runnable runnable,
                                                                   @Nullable
                                                                   @Nullable java.lang.Runnable retired)

Schedules a task to be run on the next tick.

Parameters:

runnable - The task to run.

Returns:

The task that was scheduled.

run

@Nullable
default <T> @Nullable TaskImplementation<T> run(@NotNull
                                                          @NotNull java.util.function.Function<TaskImplementation<T>,T> function)

Schedules a task to be run on the next tick.

Parameters:

function - The task to run.

Returns:

The task that was scheduled.

run

@Nullable
default @Nullable TaskImplementation<java.lang.Void> run(@NotNull
                                                                   @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer)

Schedules a task to be run on the next tick.

Parameters:

consumer - The task to run.

Returns:

The task that was scheduled.

run

@Nullable
default @Nullable TaskImplementation<java.lang.Void> run(@NotNull
                                                                   @NotNull java.lang.Runnable runnable)

Schedules a task to be run on the next tick.

Parameters:

runnable - The task to run.

Returns:

The task that was scheduled.

runDelayed

@Nullable
<T> @Nullable TaskImplementation<T> runDelayed(@NotNull
                                                         @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                         @Nullable
                                                         @Nullable java.lang.Runnable retired,
                                                         long delay)

Schedules a task to be run after a delay.

Parameters:

function - The task to run.

retired - The task to run if the entity is retired.

delay - The delay before the task is run.

Returns:

The task that was scheduled.

runDelayed

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                          @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                          @Nullable
                                                                          @Nullable java.lang.Runnable retired,
                                                                          long delay)

Schedules a task to be run after a delay.

Parameters:

consumer - The task to run.

retired - The task to run if the entity is retired.

delay - The delay before the task is run.

Returns:

The task that was scheduled.

runDelayed

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                          @NotNull java.lang.Runnable runnable,
                                                                          @Nullable
                                                                          @Nullable java.lang.Runnable retired,
                                                                          long delay)

Schedules a task to be run after a delay.

Parameters:

runnable - The task to run.

retired - The task to run if the entity is retired.

delay - The delay before the task is run.

Returns:

The task that was scheduled.

runDelayed

@Nullable
default <T> @Nullable TaskImplementation<T> runDelayed(@NotNull
                                                                 @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                                 long delay)

Schedules a task to be run after a delay.

Parameters:

function - The task to run.

delay - The delay before the task is run.

Returns:

The task that was scheduled.

runDelayed

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                          @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                          long delay)

Schedules a task to be run after a delay.

Parameters:

consumer - The task to run.

delay - The delay before the task is run.

Returns:

The task that was scheduled.

runDelayed

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                          @NotNull java.lang.Runnable runnable,
                                                                          long delay)

Schedules a task to be run after a delay.

Parameters:

runnable - The task to run.

delay - The delay before the task is run.

Returns:

The task that was scheduled.

runAtFixedRate

@Nullable
<T> @Nullable TaskImplementation<T> runAtFixedRate(@NotNull
                                                             @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                             @Nullable
                                                             @Nullable java.lang.Runnable retired,
                                                             long delay,
                                                             long period)

Schedules a task to be run after a delay.

Parameters:

function - The task to run.

retired - The task to run if the entity is retired.

delay - The delay before the task is run.

period - The period between each run.

Returns:

The task that was scheduled.

runAtFixedRate

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                              @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                              @Nullable
                                                                              @Nullable java.lang.Runnable retired,
                                                                              long delay,
                                                                              long period)

Schedules a task to be run after a delay.

Parameters:

consumer - The task to run.

retired - The task to run if the entity is retired.

delay - The delay before the task is run.

period - The period between each run.

Returns:

The task that was scheduled.

runAtFixedRate

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                              @NotNull java.lang.Runnable runnable,
                                                                              @Nullable
                                                                              @Nullable java.lang.Runnable retired,
                                                                              long delay,
                                                                              long period)

Schedules a task to be run after a delay.

Parameters:

runnable - The task to run.

retired - The task to run if the entity is retired.

delay - The delay before the task is run.

period - The period between each run.

Returns:

The task that was scheduled.

runAtFixedRate

@Nullable
default <T> @Nullable TaskImplementation<T> runAtFixedRate(@NotNull
                                                                     @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                                     long delay,
                                                                     long period)

Schedules a task to be run after a delay.

Parameters:

function - The task to run.

delay - The delay before the task is run.

period - The period between each run.

Returns:

The task that was scheduled.

runAtFixedRate

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                              @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                              long delay,
                                                                              long period)

Schedules a task to be run after a delay.

Parameters:

consumer - The task to run.

delay - The delay before the task is run.

period - The period between each run.

Returns:

The task that was scheduled.

runAtFixedRate

@Nullable
default @Nullable TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                              @NotNull java.lang.Runnable runnable,
                                                                              long delay,
                                                                              long period)

Schedules a task to be run after a delay.

Parameters:

runnable - The task to run.

delay - The delay before the task is run.

period - The period between each run.

Returns:

The task that was scheduled.