Plex-FAWE/worldedit-core/src/main/java/com/sk89q/worldedit/extension/platform/Platform.java

/*
 * WorldEdit, a Minecraft world manipulation toolkit
 * Copyright (C) sk89q <http://www.sk89q.com>
 * Copyright (C) WorldEdit team and contributors
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package com.sk89q.worldedit.extension.platform;

import com.sk89q.worldedit.LocalConfiguration;
import com.sk89q.worldedit.entity.Player;
import com.sk89q.worldedit.util.command.Dispatcher;
import com.sk89q.worldedit.world.World;
import com.sk89q.worldedit.world.registry.Registries;

import java.util.List;
import java.util.Map;

import javax.annotation.Nullable;

/**
 * Represents a platform that WorldEdit has been implemented for.
 *
 * <p>It is strongly recommended that implementations extend from
 * {@link AbstractPlatform}.</p>
 */
public interface Platform {

    /**
     * Gets the registry holder.
     *
     * @return The registry holder
     */
    Registries getRegistries();

    /**
     * Checks if a mob type is valid.
     *
     * @param type The mob type name to check
     * @return Whether the name is a valid mod bype
     */
    boolean isValidMobType(String type);

    /**
     * Reload WorldEdit configuration.
     */
    void reload();

    /**
     * Schedules the given {@code task} to be invoked once every
     * {@code period} ticks after an initial delay of {@code delay} ticks.
     *
     * @param delay Delay in server ticks before executing first repeat
     * @param period Period in server ticks of the task
     * @param task Task to be executed
     * @return Task id number (-1 if scheduling failed)
     */
    int schedule(long delay, long period, Runnable task);

    /**
     * Get a list of available or loaded worlds.
     *
     * @return a list of worlds
     */
    List<? extends World> getWorlds();

    /**
     * Create a duplicate of the given player.
     *
     * <p>The given player may have been provided by a different platform.</p>
     *
     * @param player the player to match
     * @return a matched player, otherwise null
     */
    @Nullable Player matchPlayer(Player player);

    /**
     * Create a duplicate of the given world.
     *
     * <p>The given world may have been provided by a different platform.</p>
     *
     * @param world the world to match
     * @return a matched world, otherwise null
     */
    @Nullable World matchWorld(World world);

    /**
     * Register the commands contained within the given command dispatcher.
     *
     * @param dispatcher the dispatcher
     */
    void registerCommands(Dispatcher dispatcher);

    /**
     * Register game hooks.
     */
    void registerGameHooks();

    /**
     * Get the configuration from this platform.
     *
     * @return the configuration
     */
    LocalConfiguration getConfiguration();

    /**
     * Get the version of WorldEdit that this platform provides.
     *
     * <p>This version should match WorldEdit releases because it may be
     * checked to match.</p>
     *
     * @return the version
     */
    String getVersion();

    /**
     * Get a friendly name of the platform.
     *
     * <p>The name can be anything (reasonable). An example name may be
     * "Bukkit" or "Forge".</p>
     *
     * @return the platform name
     */
    String getPlatformName();

    /**
     * Get the version of the platform, which can be anything.
     *
     * @return the platform version
     */
    String getPlatformVersion();

    /**
     * Get a map of advertised capabilities of this platform, where each key
     * in the given map is a supported capability and the respective value
     * indicates the preference for this platform for that given capability.
     *
     * @return a map of capabilities
     */
    Map<Capability, Preference> getCapabilities();

}