yolkbot
    Preparing search index...

    Interface ADispatch

    A generic dispatch shape. You can use class CustomDispatch implements ADispatch to create your own type-safe dispatches.

    interface ADispatch {
        check(bot: BotWithGame): boolean;
        execute(bot: BotWithGame): void;
        validate(bot: BotWithGame): boolean;
    }

    Implemented by

    Index

    Methods

    • Checks if the dispatch can run at that specific second. This should eventually result true under some conditions so that the dispatch isn't postponed forever. This function runs with the game update loop every 33ms. If it returns true, execute runs immediately.

      Parameters

      Returns boolean

    • Executes the main dispatch logic. This happens once and does not output any success/failure, as any checks must run inside of check.

      Parameters

      Returns void

    • Validates initial data, usually from the constructor or are game-related. For example, if the user passes a number in the constructor that's too big or the user needs game ownership (but isn't), this would return false.

      Parameters

      Returns boolean