FilterFunctions

src/filterFunctions.ts

Entity filtering helpers centered around Mineflayer's nearest-entity lookup. This module is useful when you want to pick targets, ignore your own bots, or search for a specific class of entities.

State

Property	Type	Purpose
`specificNames`	`string[]`	Allowed player names for named-target filtering.
`botNames`	`string[]`	Names that should be excluded when looking for non-bot players.

Methods

Method	Returns	Description
`addBotName(name)`	`void`	Adds a bot name to the exclusion list.
`getNearestEntity(func, ...args)`	`Entity \| null`	Returns the nearest entity that passes the provided predicate.
`static getNearestEntity(bot, func, ...args)`	`Entity \| null`	Static version of the nearest-entity lookup.
`allButOtherBotsFilter()`	`Entity \| null`	Finds the nearest player whose username is not in `botNames`.
`static allButOtherBotsFilter(bot, ...names)`	`Entity \| null`	Static helper for the same bot-exclusion lookup.
`specificNamesFilter()`	`Entity \| null`	Finds the nearest player whose username is in `specificNames`.
`static specificNamesFilter(bot, ...names)`	`Entity \| null`	Static helper for named player lookup.
`nearestCrystalFilter()`	`Entity \| null`	Finds the nearest end crystal.
`static nearestCrystalFilter(bot)`	`Entity \| null`	Static helper for finding the nearest end crystal.
`crystalAtPosition(position)`	`Entity \| null`	Finds a crystal whose translated position matches the supplied block position.