UtilFunctions

src/utilFunctions.ts

The main wrapper exposed as bot.util. It bundles the feature-specific helper classes into a single entry point so callers can work with one namespace instead of instantiating helpers manually.

Constructor

Signature	Description
`new UtilFunctions(bot)`	Creates the helper bundle for a Mineflayer bot.

Properties

Property	Type	Purpose
`inv`	`InventoryFunctions`	Inventory helpers.
`move`	`MovementFunctions`	Movement and look synchronization helpers.
`entity`	`EntityFunctions`	Entity math and metadata helpers.
`predict`	`PredictiveFunctions`	Damage prediction and simulated world helpers.
`filters`	`FilterFunctions`	Nearest entity filtering helpers.
`raytrace`	`RayTraceFunctions`	Block and entity ray tracing helpers.

Methods

Method	Returns	Description
`getViewDir()`	`Vec3`	Returns the bot's current look direction as a vector.

Example

inject(bot);

const viewDir = bot.util.getViewDir();
const nearestPlayer = bot.util.filters.getNearestEntity(
  (entity) => entity.type === "player"
);