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.event.events;
019
020import baritone.api.event.events.type.EventState;
021
022import java.util.function.BiFunction;
023
024public final class TickEvent {
025
026    private static int overallTickCount;
027
028    private final EventState state;
029    private final Type type;
030    private final int count;
031
032    public TickEvent(EventState state, Type type, int count) {
033        this.state = state;
034        this.type = type;
035        this.count = count;
036    }
037
038    public int getCount() {
039        return count;
040    }
041
042    public Type getType() {
043        return type;
044    }
045
046    public EventState getState() {
047        return state;
048    }
049
050    public static synchronized BiFunction<EventState, Type, TickEvent> createNextProvider() {
051        final int count = overallTickCount++;
052        return (state, type) -> new TickEvent(state, type, count);
053    }
054
055    public enum Type {
056        /**
057         * When guarantees can be made about
058         * the game state and in-game variables.
059         */
060        IN,
061        /**
062         * No guarantees can be made about the game state.
063         * This probably means we are at the main menu.
064         */
065        OUT,
066    }
067}