Properties
acceptResourcePack
acceptResourcePack: (() => void)
activateBlock
activateBlock: ((block, direction?, cursorPos?) => Promise<void>)
Type declaration
- (block, direction?, cursorPos?): Promise<void>
Parameters
- block: Block
Optional
direction: Vec3Optional
cursorPos: Vec3
Returns Promise<void>
activateEntity
activateEntity: ((entity) => Promise<void>)
Type declaration
- (entity): Promise<void>
Returns Promise<void>
activateEntityAt
activateEntityAt: ((entity, position) => Promise<void>)
Type declaration
- (entity, position): Promise<void>
Parameters
- entity: Entity
- position: Vec3
Returns Promise<void>
activateItem
activateItem: ((offhand?) => void)
Type declaration
- (offhand?): void
Parameters
Optional
offhand: boolean
Returns void
addChatPattern
addChatPattern: ((name, pattern, options?) => number)
Type declaration
- (name, pattern, options?): number
Parameters
- name: string
- pattern: RegExp
Optional
options: chatPatternOptions
Returns number
addChatPatternSet
addChatPatternSet: ((name, patterns, options?) => number)
Type declaration
- (name, patterns, options?): number
Parameters
- name: string
- patterns: RegExp[]
Optional
options: chatPatternOptions
Returns number
attack
attack: ((entity) => void)
Type declaration
- (entity): void
Returns void
awaitMessage
awaitMessage: ((...args) => Promise<string>)
Type declaration
- (...args): Promise<string>
Parameters
Rest
...args: string[] | RegExp[]
Returns Promise<string>
blockAt
blockAt: ((point, extraInfos?) => null | Block)
Type declaration
- (point, extraInfos?): null | Block
Parameters
- point: Vec3
Optional
extraInfos: boolean
Returns null | Block
blockAtCursor
blockAtCursor: ((maxDistance?, matcher?) => null | Block)
Type declaration
- (maxDistance?, matcher?): null | Block
Parameters
Optional
maxDistance: numberOptional
matcher: Function
Returns null | Block
blockAtEntityCursor
blockAtEntityCursor: ((entity?, maxDistance?, matcher?) => null | Block)
Type declaration
- (entity?, maxDistance?, matcher?): null | Block
Parameters
Optional
entity: EntityOptional
maxDistance: numberOptional
matcher: Function
Returns null | Block
blockInSight
blockInSight: ((maxSteps, vectorLength) => null | Block)
Type declaration
- (maxSteps, vectorLength): null | Block
Parameters
- maxSteps: number
- vectorLength: number
Returns null | Block
canDigBlock
canDigBlock: ((block) => boolean)
Type declaration
- (block): boolean
Returns boolean
canSeeBlock
canSeeBlock: ((block) => boolean)
Type declaration
- (block): boolean
Returns boolean
chat
chat: ((message) => void)
Type declaration
- (message): void
Returns void
chatAddPattern
chatAddPattern: ((pattern, chatType, description?) => number)
Type declaration
- (pattern, chatType, description?): number
Parameters
- pattern: RegExp
- chatType: string
Optional
description: string
Returns number
chatPatterns
chatPatterns: ChatPattern[]
clearControlStates
clearControlStates: (() => void)
clickWindow
clickWindow: ((slot, mouseButton, mode) => Promise<void>)
Type declaration
- (slot, mouseButton, mode): Promise<void>
Parameters
- slot: number
- mouseButton: number
- mode: number
Returns Promise<void>
closeWindow
closeWindow: ((window) => void)
Type declaration
- (window): void
Returns void
connect
connect: ((options) => void)
Type declaration
- (options): void
Returns void
consume
consume: (() => Promise<void>)
Type declaration
- (): Promise<void>
Returns Promise<void>
controlState
controlState: ControlStateStatus
craft
craft: ((recipe, count?, craftingTable?) => Promise<void>)
Type declaration
- (recipe, count?, craftingTable?): Promise<void>
Parameters
- recipe: Recipe
Optional
count: numberOptional
craftingTable: Block
Returns Promise<void>
creative
creative: creativeMethods
currentWindow
currentWindow: null | Window<unknown>
deactivateItem
deactivateItem: (() => void)
denyResourcePack
denyResourcePack: (() => void)
dig
dig: ((block, forceLook?) => Promise<void>) & ((block, forceLook, digFace) => Promise<void>)
Type declaration
- (block, forceLook?): Promise<void>
Parameters
- block: Block
Optional
forceLook: boolean | "ignore"
Returns Promise<void>
Type declaration
- (block, forceLook, digFace): Promise<void>
Parameters
- block: Block
- forceLook: boolean | "ignore"
- digFace: Vec3 | "auto" | "raycast"
Returns Promise<void>
digTime
digTime: ((block) => number)
Type declaration
- (block): number
Returns number
dismount
dismount: (() => void)
elytraFly
elytraFly: (() => Promise<void>)
Type declaration
- (): Promise<void>
Returns Promise<void>
end
end: ((reason?) => void)
Type declaration
- (reason?): void
Returns void
entities
entities: {
[id: string]: Entity;
}
entityAtCursor
entityAtCursor: ((maxDistance?) => null | Entity)
Type declaration
- (maxDistance?): null | Entity
Parameters
Optional
maxDistance: number
Returns null | Entity
equip
equip: ((item, destination) => Promise<void>)
Type declaration
- (item, destination): Promise<void>
Parameters
- item: number | Item
- destination: null | EquipmentDestination
Returns Promise<void>
experience
experience: Experience
findBlock
findBlock: ((options) => null | Block)
Type declaration
- (options): null | Block
Parameters
- options: FindBlockOptions
Returns null | Block
findBlocks
findBlocks: ((options) => Vec3[])
Type declaration
- (options): Vec3[]
Parameters
- options: FindBlockOptions
Returns Vec3[]
fireworkRocketDuration
fireworkRocketDuration: number
fish
fish: (() => Promise<void>)
Type declaration
- (): Promise<void>
Returns Promise<void>
food
food: number
foodSaturation
foodSaturation: number
game
game: GameState
getControlState
getControlState: ((control) => boolean)
Type declaration
- (control): boolean
Returns boolean
getEquipmentDestSlot
getEquipmentDestSlot: ((destination) => number)
Type declaration
- (destination): number
Returns number
getExplosionDamages
getExplosionDamages: ((targetEntity, position, radius, rawDamages?) => null | number)
Type declaration
- (targetEntity, position, radius, rawDamages?): null | number
Parameters
- targetEntity: Entity
- position: Vec3
- radius: number
Optional
rawDamages: boolean
Returns null | number
hasPlugin
hasPlugin: ((plugin) => boolean)
Type declaration
- (plugin): boolean
Returns boolean
heldItem
heldItem: null | Item
inventory
inventory: Window<StorageEvents>
isABed
isABed: ((bedBlock) => boolean)
Type declaration
- (bedBlock): boolean
Returns boolean
isRaining
isRaining: boolean
isSleeping
isSleeping: boolean
loadPlugin
loadPlugin: ((plugin) => void)
Type declaration
- (plugin): void
Returns void
loadPlugins
loadPlugins: ((plugins) => void)
Type declaration
- (plugins): void
Returns void
look
look: ((yaw, pitch, force?) => Promise<void>)
Type declaration
- (yaw, pitch, force?): Promise<void>
Parameters
- yaw: number
- pitch: number
Optional
force: boolean
Returns Promise<void>
lookAt
lookAt: ((point, force?) => Promise<void>)
Type declaration
- (point, force?): Promise<void>
Parameters
- point: Vec3
Optional
force: boolean
Returns Promise<void>
majorVersion
majorVersion: string
mount
mount: ((entity) => void)
Type declaration
- (entity): void
Returns void
moveSlotItem
moveSlotItem: ((sourceSlot, destSlot) => Promise<void>)
Type declaration
- (sourceSlot, destSlot): Promise<void>
Parameters
- sourceSlot: number
- destSlot: number
Returns Promise<void>
moveVehicle
moveVehicle: ((left, forward) => void)
Type declaration
- (left, forward): void
Parameters
- left: number
- forward: number
Returns void
nearestEntity
nearestEntity: ((filter?) => null | Entity)
Type declaration
- (filter?): null | Entity
Parameters
Optional
filter: ((entity) => boolean)- (entity): boolean
Returns boolean
Returns null | Entity
openAnvil
openAnvil: ((anvil) => Promise<Anvil>)
Type declaration
- (anvil): Promise<Anvil>
Returns Promise<Anvil>
openBlock
openBlock: ((block, direction?, cursorPos?) => Promise<Window<unknown>>)
Type declaration
- (block, direction?, cursorPos?): Promise<Window<unknown>>
Parameters
- block: Block
Optional
direction: Vec3Optional
cursorPos: Vec3
Returns Promise<Window<unknown>>
openChest
openChest: ((chest, direction?, cursorPos?) => Promise<Chest>)
Type declaration
- (chest, direction?, cursorPos?): Promise<Chest>
Parameters
- chest: Entity | Block
Optional
direction: numberOptional
cursorPos: Vec3
Returns Promise<Chest>
openContainer
openContainer: ((chest, direction?, cursorPos?) => Promise<Chest | Dispenser>)
Type declaration
- (chest, direction?, cursorPos?): Promise<Chest | Dispenser>
Parameters
- chest: Entity | Block
Optional
direction: Vec3Optional
cursorPos: Vec3
Returns Promise<Chest | Dispenser>
openDispenser
openDispenser: ((dispenser) => Promise<Dispenser>)
Type declaration
- (dispenser): Promise<Dispenser>
Returns Promise<Dispenser>
openEnchantmentTable
openEnchantmentTable: ((enchantmentTable) => Promise<EnchantmentTable>)
Type declaration
- (enchantmentTable): Promise<EnchantmentTable>
Returns Promise<EnchantmentTable>
openEntity
openEntity: ((block, Class) => Promise<Window<unknown>>)
Type declaration
- (block, Class): Promise<Window<unknown>>
Parameters
- block: Entity
- Class: (new () => EventEmitter<DefaultEventMap>)
- new (): EventEmitter<DefaultEventMap>
Returns EventEmitter<DefaultEventMap>
Returns Promise<Window<unknown>>
openFurnace
openFurnace: ((furnace) => Promise<Furnace>)
Type declaration
- (furnace): Promise<Furnace>
Returns Promise<Furnace>
openVillager
openVillager: ((villager) => Promise<Villager>)
Type declaration
- (villager): Promise<Villager>
Returns Promise<Villager>
oxygenLevel
oxygenLevel: number
physics
physics: PhysicsOptions
physicsEnabled
physicsEnabled: boolean
placeBlock
placeBlock: ((referenceBlock, faceVector) => Promise<void>)
Type declaration
- (referenceBlock, faceVector): Promise<void>
Parameters
- referenceBlock: Block
- faceVector: Vec3
Returns Promise<void>
placeEntity
placeEntity: ((referenceBlock, faceVector) => Promise<Entity>)
Type declaration
- (referenceBlock, faceVector): Promise<Entity>
Parameters
- referenceBlock: Block
- faceVector: Vec3
Returns Promise<Entity>
players
players: {
[username: string]: Player;
}
Type declaration
[username: string]: Player
protocolVersion
protocolVersion: string
putAway
putAway: ((slot) => Promise<void>)
Type declaration
- (slot): Promise<void>
Returns Promise<void>
putSelectedItemRange
putSelectedItemRange: ((start, end, window, slot) => Promise<void>)
Type declaration
- (start, end, window, slot): Promise<void>
Parameters
- start: number
- end: number
- window: Window<unknown>
- slot: any
Returns Promise<void>
quickBarSlot
quickBarSlot: number
quit
quit: ((reason?) => void)
Type declaration
- (reason?): void
Returns void
recipesAll
recipesAll: ((itemType, metadata, craftingTable) => Recipe[])
Type declaration
- (itemType, metadata, craftingTable): Recipe[]
Parameters
- itemType: number
- metadata: null | number
- craftingTable: null | boolean | Block
Returns Recipe[]
recipesFor
recipesFor: ((itemType, metadata, minResultCount, craftingTable) => Recipe[])
Type declaration
- (itemType, metadata, minResultCount, craftingTable): Recipe[]
Parameters
- itemType: number
- metadata: null | number
- minResultCount: null | number
- craftingTable: null | boolean | Block
Returns Recipe[]
registry
registry: Registry
removeChatPattern
removeChatPattern: ((name) => void)
respawn
respawn: (() => void)
scoreboard
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;
}
Type declaration
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
scoreboards: {
[name: string]: ScoreBoard;
}
Type declaration
[name: string]: ScoreBoard
setCommandBlock
setCommandBlock: ((pos, command, trackOutput) => void)
Type declaration
- (pos, command, trackOutput): void
Parameters
- pos: Vec3
- command: string
- trackOutput: boolean
Returns void
setControlState
setControlState: ((control, state) => void)
Type declaration
- (control, state): void
Parameters
- control: ControlState
- state: boolean
Returns void
setQuickBarSlot
setQuickBarSlot: ((slot) => void)
setSettings
setSettings: ((options) => void)
Type declaration
- (options): void
Parameters
- options: Partial<GameSettings>
Returns void
settings
settings: GameSettings
simpleClick
simpleClick: simpleClick
sleep
sleep: ((bedBlock) => Promise<void>)
Type declaration
- (bedBlock): Promise<void>
Returns Promise<void>
spawnPoint
spawnPoint: Vec3
stopDigging
stopDigging: (() => void)
supportFeature
supportFeature: (<T>(key) => SupportsFeature[T]) Type declaration
- <T>(key): SupportsFeature[T]
Type Parameters
- T extends keyof SupportsFeature
Returns SupportsFeature[T]
swingArm
swingArm: ((hand, showHand?) => void)
Type declaration
- (hand, showHand?): void
Parameters
- hand: undefined | "left" | "right"
Optional
showHand: boolean
Returns void
tabComplete
tabComplete: ((str, assumeCommand?, sendBlockInSight?, timeout?) => Promise<string[]>)
Type declaration
- (str, assumeCommand?, sendBlockInSight?, timeout?): Promise<string[]>
Parameters
- str: string
Optional
assumeCommand: booleanOptional
sendBlockInSight: booleanOptional
timeout: number
Returns Promise<string[]>
targetDigBlock
targetDigBlock: Block
teamMap
teamMap: {
[name: string]: Team;
}
teams
teams: {
[name: string]: Team;
}
thunderState
thunderState: number
time
time: Time
toss
toss: ((itemType, metadata, count) => Promise<void>)
Type declaration
- (itemType, metadata, count): Promise<void>
Parameters
- itemType: number
- metadata: null | number
- count: null | number
Returns Promise<void>
tossStack
tossStack: ((item) => Promise<void>)
Type declaration
- (item): Promise<void>
Returns Promise<void>
trade
trade: ((villagerInstance, tradeIndex, times?) => Promise<void>)
Type declaration
- (villagerInstance, tradeIndex, times?): Promise<void>
Parameters
- villagerInstance: Villager
- tradeIndex: string | number
Optional
times: number
Returns Promise<void>
transfer
transfer: ((options) => Promise<void>)
Type declaration
- (options): Promise<void>
Returns Promise<void>
unequip
unequip: ((destination) => Promise<void>)
Type declaration
- (destination): Promise<void>
Parameters
- destination: null | EquipmentDestination
Returns Promise<void>
updateHeldItem
updateHeldItem: (() => void)
updateSign
updateSign: ((block, text, back?) => void)
Type declaration
- (block, text, back?): void
Parameters
- block: Block
- text: string
Optional
back: boolean
Returns void
useOn
useOn: ((targetEntity) => void)
Type declaration
- (targetEntity): void
Returns void
usingHeldItem
usingHeldItem: boolean
waitForChunksToLoad
waitForChunksToLoad: (() => Promise<void>)
Type declaration
- (): Promise<void>
Returns Promise<void>
waitForTicks
waitForTicks: ((ticks) => Promise<void>)
Type declaration
- (ticks): Promise<void>
Returns Promise<void>
wake
wake: (() => Promise<void>)
Type declaration
- (): Promise<void>
Returns Promise<void>
whisper
whisper: ((username, message) => void)
Type declaration
- (username, message): void
Parameters
- username: string
- message: string
Returns void
world
world: WorldSync
writeBook
writeBook: ((slot, pages) => Promise<void>)
Type declaration
- (slot, pages): Promise<void>
Parameters
- slot: number
- pages: string[]
Returns Promise<void>
The bot's BotSwarmData.