Package baritone.api

Interface IBaritoneProvider

public interface IBaritoneProvider

Provides the present IBaritone instances, as well as non-baritone instance related APIs.

Author:

leijurv

Method Summary

Modifier and Type	Method	Description
IBaritone	createBaritone(net.minecraft.client.Minecraft minecraft)	Creates and registers a new IBaritone instance using the specified Minecraft.
boolean	destroyBaritone(IBaritone baritone)	Destroys and removes the specified IBaritone instance.
List<IBaritone>	getAllBaritones()	Returns all of the active IBaritone instances.
default IBaritone	getBaritoneForConnection(net.minecraft.client.multiplayer.ClientPacketListener connection)	Provides the IBaritone instance for the player with the specified connection.
default IBaritone	getBaritoneForMinecraft(net.minecraft.client.Minecraft minecraft)	Provides the IBaritone instance for a given Minecraft.
default IBaritone	getBaritoneForPlayer(net.minecraft.client.player.LocalPlayer player)	Provides the IBaritone instance for a given LocalPlayer.
ICommandSystem	getCommandSystem()	Returns the ICommandSystem instance.
IBaritone	getPrimaryBaritone()	Returns the primary IBaritone instance.
ISchematicSystem	getSchematicSystem()
IWorldScanner	getWorldScanner()	Returns the IWorldScanner instance.

Method Details

getPrimaryBaritone

IBaritone getPrimaryBaritone()

Returns the primary IBaritone instance. This instance is persistent, and is represented by the local player that is created by the game itself, not a "bot" player through Baritone.

Returns:

The primary IBaritone instance.

getAllBaritones

List<IBaritone> getAllBaritones()

Returns all of the active IBaritone instances. This includes the local one returned by getPrimaryBaritone().

Returns:

All active IBaritone instances.

See Also:

• getBaritoneForPlayer(LocalPlayer)

getBaritoneForPlayer

default IBaritone getBaritoneForPlayer(net.minecraft.client.player.LocalPlayer player)

Provides the IBaritone instance for a given LocalPlayer.

Parameters:

player - The player

Returns:

The IBaritone instance.

getBaritoneForMinecraft

default IBaritone getBaritoneForMinecraft(net.minecraft.client.Minecraft minecraft)

Provides the IBaritone instance for a given Minecraft.

Parameters:

minecraft - The minecraft

Returns:

The IBaritone instance.

getBaritoneForConnection

default IBaritone getBaritoneForConnection(net.minecraft.client.multiplayer.ClientPacketListener connection)

Provides the IBaritone instance for the player with the specified connection.

Parameters:

connection - The connection

Returns:

The IBaritone instance.

createBaritone

IBaritone createBaritone(net.minecraft.client.Minecraft minecraft)

Creates and registers a new IBaritone instance using the specified Minecraft. The existing instance is returned if already registered.

Parameters:

minecraft - The minecraft

Returns:

The IBaritone instance

destroyBaritone

boolean destroyBaritone(IBaritone baritone)

Destroys and removes the specified IBaritone instance. If the specified instance is the primary baritone, this operation has no effect and will return false.

Parameters:

baritone - The baritone instance to remove

Returns:

Whether the baritone instance was removed

getWorldScanner

IWorldScanner getWorldScanner()

Returns the IWorldScanner instance. This is not a type returned by IBaritone implementation, because it is not linked with IBaritone.

Returns:

The IWorldScanner instance.

getCommandSystem

ICommandSystem getCommandSystem()

Returns the ICommandSystem instance. This is not bound to a specific IBaritone instance because ICommandSystem itself controls global behavior for ICommands.

Returns:

The ICommandSystem instance.

getSchematicSystem

ISchematicSystem getSchematicSystem()

Returns:

The ISchematicSystem instance.