xyz.jpenilla.squaremap.api.Squaremap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of squaremap-api Show documentation

API for extending squaremap, a minimalistic and lightweight world map viewer for Minecraft servers

There is a newer version: 1.3.4

package xyz.jpenilla.squaremap.api;

import java.awt.image.BufferedImage;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Optional;
import org.checkerframework.checker.nullness.qual.NonNull;

/**
 * squaremap API
 *
 * The API allows other plugins on the server integrate with squaremap.
 *
 * This interface represents the base of the API package. All functions are
 * accessed via this interface.
 *
 * To start using the API, you need to obtain an instance of this interface.
 * These are registered by the squaremap plugin to the platforms Services
 * Manager. This is the preferred method for obtaining an instance.
 *
 * For ease of use, an instance can also be obtained from the static
 * singleton accessor in {@link SquaremapProvider}.
 */
public interface Squaremap {

    /**
     * Get an unmodifiable view of the enabled worlds
     *
     * @return The set of worlds
     */
    @NonNull Collection mapWorlds();

    /**
     * Get an optional which will either
     * 
     *     A) Be empty, if the world does not exist, or does not have squaremap enabled
     *     B) Contain the {@link MapWorld} instance for the World associated with the provided {@link WorldIdentifier}, if the world exists and has squaremap enabled
     * 
     *
     * @param identifier world identifier
     * @return optional
     */
    @NonNull Optional getWorldIfEnabled(@NonNull WorldIdentifier identifier);

    /**
     * Get the registry of images which can be used with icon markers
     *
     * @return icon registry
     */
    @NonNull Registry iconRegistry();

    /**
     * Get the player manager
     *
     * @return player manager
     */
    @NonNull PlayerManager playerManager();

    /**
     * Get the web directory
     *
     * @return web directory
     */
    @NonNull Path webDir();

}