net.minestom.server.adventure.audience.AudienceProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of minestom-snapshots Show documentation
1.20.4 Lightweight Minecraft server
There is a newer version: 7320437640
package net.minestom.server.adventure.audience;

import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.key.Key;
import net.kyori.adventure.key.Keyed;
import net.minestom.server.entity.Player;
import org.jetbrains.annotations.NotNull;

import java.util.function.Predicate;

/**
 * A generic provider of {@link Audience audiences} or some subtype.
 *
 * @param  the type that is provided
 */
public interface AudienceProvider {

    /**
     * Gets all audience members. This returns {@link #players()} combined with
     * {@link #customs()} and {@link #console()}. This can be a costly operation, so it
     * is often preferable to use {@link #server()} instead.
     *
     * @return all audience members
     */
    @NotNull A all();

    /**
     * Gets all audience members that are of type {@link Player}.
     *
     * @return all players
     */
    @NotNull A players();

    /**
     * Gets all audience members that are of type {@link Player} and match the predicate.
     *
     * @param filter the predicate
     * @return all players matching the predicate
     */
    @NotNull A players(@NotNull Predicate filter);

    /**
     * Gets the console as an audience.
     *
     * @return the console
     */
    @NotNull A console();

    /**
     * Gets the combination of {@link #players()} and {@link #console()}.
     *
     * @return the audience of all players and the console
     */
    @NotNull A server();

    /**
     * Gets all custom audience members stored using the given keyed object.
     *
     * @param keyed the keyed object
     * @return all custom audience members stored using the key of the object
     */
    default @NotNull A custom(@NotNull Keyed keyed) {
        return this.custom(keyed.key());
    }

    /**
     * Gets all custom audience members stored using the given key.
     *
     * @param key the key
     * @return all custom audience members stored using the key
     */
    @NotNull A custom(@NotNull Key key);

    /**
     * Gets all custom audience members stored using the given keyed object that match
     * the given predicate.
     *
     * @param keyed  the keyed object
     * @param filter the predicate
     * @return all custom audience members stored using the key
     */
    default @NotNull A custom(@NotNull Keyed keyed, Predicate filter) {
        return this.custom(keyed.key(), filter);
    }

    /**
     * Gets all custom audience members stored using the given key that match the
     * given predicate.
     *
     * @param key    the key
     * @param filter the predicate
     * @return all custom audience members stored using the key
     */
    @NotNull A custom(@NotNull Key key, Predicate filter);

    /**
     * Gets all custom audience members.
     *
     * @return all custom audience members
     */
    @NotNull A customs();

    /**
     * Gets all custom audience members matching the given predicate.
     *
     * @param filter the predicate
     * @return all matching custom audience members
     */
    @NotNull A customs(@NotNull Predicate filter);

    /**
     * Gets all audience members that match the given predicate.
     *
     * @param filter the predicate
     * @return all matching audience members
     */
    @NotNull A all(@NotNull Predicate filter);

    /**
     * Gets the audience registry used to register custom audiences.
     *
     * @return the registry
     */
    @NotNull AudienceRegistry registry();
}
Related Artifacts