yolkbot
    Preparing search index...

    Interface JoinOptions

    Options that can be passed to Bot.join

    interface JoinOptions {
        eggforcerObserve?: boolean;
        hideBadge?: boolean;
        manualUpdate?: boolean;
        noAfkKick?: boolean;
        preciseHealth?: boolean;
        skipMapLoad?: boolean;
        weapon?: GunIds;
    }
    Index

    Properties

    eggforcerObserve? hideBadge? manualUpdate? noAfkKick? preciseHealth? skipMapLoad? weapon?

    Properties

    eggforcerObserve?: boolean

    Only works on accounts signed in as eggforcers with valid permissions. Joins as a spectator and not a normal player

    hideBadge?: boolean

    Only works on accounts signed in with VIP or who have social media; hides the social media/VIP badge active on your profile

    manualUpdate?: boolean

    Forces the game to manually update.

    noAfkKick?: boolean

    Prevents the bot from getting kicked for being AFK.

    preciseHealth?: boolean

    Calculates the precise health of all players, with a performance tradeoff.

    skipMapLoad?: boolean

    Skips loading the game map. Breaks pathfinding and KoTC zone logic.

    weapon?: GunIds

    The weapon to use on join. This falls back to the account's last used weapon and then an EggK. This can be changed later in with a SaveLoadoutDispatch

    Settings

    Member Visibility

    On This Page

    Properties