org.incendo.cloud.minecraft.extras.AudienceProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloud-minecraft-extras Show documentation

Integrations between Minecraft and Cloud Command Framework

There is a newer version: 2.0.0-beta.10

Show newest version

//
// MIT License
//
// Copyright (c) 2024 Incendo
//
// 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.incendo.cloud.minecraft.extras;

import java.util.function.Function;
import net.kyori.adventure.audience.Audience;
import org.checkerframework.checker.nullness.qual.NonNull;

/**
 * Function that maps the command sender type to an adventure {@link net.kyori.adventure.audience.Audience}
 *
 * @param  Command sender type
 */
@FunctionalInterface
public interface AudienceProvider extends Function<@NonNull C, @NonNull Audience> {

    /**
     * Convert a command sender to an {@link Audience}
     *
     * @param sender Command sender
     * @return Mapped audience
     */
    @Override
    @NonNull Audience apply(@NonNull C sender);

    /**
     * Get an audience provider for sender types which are already an {@link Audience}.
     *
     * @param  sender type
     * @return native audience provider
     * @since 1.5.0
     */
    @SuppressWarnings("unchecked")
    static  AudienceProvider nativeAudience() {
        return (AudienceProvider) NativeAudienceProvider.INSTANCE;
    }
}