Package com.valhalla.sdk.api.util

Class Sleep

java.lang.Object
com.valhalla.sdk.api.util.Sleep
public final class Sleep extends Object
Interrupt-aware sleeps and bounded condition polling for script threads.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    GAME_TICK_MILLIS
    Nominal OSRS server-tick duration in milliseconds.

  • Method Summary

    Modifier and Type
    Method
    Description
    static long
    getDefaultPoll()
    Returns the default condition-poll interval in milliseconds.
    static void
    setDefaultPoll(long pollingMillis)
    Changes the default condition-poll interval.
    static boolean
    sleep(long milliseconds)
    Blocks the current script thread for a fixed duration.
    static boolean
    sleep(long minimumMillis, long maximumMillis)
    Blocks for a uniformly randomized inclusive duration.
    static boolean
    sleepTick()
    Returns whether sleeping for one nominal game tick completed.
    static boolean
    sleepTicks(int ticks)
    Sleeps for an exact number of nominal game ticks.
    static boolean
    sleepUntil(Condition condition, long timeoutMillis)
    Compatibility alias for until(Condition, long).
    static boolean
    sleepUntil(Condition condition, long timeoutMillis, long pollMillis)
    Compatibility alias for until(Condition, long, long).
    static boolean
    sleepUntil(Condition condition, Condition resetCondition, long timeoutMillis, long pollMillis)
    Polls for success while allowing an external condition to reset the timeout.
    static boolean
    sleepUntil(Condition condition, Condition resetCondition, long timeoutMillis, long pollMillis, int successfulPolls)
    Polls for consecutive successes while allowing timeout resets.
    static boolean
    sleepWhile(Condition condition, long timeoutMillis)
    Compatibility alias that waits for a condition to become false.
    static boolean
    sleepWhile(Condition condition, long timeoutMillis, long pollMillis)
    Compatibility alias that waits for a condition to become false.
    static boolean
    sleepWhile(Condition condition, Condition resetCondition, long timeoutMillis, long pollMillis)
    Waits for a condition to become false while allowing timeout resets.
    static boolean
    until(Condition condition, long timeoutMillis)
    Polls until a condition becomes true or a timeout expires.
    static boolean
    until(Condition condition, long timeoutMillis, long pollMillis)
    Polls until a condition becomes true or a timeout expires.
    static boolean
    whileCondition(Condition condition, long timeoutMillis)
    Polls until a condition becomes false or a timeout expires.
    static boolean
    whileCondition(Condition condition, long timeoutMillis, long pollMillis)
    Polls until a condition becomes false or a timeout expires.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • GAME_TICK_MILLIS

      public static final long GAME_TICK_MILLIS
      Nominal OSRS server-tick duration in milliseconds.
      See Also:

  • Method Details

    • getDefaultPoll

      public static long getDefaultPoll()
      Returns the default condition-poll interval in milliseconds.
      Returns:
      the default condition-poll interval in milliseconds

    • setDefaultPoll

      public static void setDefaultPoll(long pollingMillis)
      Changes the default condition-poll interval.
      Parameters:
      pollingMillis - positive poll interval in milliseconds

    • sleep

      public static boolean sleep(long milliseconds)
      Blocks the current script thread for a fixed duration.
      Parameters:
      milliseconds - non-negative sleep duration
      Returns:
      true when the full sleep completed; false when interrupted

    • sleep

      public static boolean sleep(long minimumMillis, long maximumMillis)
      Blocks for a uniformly randomized inclusive duration.
      Parameters:
      minimumMillis - inclusive non-negative minimum
      maximumMillis - inclusive maximum
      Returns:
      true when the full sleep completed; false when interrupted

    • until

      public static boolean until(Condition condition, long timeoutMillis)
      Polls until a condition becomes true or a timeout expires.
      Parameters:
      condition - completion condition
      timeoutMillis - non-negative timeout
      Returns:
      true when the condition succeeded

    • until

      public static boolean until(Condition condition, long timeoutMillis, long pollMillis)
      Polls until a condition becomes true or a timeout expires.
      Parameters:
      condition - completion condition
      timeoutMillis - non-negative timeout
      pollMillis - positive poll interval
      Returns:
      true when the condition succeeded

    • whileCondition

      public static boolean whileCondition(Condition condition, long timeoutMillis)
      Polls until a condition becomes false or a timeout expires.
      Parameters:
      condition - condition that should become false
      timeoutMillis - non-negative timeout
      Returns:
      true when the condition became false

    • whileCondition

      public static boolean whileCondition(Condition condition, long timeoutMillis, long pollMillis)
      Polls until a condition becomes false or a timeout expires.
      Parameters:
      condition - condition that should become false
      timeoutMillis - non-negative timeout
      pollMillis - positive poll interval
      Returns:
      true when the condition became false

    • sleepUntil

      public static boolean sleepUntil(Condition condition, long timeoutMillis)
      Compatibility alias for until(Condition, long).
      Parameters:
      condition - completion condition
      timeoutMillis - non-negative timeout
      Returns:
      true when the condition succeeded

    • sleepUntil

      public static boolean sleepUntil(Condition condition, long timeoutMillis, long pollMillis)
      Compatibility alias for until(Condition, long, long).
      Parameters:
      condition - completion condition
      timeoutMillis - non-negative timeout
      pollMillis - positive poll interval
      Returns:
      true when the condition succeeded

    • sleepUntil

      public static boolean sleepUntil(Condition condition, Condition resetCondition, long timeoutMillis, long pollMillis)
      Polls for success while allowing an external condition to reset the timeout.
      Parameters:
      condition - completion condition
      resetCondition - condition that restarts the timeout window
      timeoutMillis - timeout window in milliseconds
      pollMillis - positive poll interval
      Returns:
      true when the completion condition succeeded

    • sleepUntil

      public static boolean sleepUntil(Condition condition, Condition resetCondition, long timeoutMillis, long pollMillis, int successfulPolls)
      Polls for consecutive successes while allowing timeout resets.
      Parameters:
      condition - completion condition
      resetCondition - condition that restarts the timeout window
      timeoutMillis - timeout window in milliseconds
      pollMillis - positive poll interval
      successfulPolls - required consecutive successful polls
      Returns:
      true after the requested consecutive successes

    • sleepWhile

      public static boolean sleepWhile(Condition condition, long timeoutMillis)
      Compatibility alias that waits for a condition to become false.
      Parameters:
      condition - condition that should become false
      timeoutMillis - non-negative timeout
      Returns:
      true when the condition became false

    • sleepWhile

      public static boolean sleepWhile(Condition condition, long timeoutMillis, long pollMillis)
      Compatibility alias that waits for a condition to become false.
      Parameters:
      condition - condition that should become false
      timeoutMillis - non-negative timeout
      pollMillis - positive poll interval
      Returns:
      true when the condition became false

    • sleepWhile

      public static boolean sleepWhile(Condition condition, Condition resetCondition, long timeoutMillis, long pollMillis)
      Waits for a condition to become false while allowing timeout resets.
      Parameters:
      condition - condition that should become false
      resetCondition - condition that restarts the timeout window
      timeoutMillis - timeout window in milliseconds
      pollMillis - positive poll interval
      Returns:
      true when the condition became false

    • sleepTick

      public static boolean sleepTick()
      Returns whether sleeping for one nominal game tick completed.
      Returns:
      whether sleeping for one nominal game tick completed

    • sleepTicks

      public static boolean sleepTicks(int ticks)
      Sleeps for an exact number of nominal game ticks.
      Parameters:
      ticks - non-negative tick count
      Returns:
      true when the full sleep completed