Package foundry.veil.api

Interface TickTaskScheduler

All Superinterfaces:
Executor
All Known Implementing Classes:
TickTaskSchedulerImpl
public interface TickTaskScheduler extends Executor
Schedules tasks to be run on future ticks.
Since:
1.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    TickTaskScheduler.TickTask<V>
    A single task scheduled to run in the future.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(@NotNull Runnable command)
    Executes the specified command on the next particle system tick.
    static TickTaskScheduler
    get(@Nullable net.minecraft.server.MinecraftServer server)
    Retrieves the tick task scheduler for the specified server or client.
    boolean
    isShutdown()
     
    TickTaskScheduler.TickTask<?>
    schedule(@NotNull Runnable command, long delay)
    Schedules the specified command to run in the specified number of ticks.
    <V> TickTaskScheduler.TickTask<V>
    schedule(@NotNull Callable<V> callable, long delay)
    Schedules the specified command to run in the specified number of ticks.
    TickTaskScheduler.TickTask<?>
    scheduleAtFixedRate(@NotNull Runnable command, long initialDelay, long period)
    Schedules the specified command to run after the specified initial delay in ticks and at each fixed time interval in ticks.

  • Method Details

    • get

      static TickTaskScheduler get(@Nullable @Nullable net.minecraft.server.MinecraftServer server)
      Retrieves the tick task scheduler for the specified server or client.
      Parameters:
      server - The server to get the scheduler for or null for the client scheduler
      Returns:
      The scheduler for that server

    • execute

      void execute(@NotNull @NotNull Runnable command)
      Executes the specified command on the next particle system tick.
      Specified by:
      execute in interface Executor
      Parameters:
      command - The runnable task
      Throws:
      RejectedExecutionException - if the task cannot be scheduled for execution
      NullPointerException - if command is null

    • schedule

      TickTaskScheduler.TickTask<?> schedule(@NotNull @NotNull Runnable command, long delay)
      Schedules the specified command to run in the specified number of ticks.
      Parameters:
      command - The runnable task
      delay - The delay in ticks
      Returns:
      A future that completes after the task has been run
      Throws:
      RejectedExecutionException - if the task cannot be scheduled for execution
      NullPointerException - if command is null
      IllegalArgumentException - if delay less than or equal to zero

    • schedule

      <V> TickTaskScheduler.TickTask<V> schedule(@NotNull @NotNull Callable<V> callable, long delay)
      Schedules the specified command to run in the specified number of ticks.
      Parameters:
      callable - The callable task
      delay - The delay in ticks
      Returns:
      A future that completes after the task has been run
      Throws:
      RejectedExecutionException - if the task cannot be scheduled for execution
      NullPointerException - if command is null
      IllegalArgumentException - if delay less than or equal to zero

    • scheduleAtFixedRate

      TickTaskScheduler.TickTask<?> scheduleAtFixedRate(@NotNull @NotNull Runnable command, long initialDelay, long period)
      Schedules the specified command to run after the specified initial delay in ticks and at each fixed time interval in ticks.
      Parameters:
      command - The runnable task
      initialDelay - The initial delay in ticks
      period - The period between task executions
      Returns:
      A future that completes if there was an error
      Throws:
      RejectedExecutionException - if the task cannot be scheduled for execution
      NullPointerException - if command is null
      IllegalArgumentException - if delay less than or equal to zero

    • isShutdown

      boolean isShutdown()
      Returns:
      Whether the executor has shut down and will reject