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

Index

Constructors

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: Partial<ClientOptions>): Swarm
Parameters
- options: Partial<ClientOptions>
Returns Swarm
Overrides EventEmitter.constructor
- Defined in src/index.ts:41

Properties

bots

bots: SwarmBot[]

options

options: Partial<ClientOptions>

plugins

plugins: Record<string, Plugin>

requirePlugin

requirePlugin: Require = ...

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

addSwarmMember

addSwarmMember(auth: AuthenticationOptions): void
Check for the presence or absence of a member with a given name.
Parameters
- auth: AuthenticationOptions
  The authentication information to create the swarm member with.
Returns void
- Defined in src/index.ts:67

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

hasPlugin

hasPlugin(name: string): 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.
- Defined in src/index.ts:126

isSwarmMember

isSwarmMember(username: string): 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.
- Defined in src/index.ts:90

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

loadPlugin

loadPlugin(name: string, plugin?: Plugin): void
Load a plugin
Parameters
- name: string
  The plugin to add.
- Optionalplugin: 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.
- Defined in src/index.ts:100

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63