mineflayer-swarm
    Preparing search index...

    Interface SwarmBot

    interface SwarmBot {
        _client: Client;
        acceptResourcePack: () => void;
        activateBlock: (
            block: Block,
            direction?: Vec3,
            cursorPos?: Vec3,
        ) => Promise<void>;
        activateEntity: (entity: Entity) => Promise<void>;
        activateEntityAt: (entity: Entity, position: Vec3) => Promise<void>;
        activateItem: (offhand?: boolean) => void;
        addChatPattern: (
            name: string,
            pattern: RegExp,
            options?: chatPatternOptions,
        ) => number;
        addChatPatternSet: (
            name: string,
            patterns: RegExp[],
            options?: chatPatternOptions,
        ) => number;
        attack: (entity: Entity) => void;
        awaitMessage: (...args: string[] | RegExp[]) => Promise<string>;
        blockAt: (point: Vec3, extraInfos?: boolean) => null | Block;
        blockAtCursor: (maxDistance?: number, matcher?: Function) => null | Block;
        blockAtEntityCursor: (
            entity?: Entity,
            maxDistance?: number,
            matcher?: Function,
        ) => null | Block;
        blockInSight: (maxSteps: number, vectorLength: number) => null | Block;
        canDigBlock: (block: Block) => boolean;
        canSeeBlock: (block: Block) => boolean;
        chat: (message: string) => void;
        chatAddPattern: (
            pattern: RegExp,
            chatType: string,
            description?: string,
        ) => number;
        chatPatterns: ChatPattern[];
        clearControlStates: () => void;
        clickWindow: (
            slot: number,
            mouseButton: number,
            mode: number,
        ) => Promise<void>;
        closeWindow: (window: Window) => void;
        connect: (options: BotOptions) => void;
        consume: () => Promise<void>;
        controlState: ControlStateStatus;
        craft: (
            recipe: Recipe,
            count?: number,
            craftingTable?: Block,
        ) => Promise<void>;
        creative: creativeMethods;
        currentWindow: null | Window<unknown>;
        deactivateItem: () => void;
        denyResourcePack: () => void;
        dig: (block: Block, forceLook?: boolean | "ignore") => Promise<void> & (
            block: Block,
            forceLook: boolean | "ignore",
            digFace: Vec3 | "auto" | "raycast",
        ) => Promise<void>;
        digTime: (block: Block) => number;
        dismount: () => void;
        elytraFly: () => Promise<void>;
        end: (reason?: string) => void;
        entities: { [id: string]: Entity };
        entity: Entity;
        entityAtCursor: (maxDistance?: number) => null | Entity;
        equip: (
            item: number | Item,
            destination: null | EquipmentDestination,
        ) => Promise<void>;
        experience: Experience;
        findBlock: (options: FindBlockOptions) => null | Block;
        findBlocks: (options: FindBlockOptions) => Vec3[];
        fireworkRocketDuration: number;
        fish: () => Promise<void>;
        food: number;
        foodSaturation: number;
        game: GameState;
        getControlState: (control: ControlState) => boolean;
        getEquipmentDestSlot: (destination: string) => number;
        getExplosionDamages: (
            targetEntity: Entity,
            position: Vec3,
            radius: number,
            rawDamages?: boolean,
        ) => null | number;
        hasPlugin: (plugin: Plugin) => boolean;
        health: number;
        heldItem: null | Item;
        inventory: Window<StorageEvents>;
        isABed: (bedBlock: Block) => boolean;
        isRaining: boolean;
        isSleeping: boolean;
        loadPlugin: (plugin: Plugin) => void;
        loadPlugins: (plugins: Plugin[]) => void;
        look: (yaw: number, pitch: number, force?: boolean) => Promise<void>;
        lookAt: (point: Vec3, force?: boolean) => Promise<void>;
        majorVersion: string;
        mount: (entity: Entity) => void;
        moveSlotItem: (sourceSlot: number, destSlot: number) => Promise<void>;
        moveVehicle: (left: number, forward: number) => void;
        nearestEntity: (filter?: (entity: Entity) => boolean) => null | Entity;
        openAnvil: (anvil: Block) => Promise<Anvil>;
        openBlock: (
            block: Block,
            direction?: Vec3,
            cursorPos?: Vec3,
        ) => Promise<Window<unknown>>;
        openChest: (
            chest: Entity | Block,
            direction?: number,
            cursorPos?: Vec3,
        ) => Promise<Chest>;
        openContainer: (
            chest: Entity | Block,
            direction?: Vec3,
            cursorPos?: Vec3,
        ) => Promise<Chest | Dispenser>;
        openDispenser: (dispenser: Block) => Promise<Dispenser>;
        openEnchantmentTable: (
            enchantmentTable: Block,
        ) => Promise<EnchantmentTable>;
        openEntity: (
            block: Entity,
            Class: new () => EventEmitter,
        ) => Promise<Window<unknown>>;
        openFurnace: (furnace: Block) => Promise<Furnace>;
        openVillager: (villager: Entity) => Promise<Villager>;
        oxygenLevel: number;
        physics: PhysicsOptions;
        physicsEnabled: boolean;
        placeBlock: (referenceBlock: Block, faceVector: Vec3) => Promise<void>;
        placeEntity: (referenceBlock: Block, faceVector: Vec3) => Promise<Entity>;
        player: Player;
        players: { [username: string]: Player };
        protocolVersion: string;
        putAway: (slot: number) => Promise<void>;
        putSelectedItemRange: (
            start: number,
            end: number,
            window: Window,
            slot: any,
        ) => Promise<void>;
        quickBarSlot: number;
        quit: (reason?: string) => void;
        recipesAll: (
            itemType: number,
            metadata: null | number,
            craftingTable: null | boolean | Block,
        ) => Recipe[];
        recipesFor: (
            itemType: number,
            metadata: null | number,
            minResultCount: null | number,
            craftingTable: null | boolean | Block,
        ) => Recipe[];
        registry: Registry;
        removeChatPattern: (name: string | number) => void;
        respawn: () => void;
        scoreboard: {
            "10": ScoreBoard;
            "11": ScoreBoard;
            "12": ScoreBoard;
            "13": ScoreBoard;
            "14": ScoreBoard;
            "15": ScoreBoard;
            "16": ScoreBoard;
            "17": ScoreBoard;
            "18": ScoreBoard;
            "3": ScoreBoard;
            "4": ScoreBoard;
            "5": ScoreBoard;
            "6": ScoreBoard;
            "7": ScoreBoard;
            "8": ScoreBoard;
            "9": ScoreBoard;
            belowName: ScoreBoard;
            list: ScoreBoard;
            sidebar: ScoreBoard;
        };
        scoreboards: { [name: string]: ScoreBoard };
        setCommandBlock: (
            pos: Vec3,
            command: string,
            options: CommandBlockOptions,
        ) => void;
        setControlState: (control: ControlState, state: boolean) => void;
        setQuickBarSlot: (slot: number) => void;
        setSettings: (options: Partial<GameSettings>) => void;
        settings: GameSettings;
        simpleClick: simpleClick;
        sleep: (bedBlock: Block) => Promise<void>;
        spawnPoint: Vec3;
        stopDigging: () => void;
        supportFeature: <T extends keyof SupportsFeature>(
            key: T,
        ) => SupportsFeature[T];
        swarmOptions?: BotSwarmData;
        swingArm: (hand: undefined | "left" | "right", showHand?: boolean) => void;
        tabComplete: (
            str: string,
            assumeCommand?: boolean,
            sendBlockInSight?: boolean,
            timeout?: number,
        ) => Promise<string[]>;
        tablist: Tablist;
        targetDigBlock: Block;
        teamMap: { [name: string]: Team };
        teams: { [name: string]: Team };
        thunderState: number;
        time: Time;
        toss: (
            itemType: number,
            metadata: null | number,
            count: null | number,
        ) => Promise<void>;
        tossStack: (item: Item) => Promise<void>;
        trade: (
            villagerInstance: Villager,
            tradeIndex: string | number,
            times?: number,
        ) => Promise<void>;
        transfer: (options: TransferOptions) => Promise<void>;
        unequip: (destination: null | EquipmentDestination) => Promise<void>;
        updateHeldItem: () => void;
        updateSign: (block: Block, text: string, back?: boolean) => void;
        useOn: (targetEntity: Entity) => void;
        username: string;
        usingHeldItem: boolean;
        version: string;
        waitForChunksToLoad: () => Promise<void>;
        waitForTicks: (ticks: number) => Promise<void>;
        wake: () => Promise<void>;
        whisper: (username: string, message: string) => void;
        world: WorldSync;
        writeBook: (slot: number, pages: string[]) => Promise<void>;
        addListener<E extends keyof BotEvents>(
            event: E,
            listener: BotEvents[E],
        ): this;
        emit<E extends keyof BotEvents>(
            event: E,
            ...args: Arguments<BotEvents[E]>,
        ): boolean;
        eventNames(): (string | symbol)[];
        getMaxListeners(): number;
        listenerCount<E extends keyof BotEvents>(event: E): number;
        listeners<E extends keyof BotEvents>(event: E): Function[];
        off<E extends keyof BotEvents>(event: E, listener: BotEvents[E]): this;
        on<E extends keyof BotEvents>(event: E, listener: BotEvents[E]): this;
        once<E extends keyof BotEvents>(event: E, listener: BotEvents[E]): this;
        prependListener<E extends keyof BotEvents>(
            event: E,
            listener: BotEvents[E],
        ): this;
        prependOnceListener<E extends keyof BotEvents>(
            event: E,
            listener: BotEvents[E],
        ): this;
        rawListeners<E extends keyof BotEvents>(event: E): Function[];
        removeAllListeners<E extends keyof BotEvents>(event?: E): this;
        removeListener<E extends keyof BotEvents>(
            event: E,
            listener: BotEvents[E],
        ): this;
        setMaxListeners(maxListeners: number): this;
    }

    Hierarchy

    • Bot
      • SwarmBot
    Index

    Properties

    Methods

    Properties

    _client: Client
    acceptResourcePack: () => void
    activateBlock: (
        block: Block,
        direction?: Vec3,
        cursorPos?: Vec3,
    ) => Promise<void>
    activateEntity: (entity: Entity) => Promise<void>
    activateEntityAt: (entity: Entity, position: Vec3) => Promise<void>
    activateItem: (offhand?: boolean) => void
    addChatPattern: (
        name: string,
        pattern: RegExp,
        options?: chatPatternOptions,
    ) => number
    addChatPatternSet: (
        name: string,
        patterns: RegExp[],
        options?: chatPatternOptions,
    ) => number
    attack: (entity: Entity) => void
    awaitMessage: (...args: string[] | RegExp[]) => Promise<string>
    blockAt: (point: Vec3, extraInfos?: boolean) => null | Block
    blockAtCursor: (maxDistance?: number, matcher?: Function) => null | Block
    blockAtEntityCursor: (
        entity?: Entity,
        maxDistance?: number,
        matcher?: Function,
    ) => null | Block
    blockInSight: (maxSteps: number, vectorLength: number) => null | Block
    canDigBlock: (block: Block) => boolean
    canSeeBlock: (block: Block) => boolean
    chat: (message: string) => void
    chatAddPattern: (
        pattern: RegExp,
        chatType: string,
        description?: string,
    ) => number
    chatPatterns: ChatPattern[]
    clearControlStates: () => void
    clickWindow: (slot: number, mouseButton: number, mode: number) => Promise<void>
    closeWindow: (window: Window) => void
    connect: (options: BotOptions) => void
    consume: () => Promise<void>
    controlState: ControlStateStatus
    craft: (recipe: Recipe, count?: number, craftingTable?: Block) => Promise<void>
    creative: creativeMethods
    currentWindow: null | Window<unknown>
    deactivateItem: () => void
    denyResourcePack: () => void
    dig: (block: Block, forceLook?: boolean | "ignore") => Promise<void> & (
        block: Block,
        forceLook: boolean | "ignore",
        digFace: Vec3 | "auto" | "raycast",
    ) => Promise<void>
    digTime: (block: Block) => number
    dismount: () => void
    elytraFly: () => Promise<void>
    end: (reason?: string) => void
    entities: { [id: string]: Entity }
    entity: Entity
    entityAtCursor: (maxDistance?: number) => null | Entity
    equip: (
        item: number | Item,
        destination: null | EquipmentDestination,
    ) => Promise<void>
    experience: Experience
    findBlock: (options: FindBlockOptions) => null | Block
    findBlocks: (options: FindBlockOptions) => Vec3[]
    fireworkRocketDuration: number
    fish: () => Promise<void>
    food: number
    foodSaturation: number
    game: GameState
    getControlState: (control: ControlState) => boolean
    getEquipmentDestSlot: (destination: string) => number
    getExplosionDamages: (
        targetEntity: Entity,
        position: Vec3,
        radius: number,
        rawDamages?: boolean,
    ) => null | number
    hasPlugin: (plugin: Plugin) => boolean
    health: number
    heldItem: null | Item
    inventory: Window<StorageEvents>
    isABed: (bedBlock: Block) => boolean
    isRaining: boolean
    isSleeping: boolean
    loadPlugin: (plugin: Plugin) => void
    loadPlugins: (plugins: Plugin[]) => void
    look: (yaw: number, pitch: number, force?: boolean) => Promise<void>
    lookAt: (point: Vec3, force?: boolean) => Promise<void>
    majorVersion: string
    mount: (entity: Entity) => void
    moveSlotItem: (sourceSlot: number, destSlot: number) => Promise<void>
    moveVehicle: (left: number, forward: number) => void
    nearestEntity: (filter?: (entity: Entity) => boolean) => null | Entity
    openAnvil: (anvil: Block) => Promise<Anvil>
    openBlock: (
        block: Block,
        direction?: Vec3,
        cursorPos?: Vec3,
    ) => Promise<Window<unknown>>
    openChest: (
        chest: Entity | Block,
        direction?: number,
        cursorPos?: Vec3,
    ) => Promise<Chest>
    openContainer: (
        chest: Entity | Block,
        direction?: Vec3,
        cursorPos?: Vec3,
    ) => Promise<Chest | Dispenser>
    openDispenser: (dispenser: Block) => Promise<Dispenser>
    openEnchantmentTable: (enchantmentTable: Block) => Promise<EnchantmentTable>
    openEntity: (
        block: Entity,
        Class: new () => EventEmitter,
    ) => Promise<Window<unknown>>
    openFurnace: (furnace: Block) => Promise<Furnace>
    openVillager: (villager: Entity) => Promise<Villager>
    oxygenLevel: number
    physics: PhysicsOptions
    physicsEnabled: boolean
    placeBlock: (referenceBlock: Block, faceVector: Vec3) => Promise<void>
    placeEntity: (referenceBlock: Block, faceVector: Vec3) => Promise<Entity>
    player: Player
    players: { [username: string]: Player }
    protocolVersion: string
    putAway: (slot: number) => Promise<void>
    putSelectedItemRange: (
        start: number,
        end: number,
        window: Window,
        slot: any,
    ) => Promise<void>
    quickBarSlot: number
    quit: (reason?: string) => void
    recipesAll: (
        itemType: number,
        metadata: null | number,
        craftingTable: null | boolean | Block,
    ) => Recipe[]
    recipesFor: (
        itemType: number,
        metadata: null | number,
        minResultCount: null | number,
        craftingTable: null | boolean | Block,
    ) => Recipe[]
    registry: Registry
    removeChatPattern: (name: string | number) => void
    respawn: () => void
    scoreboard: {
        "10": ScoreBoard;
        "11": ScoreBoard;
        "12": ScoreBoard;
        "13": ScoreBoard;
        "14": ScoreBoard;
        "15": ScoreBoard;
        "16": ScoreBoard;
        "17": ScoreBoard;
        "18": ScoreBoard;
        "3": ScoreBoard;
        "4": ScoreBoard;
        "5": ScoreBoard;
        "6": ScoreBoard;
        "7": ScoreBoard;
        "8": ScoreBoard;
        "9": ScoreBoard;
        belowName: ScoreBoard;
        list: ScoreBoard;
        sidebar: ScoreBoard;
    }
    scoreboards: { [name: string]: ScoreBoard }
    setCommandBlock: (
        pos: Vec3,
        command: string,
        options: CommandBlockOptions,
    ) => void
    setControlState: (control: ControlState, state: boolean) => void
    setQuickBarSlot: (slot: number) => void
    setSettings: (options: Partial<GameSettings>) => void
    settings: GameSettings
    simpleClick: simpleClick
    sleep: (bedBlock: Block) => Promise<void>
    spawnPoint: Vec3
    stopDigging: () => void
    supportFeature: <T extends keyof SupportsFeature>(key: T) => SupportsFeature[T]
    swarmOptions?: BotSwarmData

    The bot's BotSwarmData.

    swingArm: (hand: undefined | "left" | "right", showHand?: boolean) => void
    tabComplete: (
        str: string,
        assumeCommand?: boolean,
        sendBlockInSight?: boolean,
        timeout?: number,
    ) => Promise<string[]>
    tablist: Tablist
    targetDigBlock: Block
    teamMap: { [name: string]: Team }
    teams: { [name: string]: Team }
    thunderState: number
    time: Time
    toss: (
        itemType: number,
        metadata: null | number,
        count: null | number,
    ) => Promise<void>
    tossStack: (item: Item) => Promise<void>
    trade: (
        villagerInstance: Villager,
        tradeIndex: string | number,
        times?: number,
    ) => Promise<void>
    transfer: (options: TransferOptions) => Promise<void>
    unequip: (destination: null | EquipmentDestination) => Promise<void>
    updateHeldItem: () => void
    updateSign: (block: Block, text: string, back?: boolean) => void
    useOn: (targetEntity: Entity) => void
    username: string
    usingHeldItem: boolean
    version: string
    waitForChunksToLoad: () => Promise<void>
    waitForTicks: (ticks: number) => Promise<void>
    wake: () => Promise<void>
    whisper: (username: string, message: string) => void
    world: WorldSync
    writeBook: (slot: number, pages: string[]) => Promise<void>

    Methods

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • listener: BotEvents[E]

      Returns this

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • ...args: Arguments<BotEvents[E]>

      Returns boolean

    • Returns (string | symbol)[]

    • Returns number

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E

      Returns number

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E

      Returns Function[]

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • listener: BotEvents[E]

      Returns this

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • listener: BotEvents[E]

      Returns this

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • listener: BotEvents[E]

      Returns this

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • listener: BotEvents[E]

      Returns this

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • listener: BotEvents[E]

      Returns this

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E

      Returns Function[]

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • Optionalevent: E

      Returns this

    • Type Parameters

      • E extends keyof BotEvents

      Parameters

      • event: E
      • listener: BotEvents[E]

      Returns this

    • Parameters

      • maxListeners: number

      Returns this