Interface BungeeAudiences

  • All Superinterfaces:
    AudienceProvider, java.lang.AutoCloseable

    public interface BungeeAudiences
    extends AudienceProvider
    A provider for creating Audiences for BungeeCord.
    Since:
    4.0.0
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      static @NotNull BungeeAudiences.Builder builder​(@NotNull net.md_5.bungee.api.plugin.Plugin plugin)
      Creates an audience provider builder for a plugin.
      static @NotNull BungeeAudiences create​(@NotNull net.md_5.bungee.api.plugin.Plugin plugin)
      Creates an audience provider for a plugin.
      @NotNull net.kyori.adventure.audience.Audience filter​(@NotNull java.util.function.Predicate<net.md_5.bungee.api.CommandSender> filter)
      Creates an audience based on a filter.
      @NotNull net.kyori.adventure.audience.Audience player​(@NotNull net.md_5.bungee.api.connection.ProxiedPlayer player)
      Gets an audience for a player.
      @NotNull net.kyori.adventure.audience.Audience sender​(@NotNull net.md_5.bungee.api.CommandSender sender)
      Gets an audience for a command sender.
    • Method Detail

      • create

        @NotNull
        static @NotNull BungeeAudiences create​(@NotNull
                                               @NotNull net.md_5.bungee.api.plugin.Plugin plugin)
        Creates an audience provider for a plugin.

        There will only be one provider for each plugin.

        Parameters:
        plugin - a plugin
        Returns:
        an audience provider
        Since:
        4.0.0
      • builder

        @NotNull
        static @NotNull BungeeAudiences.Builder builder​(@NotNull
                                                        @NotNull net.md_5.bungee.api.plugin.Plugin plugin)
        Creates an audience provider builder for a plugin.

        There will only be one provider for each plugin.

        Parameters:
        plugin - a plugin
        Returns:
        an audience provider
        Since:
        4.0.0
      • sender

        @NotNull
        @NotNull net.kyori.adventure.audience.Audience sender​(@NotNull
                                                              @NotNull net.md_5.bungee.api.CommandSender sender)
        Gets an audience for a command sender.
        Parameters:
        sender - a command sender
        Returns:
        an audience
        Since:
        4.0.0
      • player

        @NotNull
        @NotNull net.kyori.adventure.audience.Audience player​(@NotNull
                                                              @NotNull net.md_5.bungee.api.connection.ProxiedPlayer player)
        Gets an audience for a player.
        Parameters:
        player - a player
        Returns:
        an audience
        Since:
        4.0.0
      • filter

        @NotNull
        @NotNull net.kyori.adventure.audience.Audience filter​(@NotNull
                                                              @NotNull java.util.function.Predicate<net.md_5.bungee.api.CommandSender> filter)
        Creates an audience based on a filter.
        Parameters:
        filter - a filter
        Returns:
        an audience
        Since:
        4.0.0