001/*
002 * This file is part of Baritone.
003 *
004 * Baritone is free software: you can redistribute it and/or modify
005 * it under the terms of the GNU Lesser General Public License as published by
006 * the Free Software Foundation, either version 3 of the License, or
007 * (at your option) any later version.
008 *
009 * Baritone is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012 * GNU Lesser General Public License for more details.
013 *
014 * You should have received a copy of the GNU Lesser General Public License
015 * along with Baritone.  If not, see <https://www.gnu.org/licenses/>.
016 */
017
018package baritone.api.command.datatypes;
019
020import baritone.api.IBaritone;
021import baritone.api.command.argument.IArgConsumer;
022
023/**
024 * Provides an {@link IDatatype} with contextual information so
025 * that it can perform the desired operation on the target level.
026 *
027 * @author Brady
028 * @see IDatatype
029 * @since 9/26/2019
030 */
031public interface IDatatypeContext {
032
033    /**
034     * Provides the {@link IBaritone} instance that is associated with the action relating to datatype handling.
035     *
036     * @return The context {@link IBaritone} instance.
037     */
038    IBaritone getBaritone();
039
040    /**
041     * Provides the {@link IArgConsumer}} to fetch input information from.
042     *
043     * @return The context {@link IArgConsumer}}.
044     */
045    IArgConsumer getConsumer();
046}