/*
 * Copyright (c) 2024-2026 GeyserMC. http://geysermc.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @author GeyserMC
 * @link https://github.com/GeyserMC/Geyser
 */

package org.geysermc.geyser.api.pack.option;

import org.geysermc.geyser.api.pack.ResourcePack;
import org.geysermc.geyser.api.pack.exception.ResourcePackException;

/**
 * Represents a resource pack option that can be used to specify how a resource
 * pack is sent to Bedrock clients.
 * <p>
 * Not all options can be applied to all resource packs. For example, you cannot specify
 * a specific subpack to be loaded on resource packs that do not have subpacks.
 * To see which limitations apply to specific resource pack options, check the javadocs
 * or see the {@link #validate(ResourcePack)} method.
 * @since 2.6.2
 */
public interface ResourcePackOption<T> {

    /**
     * @return the option type
     * @since 2.6.2
     */
    Type type();

    /**
     * @return the value of the option
     * @since 2.6.2
     */
    T value();

    /**
     * Used to validate a specific options for a pack.
     * Some options are not applicable to some packs.
     *
     * @param pack the resource pack to validate the option for
     * @throws ResourcePackException with the {@link ResourcePackException.Cause#INVALID_PACK_OPTION} cause
     * @since 2.6.2
     */
    void validate(ResourcePack pack);

    /**
     * Represents the different types of resource pack options.
     * @since 2.6.2
     */
    enum Type {
        SUBPACK,
        PRIORITY,
        FALLBACK
    }

}
