Class FacetAudienceProvider<V,A extends FacetAudience<V>>
java.lang.Object
net.kyori.adventure.platform.facet.FacetAudienceProvider<V,A>
- Type Parameters:
V
- the viewer typeA
- the audience type
- All Implemented Interfaces:
AutoCloseable
,Audience
,ForwardingAudience
,AudienceProvider
,Pointered
@Internal
public abstract class FacetAudienceProvider<V,A extends FacetAudience<V>>
extends Object
implements AudienceProvider, ForwardingAudience
An audience provider implementation using facets.
This is not supported API. Subject to change at any time.
- Since:
- 4.0.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.kyori.adventure.platform.AudienceProvider
AudienceProvider.Builder<P extends AudienceProvider,
B extends AudienceProvider.Builder<P, B>> Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience
ForwardingAudience.Single
-
Field Summary
Modifier and TypeFieldDescriptionprotected final ComponentRenderer<Pointered>
protected static final Locale
-
Constructor Summary
ModifierConstructorDescriptionprotected
FacetAudienceProvider
(@NotNull ComponentRenderer<Pointered> componentRenderer) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a viewer.@NotNull Audience
all()
void
close()
@NotNull Audience
console()
protected abstract A
createAudience
(@NotNull Collection<V> viewers) Creates an audience for a collection of viewers.@NotNull Audience
Creates an audience based on a viewer predicate.@NotNull Audience
permission
(@NotNull String permission) @NotNull Audience
@NotNull Audience
players()
void
refreshViewer
(V viewer) Refreshes a viewer's metadata.void
removeViewer
(V viewer) Removes a viewer.@NotNull Audience
@NotNull Audience
world
(@NotNull net.kyori.adventure.key.Key world) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.kyori.adventure.audience.Audience
openBook, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, showTitle, stopSound
Methods inherited from interface net.kyori.adventure.platform.AudienceProvider
flattener, permission
Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience
clearTitle, filterAudience, forEachAudience, hideBossBar, openBook, playSound, playSound, playSound, pointers, resetTitle, sendActionBar, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendTitlePart, showBossBar, stopSound
Methods inherited from interface net.kyori.adventure.pointer.Pointered
get, getOrDefault, getOrDefaultFrom
-
Field Details
-
DEFAULT_LOCALE
-
componentRenderer
-
viewers
-
-
Constructor Details
-
FacetAudienceProvider
-
-
Method Details
-
addViewer
Adds a viewer.- Parameters:
viewer
- a viewer- Since:
- 4.0.0
-
removeViewer
Removes a viewer.- Parameters:
viewer
- a viewer- Since:
- 4.0.0
-
refreshViewer
Refreshes a viewer's metadata.Should be called after a viewer changes their locale, world, server, etc.
- Parameters:
viewer
- a viewer- Since:
- 4.0.0
-
createAudience
Creates an audience for a collection of viewers.- Parameters:
viewers
- a collection viewers- Returns:
- an audience
-
audiences
- Specified by:
audiences
in interfaceForwardingAudience
-
all
- Specified by:
all
in interfaceAudienceProvider
-
console
- Specified by:
console
in interfaceAudienceProvider
-
players
- Specified by:
players
in interfaceAudienceProvider
-
player
- Specified by:
player
in interfaceAudienceProvider
-
filter
Creates an audience based on a viewer predicate.- Parameters:
predicate
- a predicate- Returns:
- an audience
- Since:
- 4.0.0
-
permission
- Specified by:
permission
in interfaceAudienceProvider
-
world
- Specified by:
world
in interfaceAudienceProvider
-
server
- Specified by:
server
in interfaceAudienceProvider
-
close
public void close()- Specified by:
close
in interfaceAudienceProvider
- Specified by:
close
in interfaceAutoCloseable
-