Minor javadoc changes

This commit is contained in:
Brady 2019-02-23 14:32:10 -06:00
parent e8e00e8dfb
commit 0bce801a3f
No known key found for this signature in database
GPG Key ID: 73A788379A197567
5 changed files with 67 additions and 35 deletions

View File

@ -23,9 +23,7 @@ import java.util.Iterator;
import java.util.ServiceLoader; import java.util.ServiceLoader;
/** /**
* API exposure for various things implemented in Baritone. * Exposes the {@link IBaritoneProvider} instance and the {@link Settings} instance for API usage.
* <p>
* W.I.P
* *
* @author Brady * @author Brady
* @since 9/23/2018 * @since 9/23/2018

View File

@ -22,10 +22,7 @@ import baritone.api.behavior.IPathingBehavior;
import baritone.api.cache.IWorldProvider; import baritone.api.cache.IWorldProvider;
import baritone.api.event.listener.IEventBus; import baritone.api.event.listener.IEventBus;
import baritone.api.pathing.calc.IPathingControlManager; import baritone.api.pathing.calc.IPathingControlManager;
import baritone.api.process.ICustomGoalProcess; import baritone.api.process.*;
import baritone.api.process.IFollowProcess;
import baritone.api.process.IGetToBlockProcess;
import baritone.api.process.IMineProcess;
import baritone.api.utils.IInputOverrideHandler; import baritone.api.utils.IInputOverrideHandler;
import baritone.api.utils.IPlayerContext; import baritone.api.utils.IPlayerContext;
@ -36,22 +33,13 @@ import baritone.api.utils.IPlayerContext;
public interface IBaritone { public interface IBaritone {
/** /**
* @return The {@link IFollowProcess} instance * Call as soon as Minecraft is ready, initializes all of the processes, behaviors, etc. This will
* @see IFollowProcess * only effectively be ran once, any additional calls are redundant because the initialization state
* is saved.
* <p>
* Or whenever your overeager utility client wants.
*/ */
IFollowProcess getFollowProcess(); void init();
/**
* @return The {@link ILookBehavior} instance
* @see ILookBehavior
*/
ILookBehavior getLookBehavior();
/**
* @return The {@link IMineProcess} instance
* @see IMineProcess
*/
IMineProcess getMineProcess();
/** /**
* @return The {@link IPathingBehavior} instance * @return The {@link IPathingBehavior} instance
@ -59,28 +47,66 @@ public interface IBaritone {
*/ */
IPathingBehavior getPathingBehavior(); IPathingBehavior getPathingBehavior();
/**
* @return The {@link ILookBehavior} instance
* @see ILookBehavior
*/
ILookBehavior getLookBehavior();
/**
* @return The {@link IFollowProcess} instance
* @see IFollowProcess
*/
IFollowProcess getFollowProcess();
/**
* @return The {@link IMineProcess} instance
* @see IMineProcess
*/
IMineProcess getMineProcess();
/**
* @return The {@link ICustomGoalProcess} instance
* @see ICustomGoalProcess
*/
ICustomGoalProcess getCustomGoalProcess();
/**
* @return The {@link IGetToBlockProcess} instance
* @see IGetToBlockProcess
*/
IGetToBlockProcess getGetToBlockProcess();
/** /**
* @return The {@link IWorldProvider} instance * @return The {@link IWorldProvider} instance
* @see IWorldProvider * @see IWorldProvider
*/ */
IWorldProvider getWorldProvider(); IWorldProvider getWorldProvider();
/**
* Returns the {@link IPathingControlManager} for this {@link IBaritone} instance, which is responsible
* for managing the {@link IBaritoneProcess}es which control the {@link IPathingBehavior} state.
*
* @return The {@link IPathingControlManager} instance
* @see IPathingControlManager
*/
IPathingControlManager getPathingControlManager(); IPathingControlManager getPathingControlManager();
/**
* @return The {@link IInputOverrideHandler} instance
* @see IInputOverrideHandler
*/
IInputOverrideHandler getInputOverrideHandler(); IInputOverrideHandler getInputOverrideHandler();
ICustomGoalProcess getCustomGoalProcess(); /**
* @return The {@link IPlayerContext} instance
IGetToBlockProcess getGetToBlockProcess(); * @see IPlayerContext
*/
IPlayerContext getPlayerContext(); IPlayerContext getPlayerContext();
IEventBus getGameEventHandler();
/** /**
* Call as soon as Minecraft is ready. * @return The {@link IEventBus} instance
* <p> * @see IEventBus
* Or whenever your overeager utility client wants.
*/ */
void init(); IEventBus getGameEventHandler();
} }

View File

@ -23,7 +23,9 @@ import net.minecraft.client.entity.EntityPlayerSP;
import java.util.List; import java.util.List;
/** /**
* @author Leijurv * Provides the present {@link IBaritone} instances
*
* @author leijurv
*/ */
public interface IBaritoneProvider { public interface IBaritoneProvider {
@ -47,7 +49,8 @@ public interface IBaritoneProvider {
/** /**
* Provides the {@link IBaritone} instance for a given {@link EntityPlayerSP}. This will likely be * Provides the {@link IBaritone} instance for a given {@link EntityPlayerSP}. This will likely be
* replaced with {@code #getBaritoneForUser(IBaritoneUser)} when {@code bot-system} is merged. * replaced with or be overloaded in addition to {@code #getBaritoneForUser(IBaritoneUser)} when
* {@code bot-system} is merged into {@code master}.
* *
* @param player The player * @param player The player
* @return The {@link IBaritone} instance. * @return The {@link IBaritone} instance.

View File

@ -30,7 +30,7 @@ import java.util.List;
import java.util.function.Consumer; import java.util.function.Consumer;
/** /**
* Baritone's settings * Baritone's settings. Settings apply to all Baritone instances.
* *
* @author leijurv * @author leijurv
*/ */

View File

@ -18,8 +18,13 @@
package baritone.api.behavior; package baritone.api.behavior;
import baritone.api.event.listener.AbstractGameEventListener; import baritone.api.event.listener.AbstractGameEventListener;
import baritone.api.event.listener.IGameEventListener;
/** /**
* A behavior is simply a type that is able to listen to events.
*
* @see IGameEventListener
*
* @author Brady * @author Brady
* @since 9/23/2018 * @since 9/23/2018
*/ */