yolkbot
    Preparing search index...

    Class BanPlayerDispatch

    (eggforcer only) Bans a player from the game

    Implements

    Index

    Constructors

    Methods

    Constructors

    • Creates a BanPlayerDispatch

      Parameters

      • uniqueId: string

        The unique ID of the player to ban

      • duration: BanDuration

        The duration of the ban

      • reason: string = ''

        The reason for the ban (optional)

      Returns BanPlayerDispatch

    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.

      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