Package net.minestom.server.adventure.audience

Interface PacketGroupingAudience

All Superinterfaces:

Audience, ForwardingAudience, Pointered

All Known Subinterfaces:

Scoreboard

All Known Implementing Classes:

BelowNameTag, Instance, InstanceContainer, SharedInstance, Sidebar, TabList, Team

public interface PacketGroupingAudience
extends ForwardingAudience

An audience implementation that sends grouped packets if possible.

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience

ForwardingAudience.Single

Method Summary

Modifier and Type	Method	Description
default @NotNull Iterable<? extends Audience>	audiences()
default void	clearTitle()
@NotNull Collection<@NotNull Player>	getPlayers()	Gets an iterable of the players this audience contains.
default void	hideBossBar(@NotNull BossBar bar)
static @NotNull PacketGroupingAudience	of(@NotNull Collection<Player> players)	Creates a packet grouping audience that copies an iterable of players.
default void	playSound(@NotNull Sound sound, double x, double y, double z)
default void	playSound(@NotNull Sound sound, @NotNull Sound.Emitter emitter)
default void	playSound(@NotNull Sound sound, @NotNull Point point)	Plays a Sound at a given point
default void	resetTitle()
default void	sendActionBar(@NotNull Component message)
default void	sendGroupedPacket(@NotNull ServerPacket packet)	Broadcast a ServerPacket to all players of this audience
default void	sendMessage(@NotNull Identity source, @NotNull Component message, @NotNull MessageType type)	Deprecated.
default void	sendNotification(@NotNull Notification notification)	Send a Notification to the audience.
default void	sendPlayerListHeaderAndFooter(@NotNull Component header, @NotNull Component footer)
default <T> void	sendTitlePart(@NotNull TitlePart<T> part, T value)
default void	showBossBar(@NotNull BossBar bar)
default void	stopSound(@NotNull SoundStop stop)

Methods inherited from interface net.kyori.adventure.audience.Audience

deleteMessage, openBook, removeResourcePacks, removeResourcePacks, removeResourcePacks, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, showTitle, stopSound

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience

clearResourcePacks, deleteMessage, filterAudience, forEachAudience, openBook, playSound, pointers, removeResourcePacks, removeResourcePacks, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendResourcePacks

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom

Method Details

of

@NotNull
static @NotNull PacketGroupingAudience of(@NotNull
 @NotNull Collection<Player> players)

Creates a packet grouping audience that copies an iterable of players. The underlying collection is not copied, so changes to the collection will be reflected in the audience.

Parameters:

players - the players

Returns:

the audience

getPlayers

@NotNull
@NotNull Collection<@NotNull Player> getPlayers()

Gets an iterable of the players this audience contains.

Returns:

the connections

sendGroupedPacket

default void sendGroupedPacket(@NotNull
 @NotNull ServerPacket packet)

Broadcast a ServerPacket to all players of this audience

Parameters:

packet - the packet to broadcast

sendMessage

@Deprecated
default void sendMessage(@NotNull
 @NotNull Identity source,
 @NotNull
 @NotNull Component message,
 @NotNull
 @NotNull MessageType type)

Deprecated.

Specified by:

sendMessage in interface Audience

Specified by:

sendMessage in interface ForwardingAudience

sendActionBar

default void sendActionBar(@NotNull
 @NotNull Component message)

Specified by:

sendActionBar in interface Audience

Specified by:

sendActionBar in interface ForwardingAudience

sendPlayerListHeaderAndFooter

default void sendPlayerListHeaderAndFooter(@NotNull
 @NotNull Component header,
 @NotNull
 @NotNull Component footer)

Specified by:

sendPlayerListHeaderAndFooter in interface Audience

Specified by:

sendPlayerListHeaderAndFooter in interface ForwardingAudience

sendTitlePart

default <T> void sendTitlePart(@NotNull
 @NotNull TitlePart<T> part,
 @NotNull
 T value)

Specified by:

sendTitlePart in interface Audience

Specified by:

sendTitlePart in interface ForwardingAudience

clearTitle

default void clearTitle()

Specified by:

clearTitle in interface Audience

Specified by:

clearTitle in interface ForwardingAudience

resetTitle

default void resetTitle()

Specified by:

resetTitle in interface Audience

Specified by:

resetTitle in interface ForwardingAudience

showBossBar

default void showBossBar(@NotNull
 @NotNull BossBar bar)

Specified by:

showBossBar in interface Audience

Specified by:

showBossBar in interface ForwardingAudience

hideBossBar

default void hideBossBar(@NotNull
 @NotNull BossBar bar)

Specified by:

hideBossBar in interface Audience

Specified by:

hideBossBar in interface ForwardingAudience

playSound

default void playSound(@NotNull
 @NotNull Sound sound,
 @NotNull
 @NotNull Point point)

Plays a Sound at a given point

Parameters:

sound - The sound to play

point - The point in this instance at which to play the sound

playSound

default void playSound(@NotNull
 @NotNull Sound sound,
 double x,
 double y,
 double z)

Specified by:

playSound in interface Audience

Specified by:

playSound in interface ForwardingAudience

playSound

default void playSound(@NotNull
 @NotNull Sound sound,
 @NotNull Sound.Emitter emitter)

Specified by:

playSound in interface Audience

Specified by:

playSound in interface ForwardingAudience

stopSound

default void stopSound(@NotNull
 @NotNull SoundStop stop)

Specified by:

stopSound in interface Audience

Specified by:

stopSound in interface ForwardingAudience

sendNotification

default void sendNotification(@NotNull
 @NotNull Notification notification)

Send a Notification to the audience.

Parameters:

notification - the Notification to send

audiences

@NotNull
default @NotNull Iterable<? extends Audience> audiences()

Specified by:

audiences in interface ForwardingAudience