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 ForwardingAudience

ForwardingAudience.Single

Method Summary

Modifier and Type	Method	Description
Audience	audience()	Gets the audience.
default Iterable<? extends Audience>	audiences()	Gets the audiences.
default void	clearResourcePacks()	Clear all server-provided resource packs that have been sent to this user.
default void	clearTitle()	Clears the title, if one is being displayed.
default void	closeDialog()	Closes the dialog that is currently being shown to this audience, if any.
default void	deleteMessage(SignedMessage.Signature signature)	Requests deletion of a message with the provided SignedMessage.Signature.
default Audience	filterAudience(Predicate<? super Audience> filter)	Filters this audience.
default void	forEachAudience(Consumer<? super Audience> action)	Executes an action against all audiences.
default <T> Optional<T>	get(Pointer<T> pointer)	Gets the value of pointer.
default <T> @Nullable T	getOrDefault(Pointer<T> pointer, @Nullable T defaultValue)	Gets the value of pointer.
default <T> @UnknownNullability T	getOrDefaultFrom(Pointer<T> pointer, Supplier<? extends T> defaultValue)	Gets the value of pointer.
default void	hideBossBar(BossBar bar)	Hides a boss bar.
default void	openBook(Book book)	Opens a book.
default void	playSound(Sound sound)	Plays a sound at the location of the recipient of the sound.
default void	playSound(Sound sound, double x, double y, double z)	Plays a sound at a location.
default void	playSound(Sound sound, Sound.Emitter emitter)	Plays a sound from an emitter, usually an entity.
default Pointers	pointers()	Gets the pointers for this object.
default void	removeResourcePacks(Iterable<UUID> ids)	Clear resource packs with the provided ids if they are present.
default void	removeResourcePacks(UUID id, UUID... others)	Clear resource packs with the provided ids if they are present.
default void	resetTitle()	Resets the title and timings back to their default.
default void	sendActionBar(Component message)	Sends a message on the action bar.
default void	sendMessage(SignedMessage signedMessage, ChatType.Bound boundChatType)	Sends a signed player message to this Audience with the provided bound chat type.
default void	sendMessage(Component message)	Sends a system chat message to this Audience.
default void	sendMessage(Component message, ChatType.Bound boundChatType)	Sends a message to this Audience with the provided bound chat type.
default void	sendPlayerListFooter(Component footer)	Sends the player list footer.
default void	sendPlayerListHeader(Component header)	Sends the player list header.
default void	sendPlayerListHeaderAndFooter(Component header, Component footer)	Sends the player list header and footer.
default void	sendResourcePacks(ResourcePackRequest request)	Sends a request to apply resource packs to this audience.
default <T> void	sendTitlePart(TitlePart<T> part, T value)	Shows a part of a title.
default void	showBossBar(BossBar bar)	Shows a boss bar.
default void	showDialog(DialogLike dialog)	Shows a dialog to this audience.
default void	stopSound(SoundStop stop)	Stops a sound, or many sounds.

Methods inherited from interface Audience

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

Method Details

audience

Audience audience()

Gets the audience.

Returns:

the audience

Since:

4.0.0

audiences

default Iterable<? extends Audience> audiences()

Description copied from interface: ForwardingAudience

Gets the audiences.

Specified by:

audiences in interface ForwardingAudience

Returns:

the audiences

get

default <T> Optional<T> get(Pointer<T> pointer)

Description copied from interface: Pointered

Gets the value of pointer.

Specified by:

get in interface Pointered

Type Parameters:

T - the type

Parameters:

pointer - the pointer

Returns:

the value

getOrDefault

@Contract("_, null -> null; _, !null -> !null")
default <T> @Nullable T getOrDefault(Pointer<T> pointer,
 @Nullable T defaultValue)

Description copied from interface: Pointered

Gets the value of pointer.

If this Audience is unable to provide a value for pointer, defaultValue will be returned.

Specified by:

getOrDefault in interface Pointered

Type Parameters:

T - the type

Parameters:

pointer - the pointer

defaultValue - the default value

Returns:

the value

getOrDefaultFrom

default <T> @UnknownNullability T getOrDefaultFrom(Pointer<T> pointer,
 Supplier<? extends T> defaultValue)

Description copied from interface: Pointered

Gets the value of pointer.

If this Audience is unable to provide a value for pointer, the value supplied by defaultValue will be returned.

Specified by:

getOrDefaultFrom in interface Pointered

Type Parameters:

T - the type

Parameters:

pointer - the pointer

defaultValue - the default value supplier

Returns:

the value

filterAudience

default Audience filterAudience(Predicate<? super Audience> filter)

Description copied from interface: Audience

Filters this audience.

The returned Audience may be the same, or a completely different one.

Container audiences such as ForwardingAudience may or may not have their own identity. If they do, they may test themselves against the provided filter first, and if the test fails return an empty audience skipping any contained children. If they do not, they must not test themselves against the filter, only testing their children.

Specified by:

filterAudience in interface Audience

Specified by:

filterAudience in interface ForwardingAudience

Parameters:

filter - a filter that determines if an audience should be included

Returns:

an audience providing a snapshot of all audiences that match the predicate when this method is invoked

forEachAudience

default void forEachAudience(Consumer<? super Audience> action)

Description copied from interface: Audience

Executes an action against all audiences.

If you implement Audience and not ForwardingAudience in your own code, and your audience forwards to other audiences, then you must override this method and provide each audience to action.

If an implementation of Audience has its own identity distinct from its contained children, it may test itself against the provided filter first, and if the test fails return an empty audience skipping any contained children. If it does not, it must not test itself against the filter, only testing its children.

Specified by:

forEachAudience in interface Audience

Specified by:

forEachAudience in interface ForwardingAudience

Parameters:

action - the action

pointers

default Pointers pointers()

Description copied from interface: Pointered

Gets the pointers for this object.

Specified by:

pointers in interface ForwardingAudience

Specified by:

pointers in interface Pointered

Returns:

the pointers

sendMessage

default void sendMessage(Component message)

Description copied from interface: Audience

Sends a system chat message to this Audience.

Specified by:

sendMessage in interface Audience

Specified by:

sendMessage in interface ForwardingAudience

Parameters:

message - a message

See Also:

• Component

sendMessage

default void sendMessage(Component message,
 ChatType.Bound boundChatType)

Description copied from interface: Audience

Sends a message to this Audience with the provided bound chat type.

Specified by:

sendMessage in interface Audience

Specified by:

sendMessage in interface ForwardingAudience

Parameters:

message - the component content

boundChatType - the bound chat type

sendMessage

default void sendMessage(SignedMessage signedMessage,
 ChatType.Bound boundChatType)

Description copied from interface: Audience

Sends a signed player message to this Audience with the provided bound chat type.

Specified by:

sendMessage in interface Audience

Specified by:

sendMessage in interface ForwardingAudience

Parameters:

signedMessage - the signed message data

boundChatType - the bound chat type

deleteMessage

default void deleteMessage(SignedMessage.Signature signature)

Description copied from interface: Audience

Requests deletion of a message with the provided SignedMessage.Signature.

Specified by:

deleteMessage in interface Audience

Specified by:

deleteMessage in interface ForwardingAudience

Parameters:

signature - the signature

sendActionBar

default void sendActionBar(Component message)

Description copied from interface: Audience

Sends a message on the action bar.

Specified by:

sendActionBar in interface Audience

Specified by:

sendActionBar in interface ForwardingAudience

Parameters:

message - a message

See Also:

• Component

sendPlayerListHeader

default void sendPlayerListHeader(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 use Audience.sendPlayerListHeaderAndFooter(Component, Component).

Specified by:

sendPlayerListHeader in interface Audience

Specified by:

sendPlayerListHeader in interface ForwardingAudience

Parameters:

header - the header

sendPlayerListFooter

default void sendPlayerListFooter(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 use Audience.sendPlayerListHeaderAndFooter(Component, Component).

Specified by:

sendPlayerListFooter in interface Audience

Specified by:

sendPlayerListFooter in interface ForwardingAudience

Parameters:

footer - the footer

sendPlayerListHeaderAndFooter

default void sendPlayerListHeaderAndFooter(Component header,
 Component footer)

Description copied from interface: Audience

Sends the player list header and footer.

Specified by:

sendPlayerListHeaderAndFooter in interface Audience

Specified by:

sendPlayerListHeaderAndFooter in interface ForwardingAudience

Parameters:

header - the header

footer - the footer

sendTitlePart

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

Description copied from interface: Audience

Shows a part of a title.

Specified by:

sendTitlePart in interface Audience

Specified by:

sendTitlePart in interface ForwardingAudience

Type Parameters:

T - the type of the value of the part

Parameters:

part - the part

value - the value

clearTitle

default void clearTitle()

Description copied from interface: Audience

Clears the title, if one is being displayed.

Specified by:

clearTitle in interface Audience

Specified by:

clearTitle in interface ForwardingAudience

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 interface Audience

Specified by:

resetTitle in interface ForwardingAudience

See Also:

• Title

showBossBar

default void showBossBar(BossBar bar)

Description copied from interface: Audience

Shows a boss bar.

Specified by:

showBossBar in interface Audience

Specified by:

showBossBar in interface ForwardingAudience

Parameters:

bar - a boss bar

See Also:

• BossBar

hideBossBar

default void hideBossBar(BossBar bar)

Description copied from interface: Audience

Hides a boss bar.

Specified by:

hideBossBar in interface Audience

Specified by:

hideBossBar in interface ForwardingAudience

Parameters:

bar - a boss bar

See Also:

• BossBar

playSound

default void playSound(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) with Sound.Emitter.self().

Specified by:

playSound in interface Audience

Specified by:

playSound in interface ForwardingAudience

Parameters:

sound - a sound

See Also:

• Sound

playSound

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

Description copied from interface: Audience

Plays a sound at a location.

Specified by:

playSound in interface Audience

Specified by:

playSound in interface ForwardingAudience

Parameters:

sound - a sound

x - x coordinate

y - y coordinate

z - z coordinate

See Also:

• Sound

playSound

default void playSound(Sound sound,
 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().

Specified by:

playSound in interface Audience

Specified by:

playSound in interface ForwardingAudience

Parameters:

sound - a sound

emitter - an emitter

stopSound

default void stopSound(SoundStop stop)

Description copied from interface: Audience

Stops a sound, or many sounds.

Specified by:

stopSound in interface Audience

Specified by:

stopSound in interface ForwardingAudience

Parameters:

stop - a sound stop

See Also:

• SoundStop

openBook

default void openBook(Book book)

Description copied from interface: Audience

Opens a book.

When possible, no item should persist after closing the book.

Specified by:

openBook in interface Audience

Specified by:

openBook in interface ForwardingAudience

Parameters:

book - a book

See Also:

• Book

sendResourcePacks

default void sendResourcePacks(ResourcePackRequest request)

Description copied from interface: Audience

Sends a request to apply resource packs to this audience.

Multiple resource packs are only supported since 1.20.3. On older versions, all requests behave as if ResourcePackRequest.replace() is set to true.

Specified by:

sendResourcePacks in interface Audience

Specified by:

sendResourcePacks in interface ForwardingAudience

Parameters:

request - the resource pack request

See Also:

• ResourcePackInfo

removeResourcePacks

default void removeResourcePacks(Iterable<UUID> ids)

Description copied from interface: Audience

Clear resource packs with the provided ids if they are present.

Specified by:

removeResourcePacks in interface Audience

Specified by:

removeResourcePacks in interface ForwardingAudience

Parameters:

ids - the ids of resource packs to remove

removeResourcePacks

default void removeResourcePacks(UUID id,
 UUID... others)

Description copied from interface: Audience

Clear resource packs with the provided ids if they are present.

Specified by:

removeResourcePacks in interface Audience

Specified by:

removeResourcePacks in interface ForwardingAudience

Parameters:

id - the id

others - the ids of any additional resource packs

clearResourcePacks

default void clearResourcePacks()

Description copied from interface: Audience

Clear all server-provided resource packs that have been sent to this user.

Specified by:

clearResourcePacks in interface Audience

Specified by:

clearResourcePacks in interface ForwardingAudience

showDialog

default void showDialog(DialogLike dialog)

Description copied from interface: Audience

Shows a dialog to this audience.

This method exists to allow initial native support for dialogs until Adventure has full API to support building and sending dialogs.

Specified by:

showDialog in interface Audience

Specified by:

showDialog in interface ForwardingAudience

Parameters:

dialog - the dialog

closeDialog

default void closeDialog()

Description copied from interface: Audience

Closes the dialog that is currently being shown to this audience, if any.

This will return the user to the previous dialog if one was opened from the current dialog.

Specified by:

closeDialog in interface Audience

Specified by:

closeDialog in interface ForwardingAudience