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.cache;
019
020/**
021 * @author Brady
022 * @since 9/24/2018
023 */
024public interface IWorldData {
025
026    /**
027     * Returns the cached world for this world. A cached world is a simplified format
028     * of a regular world, intended for use on multiplayer servers where chunks are not
029     * traditionally stored to disk, allowing for long distance pathing with minimal disk usage.
030     *
031     * @return The cached world for this world
032     */
033    ICachedWorld getCachedWorld();
034
035    /**
036     * @return The waypoint collection for this world
037     */
038    IWaypointCollection getWaypoints();
039
040}