Class Bot

Bots are fake players that player's can interact with.

You can do many things with them, and they even have very primitive AI capabilities.

An example of a zombie that can chase and kill players:

const zombie = new Bot("Zombie")

const outfit = new Outfit()
  .body("#0d9436")
  .torso("#694813")
  .rightLeg("#694813")
  .leftLeg("#694813")

zombie.setOutfit(outfit)

Game.newBot(zombie)

// We use bot.setinterval so that when the zombie is destroyed, the loop clears. 
// It's good practice to do this to avoid memory leaks.
zombie.setInterval(() => {
  let target = zombie.findClosestPlayer(20)

  if (!target) return zombie.setSpeech("")

  zombie.setSpeech("BRAAINNNSSS!")

  zombie.moveTowardsPlayer(target, 8)
}, 10)

let touchEvent = zombie.touching((p) => {
  Game.messageAll(`[#ff0000]${p.username} was eaten by a zombie!`)
  p.kill()
})

Hierarchy

EventEmitter
- Bot

Constructors

constructor

new Bot(name: string): Bot
Parameters
- name: string
Returns Bot
Overrides EventEmitter.constructor
- Defined in src/class/Bot.ts:85

Properties

`Private` _hitMonitor

_hitMonitor: Timer

`Private` _steps

_steps: Timeout[]

assets

assets: Assets

An object containing the current assets worn by the bot.

colors

colors: BodyColors

An object containing the body colors of the bot.

destroyed

destroyed: boolean

If .destroy() has been called on the bot.

name

name: string

netId

netId: number

position

position: Vector3 = ...

rotation

rotation: Vector3 = ...

scale

scale: Vector3 = ...

speech

speech: string = ""

The speech bubble of the bot. ("" = empty).

`Static` botId

botId: number = 0

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

`Private` _detectTouching

_detectTouching(): void
Returns void
- Defined in src/class/Bot.ts:297

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): Bot
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Bot
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:730

destroy

destroy(): Promise<never>
Remove the bot from Game.world,
clear all event listeners,
stop hit detection,
and tell clients to delete the bot.

Returns Promise<never>
- Defined in src/class/Bot.ts:146

emit

emit(event: string | symbol, ...args: any[]): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:740

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:745

findClosestPlayer

findClosestPlayer(minDist: number): Player
Returns the closest player to the bot, or null.
Parameters
- minDist: number
Returns Player
- Defined in src/class/Bot.ts:265

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:737

listenerCount

listenerCount(type: string | symbol): number
Parameters
- type: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:741

listeners

listeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:738

lookAtPlayer

lookAtPlayer(player: Player): Promise<number>
Turns the bot to face the player provided.
Parameters
- player: Player
Returns Promise<number>
- Defined in src/class/Bot.ts:241

lookAtPoint

lookAtPoint(position: Vector3): Promise<number>
Sets the bot's z rotation to the point provided.
Parameters
- position: Vector3
Returns Promise<number>
- Defined in src/class/Bot.ts:228

moveTowardsPlayer

moveTowardsPlayer(player: Player, speed: number): Promise<boolean>
Moves the bot towards the player.
Parameters
- player: Player
- speed: number
Returns Promise<boolean>
- Defined in src/class/Bot.ts:260

moveTowardsPoint

moveTowardsPoint(pos: Vector3, speed?: number): Promise<boolean>
Moves the bot to the point provided.
Parameters
- pos: Vector3
- speed: number = 5
Returns Promise<boolean>
- Defined in src/class/Bot.ts:246

off

off(event: string | symbol, listener: ((...args: any[]) => void)): Bot
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Bot
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:734

on

on(event: string | symbol, listener: ((...args: any[]) => void)): Bot
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Bot
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:731

once

once(event: string | symbol, listener: ((...args: any[]) => void)): Bot
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Bot
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:732

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): Bot
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Bot
Inherited from EventEmitter.prependListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:743

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): Bot
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Bot
Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:744

rawListeners

rawListeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.rawListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:739

removeAllListeners

removeAllListeners(event?: string | symbol): Bot
Parameters
- Optional event: string | symbol
Returns Bot
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:735

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): Bot
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Bot
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:733

setAvatar

setAvatar(userId: number): Promise<boolean>
Sets the bots avatar to a provided userId.
Parameters
- userId: number
Returns Promise<boolean>
- Defined in src/class/Bot.ts:281

setInterval

setInterval(callback: (() => void), delay: number): Timeout
Identical to setInterval, but will be cleared after the bot is destroyed. Use this if you want to attach loops to bots, but don't want to worry about clearing them after they're destroyed.
Parameters
- callback: (() => void)
  
  The callback function.
  - - (): void
    - Returns void
- delay: number
  
  The delay in milliseconds.
Returns Timeout
- Defined in src/class/Bot.ts:180

setMaxListeners

setMaxListeners(n: number): Bot
Parameters
- n: number
Returns Bot
Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/globals.d.ts:736

setOutfit

setOutfit(outfit: Outfit): Promise<any[]>
Parameters
- outfit: Outfit
Returns Promise<any[]>
- Defined in src/class/Bot.ts:212

setPosition

setPosition(position: Vector3): Promise<boolean>
Set the position of the bot.
Parameters
- position: Vector3
Returns Promise<boolean>
- Defined in src/class/Bot.ts:189

setRotation

setRotation(rotation: Vector3): Promise<boolean>
Set the rotation of the bot.
Parameters
- rotation: Vector3
Returns Promise<boolean>
- Defined in src/class/Bot.ts:195

setScale

setScale(scale: Vector3): Promise<boolean>
Set the scale of the bot.
Parameters
- scale: Vector3
Returns Promise<boolean>
- Defined in src/class/Bot.ts:201

setSpeech

setSpeech(speech: string): Promise<boolean>
Set the speech of the bot.
Parameters
- speech: string
Returns Promise<boolean>
- Defined in src/class/Bot.ts:207

touching

touching(callback: ((player: Player) => void)): Disconnectable
Starts hit detection for the bot.
Parameters
- callback: ((player: Player) => void)
  - - (player: Player): void
    - Parameters
      
      player: Player
      
      Returns void
Returns Disconnectable
- Defined in src/class/Bot.ts:287

`Static` listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number
Deprecated
since v4.0.0
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:18

`Static` on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:15

`Static` once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:13
once(emitter: DOMEventTarget, event: string): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/@types+node@12.20.55/node_modules/@types/node/events.d.ts:14

Class Bot

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

Returns Bot

Properties

Private _hitMonitor

Private _steps

assets

colors

destroyed

name

netId

position

rotation

scale

speech

Static botId

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

Private _detectTouching

Returns void

addListener

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns Bot

destroy

Returns Promise<never>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

findClosestPlayer

Parameters

minDist: number

Returns Player

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

lookAtPlayer

Parameters

player: Player

Returns Promise<number>

lookAtPoint

Parameters

position: Vector3

Returns Promise<number>

moveTowardsPlayer

Parameters

player: Player

speed: number

Returns Promise<boolean>

moveTowardsPoint

Parameters

pos: Vector3

speed: number = 5

Returns Promise<boolean>

`Private` _hitMonitor

`Private` _steps

`Static` botId

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Private` _detectTouching

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol

`Rest` ...args: any[]