Interface ForwardingAudience.Single
-
- All Superinterfaces:
Audience
,ForwardingAudience
,Pointered
- Enclosing interface:
- ForwardingAudience
public static interface ForwardingAudience.Single extends ForwardingAudience
An audience that forwards everything to a single other audience.- Since:
- 4.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience
ForwardingAudience.Single
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description @NotNull Audience
audience()
Gets the audience.default @NotNull Iterable<? extends Audience>
audiences()
Deprecated.this audience only supports forwarding to a single audiencedefault void
clearTitle()
Clears the title, if one is being displayed.default <T> @NotNull Optional<T>
get(@NotNull Pointer<T> pointer)
Gets the value ofpointer
.default <T> T
getOrDefault(@NotNull Pointer<T> pointer, T defaultValue)
Gets the value ofpointer
.default <T> @UnknownNullability T
getOrDefaultFrom(@NotNull Pointer<T> pointer, @NotNull Supplier<? extends T> defaultValue)
Gets the value ofpointer
.default void
hideBossBar(@NotNull BossBar bar)
Hides a boss bar.default void
openBook(@NotNull Book book)
Opens a book.default void
playSound(@NotNull Sound sound)
Plays a sound at the location of the recipient of the sound.default void
playSound(@NotNull Sound sound, double x, double y, double z)
Plays a sound at a location.default void
playSound(@NotNull Sound sound, @NotNull Sound.Emitter emitter)
Plays a sound from an emitter, usually an entity.default void
resetTitle()
Resets the title and timings back to their default.default void
sendActionBar(@NotNull Component message)
Sends a message on the action bar.default void
sendMessage(@NotNull Identified source, @NotNull Component message, @NotNull MessageType type)
Sends a chat message.default void
sendMessage(@NotNull Identity source, @NotNull Component message, @NotNull MessageType type)
Sends a chat message.default void
sendPlayerListFooter(@NotNull Component footer)
Sends the player list footer.default void
sendPlayerListHeader(@NotNull Component header)
Sends the player list header.default void
sendPlayerListHeaderAndFooter(@NotNull Component header, @NotNull Component footer)
Sends the player list header and footer.default void
showBossBar(@NotNull BossBar bar)
Shows a boss bar.default void
showTitle(@NotNull Title title)
Shows a title.default void
stopSound(@NotNull SoundStop stop)
Stops a sound, or many sounds.-
Methods inherited from interface net.kyori.adventure.audience.Audience
openBook, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, stopSound
-
-
-
-
Method Detail
-
audience
@OverrideOnly @NotNull @NotNull Audience audience()
Gets the audience.- Returns:
- the audience
- Since:
- 4.0.0
-
audiences
@Deprecated @NotNull default @NotNull Iterable<? extends Audience> audiences()
Deprecated.this audience only supports forwarding to a single audienceGets the audiences.- Specified by:
audiences
in interfaceForwardingAudience
- Returns:
audience()
-
get
@NotNull default <T> @NotNull Optional<T> get(@NotNull @NotNull Pointer<T> pointer)
Description copied from interface:Pointered
Gets the value ofpointer
.- Specified by:
get
in interfaceForwardingAudience
- Specified by:
get
in interfacePointered
- Type Parameters:
T
- the type- Parameters:
pointer
- the pointer- Returns:
- the value
-
getOrDefault
@Contract("_, null -> null; _, !null -> !null") @Nullable default <T> T getOrDefault(@NotNull @NotNull Pointer<T> pointer, @Nullable T defaultValue)
Description copied from interface:Pointered
Gets the value ofpointer
.If this
Audience
is unable to provide a value forpointer
,defaultValue
will be returned.- Specified by:
getOrDefault
in interfaceForwardingAudience
- Specified by:
getOrDefault
in interfacePointered
- Type Parameters:
T
- the type- Parameters:
pointer
- the pointerdefaultValue
- the default value- Returns:
- the value
-
getOrDefaultFrom
default <T> @UnknownNullability T getOrDefaultFrom(@NotNull @NotNull Pointer<T> pointer, @NotNull @NotNull Supplier<? extends T> defaultValue)
Description copied from interface:Pointered
Gets the value ofpointer
.If this
Audience
is unable to provide a value forpointer
, the value supplied bydefaultValue
will be returned.- Specified by:
getOrDefaultFrom
in interfaceForwardingAudience
- Specified by:
getOrDefaultFrom
in interfacePointered
- Type Parameters:
T
- the type- Parameters:
pointer
- the pointerdefaultValue
- the default value supplier- Returns:
- the value
-
sendMessage
default void sendMessage(@NotNull @NotNull Identified source, @NotNull @NotNull Component message, @NotNull @NotNull MessageType type)
Description copied from interface:Audience
Sends a chat message.- Specified by:
sendMessage
in interfaceAudience
- Specified by:
sendMessage
in interfaceForwardingAudience
- Parameters:
source
- the source of the messagemessage
- a messagetype
- the type- See Also:
Component
-
sendMessage
default void sendMessage(@NotNull @NotNull Identity source, @NotNull @NotNull Component message, @NotNull @NotNull MessageType type)
Description copied from interface:Audience
Sends a chat message.- Specified by:
sendMessage
in interfaceAudience
- Specified by:
sendMessage
in interfaceForwardingAudience
- Parameters:
source
- the identity of the source of the messagemessage
- a messagetype
- the type- See Also:
Component
-
sendActionBar
default void sendActionBar(@NotNull @NotNull Component message)
Description copied from interface:Audience
Sends a message on the action bar.- Specified by:
sendActionBar
in interfaceAudience
- Specified by:
sendActionBar
in interfaceForwardingAudience
- Parameters:
message
- a message- See Also:
Component
-
sendPlayerListHeader
default void sendPlayerListHeader(@NotNull @NotNull Component header)
Description copied from interface:Audience
Sends the player list header.Depending on the implementation of this
Audience
, an existing footer may be displayed. If you wish to set both the header and the footer, please useAudience.sendPlayerListHeaderAndFooter(Component, Component)
.- Specified by:
sendPlayerListHeader
in interfaceAudience
- Specified by:
sendPlayerListHeader
in interfaceForwardingAudience
- Parameters:
header
- the header
-
sendPlayerListFooter
default void sendPlayerListFooter(@NotNull @NotNull Component footer)
Description copied from interface:Audience
Sends the player list footer.Depending on the implementation of this
Audience
, an existing footer may be displayed. If you wish to set both the header and the footer, please useAudience.sendPlayerListHeaderAndFooter(Component, Component)
.- Specified by:
sendPlayerListFooter
in interfaceAudience
- Specified by:
sendPlayerListFooter
in interfaceForwardingAudience
- Parameters:
footer
- the footer
-
sendPlayerListHeaderAndFooter
default void sendPlayerListHeaderAndFooter(@NotNull @NotNull Component header, @NotNull @NotNull Component footer)
Description copied from interface:Audience
Sends the player list header and footer.- Specified by:
sendPlayerListHeaderAndFooter
in interfaceAudience
- Specified by:
sendPlayerListHeaderAndFooter
in interfaceForwardingAudience
- Parameters:
header
- the headerfooter
- the footer
-
showTitle
default void showTitle(@NotNull @NotNull Title title)
Description copied from interface:Audience
Shows a title.- Specified by:
showTitle
in interfaceAudience
- Specified by:
showTitle
in interfaceForwardingAudience
- Parameters:
title
- a title- See Also:
Title
-
clearTitle
default void clearTitle()
Description copied from interface:Audience
Clears the title, if one is being displayed.- Specified by:
clearTitle
in interfaceAudience
- Specified by:
clearTitle
in interfaceForwardingAudience
- See Also:
Title
-
resetTitle
default void resetTitle()
Description copied from interface:Audience
Resets the title and timings back to their default.- Specified by:
resetTitle
in interfaceAudience
- Specified by:
resetTitle
in interfaceForwardingAudience
- See Also:
Title
-
showBossBar
default void showBossBar(@NotNull @NotNull BossBar bar)
Description copied from interface:Audience
Shows a boss bar.- Specified by:
showBossBar
in interfaceAudience
- Specified by:
showBossBar
in interfaceForwardingAudience
- Parameters:
bar
- a boss bar- See Also:
BossBar
-
hideBossBar
default void hideBossBar(@NotNull @NotNull BossBar bar)
Description copied from interface:Audience
Hides a boss bar.- Specified by:
hideBossBar
in interfaceAudience
- Specified by:
hideBossBar
in interfaceForwardingAudience
- Parameters:
bar
- a boss bar- See Also:
BossBar
-
playSound
default void playSound(@NotNull @NotNull Sound sound)
Description copied from interface:Audience
Plays a sound at the location of the recipient of the sound.To play a sound that follows the recipient, use
Audience.playSound(Sound, Sound.Emitter)
withSound.Emitter.self()
.- Specified by:
playSound
in interfaceAudience
- Specified by:
playSound
in interfaceForwardingAudience
- Parameters:
sound
- a sound- See Also:
Sound
-
playSound
default void playSound(@NotNull @NotNull Sound sound, double x, double y, double z)
Description copied from interface:Audience
Plays a sound at a location.- Specified by:
playSound
in interfaceAudience
- Specified by:
playSound
in interfaceForwardingAudience
- Parameters:
sound
- a soundx
- x coordinatey
- y coordinatez
- z coordinate- See Also:
Sound
-
playSound
default void playSound(@NotNull @NotNull Sound sound, @NotNull Sound.Emitter emitter)
Description copied from interface:Audience
Plays a sound from an emitter, usually an entity.Sounds played using this method will follow the emitter unless the sound is a custom sound. In this case the sound will be played at the location of the emitter and will not follow them.
To play a sound that follows the recipient, use
Sound.Emitter.self()
.Note: Due to MC-138832, the volume and pitch may be ignored when using this method.
- Specified by:
playSound
in interfaceAudience
- Specified by:
playSound
in interfaceForwardingAudience
- Parameters:
sound
- a soundemitter
- an emitter
-
stopSound
default void stopSound(@NotNull @NotNull SoundStop stop)
Description copied from interface:Audience
Stops a sound, or many sounds.- Specified by:
stopSound
in interfaceAudience
- Specified by:
stopSound
in interfaceForwardingAudience
- Parameters:
stop
- a sound stop- See Also:
SoundStop
-
openBook
default void openBook(@NotNull @NotNull Book book)
Description copied from interface:Audience
Opens a book.When possible, no item should persist after closing the book.
- Specified by:
openBook
in interfaceAudience
- Specified by:
openBook
in interfaceForwardingAudience
- Parameters:
book
- a book- See Also:
Book
-
-