org.spongepowered.api.adventure.SpongeComponents Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
There is a newer version: 9.0.0
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) 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 org.spongepowered.api.adventure;

import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.event.ClickEvent;
import org.spongepowered.api.Sponge;
import org.spongepowered.api.command.CommandCause;
import org.spongepowered.api.registry.DefaultedRegistryReference;

import java.util.function.Consumer;

/**
 * Additional SpongeAPI-specific methods for working with {@link Component}s and related.
 */
public final class SpongeComponents {
    private SpongeComponents() {
    }

    /**
     * Creates a new {@link ClickEvent} that will execute the given runnable on
     * the server when clicked. The callback will expire after some amount of
     * time (not particularly instantly, but not like overnight really either).
     *
     * @param callback The callback to execute
     * @return The created click event instance
     */
    public static ClickEvent executeCallback(final Consumer callback) {
        return SpongeComponents.factory().callbackClickEvent(callback);
    }

    /**
     * Render a component for viewer-specific context.
     *
     * The {@code viewer} must refer to a single viewer, not multiple viewers,
     * in order to gather any useful context. If an audience cannot be resolved
     * to a single viewer, this method will behave as if no viewer had
     * been defined.
     *
     * @param component the component to render
     * @param senderContext the context to render in
     * @param viewer the viewer to render for
     * @param resolver the first resolver
     * @param otherResolvers any other resolvers to apply
     * @return the rendered component
     */
    @SafeVarargs
    public static Component resolve(
        final Component component,
        final CommandCause senderContext,
        final Audience viewer,
        final DefaultedRegistryReference resolver,
        final DefaultedRegistryReference... otherResolvers
    ) {
        return SpongeComponents.factory().render(component, senderContext, viewer, resolver, otherResolvers);
    }

    /**
     * Render a component for sender-specific context.
     *
     * Viewer-specific information will not be available
     *
     * @param component the component to render
     * @param senderContext the context to render in
     * @param resolver the first resolver
     * @param otherResolvers any other resolvers to apply
     * @return the rendered component
     */
    @SafeVarargs
    public static Component resolve(
        final Component component,
        final CommandCause senderContext,
        final DefaultedRegistryReference resolver,
        final DefaultedRegistryReference... otherResolvers
    ) {
        return SpongeComponents.factory().render(component, senderContext, resolver, otherResolvers);
    }

    private static Factory factory() {
        return Sponge.game().factoryProvider().provide(Factory.class);
    }

    public interface Factory {
        ClickEvent callbackClickEvent(final Consumer callback);

        @SuppressWarnings("unchecked")
        Component render(
            final Component component,
            final CommandCause senderContext,
            final Audience viewer,
            final DefaultedRegistryReference resolver,
            final DefaultedRegistryReference... otherResolvers
        );

        @SuppressWarnings("unchecked")
        Component render(
            final Component component,
            final CommandCause senderContext,
            final DefaultedRegistryReference resolver,
            final DefaultedRegistryReference... otherResolvers
        );

    }
}