Class Swarm

Represents a swarm of mineflayer bots. Bots are removed from the swarm on disconnect.

See

createSwarm to create a swarm object.

Hierarchy

  • EventEmitter
    • Swarm

Constructors

constructor

Properties

bots options plugins requirePlugin prefixed

Methods

addListener addSwarmMember emit eventNames hasPlugin isSwarmMember listenerCount listeners loadPlugin off on once removeAllListeners removeListener

Constructors

constructor

  • new Swarm(options): Swarm

  • Parameters

    • options: Partial<ClientOptions>

    Returns Swarm

Properties

bots

bots: SwarmBot[]

options

options: Partial<ClientOptions>

plugins

plugins: Record<string, Plugin>

requirePlugin

requirePlugin: NodeRequire = ...

Static prefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

addSwarmMember

  • addSwarmMember(auth): void

  • Check for the presence or absence of a member with a given name.

    Parameters

    • auth: Partial<ClientOptions>

      The authentication information to create the swarm member with.

    Returns void

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

hasPlugin

  • hasPlugin(name): boolean

  • Check for the presence or absence of a plugin with a given name.

    Parameters

    • name: string

      The plugin to query for.

    Returns boolean

    Returns true if the given plugin is loaded in the swarm, otherwise returns false.

isSwarmMember

  • isSwarmMember(username): boolean

  • Check for the presence or absence of a member with a given name.

    Parameters

    • username: string

      The username to query for.

    Returns boolean

    Returns true if the given username is contained in the swarm, otherwise returns false.

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args) => void)[]

loadPlugin

  • loadPlugin(name, plugin?): void

  • Load a plugin

    Parameters

    • name: string

      The plugin to add.

    • Optional plugin: Plugin

      DEPRECATED OPTION. WILL BE REMOVED IN A FUTURE RELEASE.

    Returns void

    Returns true if the given plugin is loaded in the swarm, otherwise returns false.

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

Settings

Member Visibility

Theme

On This Page

constructorbotsoptionspluginsrequirePluginprefixedaddListeneraddSwarmMemberemiteventNameshasPluginisSwarmMemberlistenerCountlistenersloadPluginoffononceremoveAllListenersremoveListener