//
// MIT License
//
// Copyright (c) 2021 Alexander Söderberg & Contributors
//
// 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.
//
package cloud.commandframework.minecraft.extras;

import cloud.commandframework.meta.CommandMeta;
import net.kyori.adventure.text.Component;

/**
 * Extra command metadata for providing rich text.
 *
 * @since 1.4.0
 */
public final class MinecraftExtrasMetaKeys {

    /**
     * A component short description.
     *
     * <p>This will not set the plain-text description, but will be used in place of that meta key in help.</p>
     */
    public static final CommandMeta.Key<Component> DESCRIPTION = CommandMeta.Key.of(
            Component.class,
            "cloud:minecraft_extras/description"
    );

    /**
     * A component long description.
     *
     * <p>This will not set the plain-text long description, but will be used in place of that meta key in help.</p>
     */
    public static final CommandMeta.Key<Component> LONG_DESCRIPTION = CommandMeta.Key.of(
            Component.class,
            "cloud:minecraft_extras/long_description"
    );

    private MinecraftExtrasMetaKeys() {
    }

}
