Class FacetAudience<V>
java.lang.Object
net.kyori.adventure.platform.facet.FacetAudience<V>
- Type Parameters:
V
- a viewer type
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Audience
,Pointered
An
Audience
that is implemented by Facet
s.
This audience must support multiple viewers, although platforms do not use this feature yet.
This is not supported API. Subject to change at any time.
- Since:
- 4.0.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final @NotNull FacetAudienceProvider<V,
FacetAudience<V>> -
Constructor Summary
ConstructorDescriptionFacetAudience
(@NotNull FacetAudienceProvider provider, @NotNull Collection<? extends V> viewers, @Nullable Collection<? extends Facet.Chat> chat, @Nullable Collection<? extends Facet.ActionBar> actionBar, @Nullable Collection<? extends Facet.Title> title, @Nullable Collection<? extends Facet.Sound> sound, @Nullable Collection<? extends Facet.EntitySound> entitySound, @Nullable Collection<? extends Facet.Book> book, @Nullable Collection<? extends Facet.BossBar.Builder> bossBar, @Nullable Collection<? extends Facet.TabList> tabList, @Nullable Collection<? extends Facet.Pointers> pointerProviders) Create a new facet-based audience. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a member to this audience.void
void
close()
protected void
contributePointers
(Pointers.Builder builder) void
hideBossBar
(@NotNull BossBar bar) void
void
void
void
playSound
(@NotNull Sound sound, @NotNull Sound.Emitter emitter) @NotNull Pointers
pointers()
void
refresh()
Refresh the audience.void
removeViewer
(V viewer) Remove a viewer from this audience.void
void
sendActionBar
(@NotNull Component original) void
sendMessage
(@NotNull Identity source, @NotNull Component original, @NotNull MessageType type) void
sendPlayerListFooter
(@NotNull Component footer) void
sendPlayerListHeader
(@NotNull Component header) void
sendPlayerListHeaderAndFooter
(@NotNull Component header, @NotNull Component footer) <T> void
sendTitlePart
(@NotNull TitlePart<T> part, T value) void
showBossBar
(@NotNull BossBar bar) void
void
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
filterAudience, forEachAudience, openBook, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, stopSound
Methods inherited from interface net.kyori.adventure.pointer.Pointered
get, getOrDefault, getOrDefaultFrom
-
Field Details
-
provider
-
-
Constructor Details
-
FacetAudience
public FacetAudience(@NotNull @NotNull FacetAudienceProvider provider, @NotNull @NotNull Collection<? extends V> viewers, @Nullable @Nullable Collection<? extends Facet.Chat> chat, @Nullable @Nullable Collection<? extends Facet.ActionBar> actionBar, @Nullable @Nullable Collection<? extends Facet.Title> title, @Nullable @Nullable Collection<? extends Facet.Sound> sound, @Nullable @Nullable Collection<? extends Facet.EntitySound> entitySound, @Nullable @Nullable Collection<? extends Facet.Book> book, @Nullable @Nullable Collection<? extends Facet.BossBar.Builder> bossBar, @Nullable @Nullable Collection<? extends Facet.TabList> tabList, @Nullable @Nullable Collection<? extends Facet.Pointers> pointerProviders) Create a new facet-based audience.- Parameters:
provider
- for this audienceviewers
- the viewers receiving content sent to this audiencechat
- chat facet candidatesactionBar
- action bar facet candidatestitle
- title facet candidatessound
- sound facet candidatesentitySound
- entity sound facet candidatesbook
- book facet candidatesbossBar
- boss bar facet candidatestabList
- tab list facet candidatespointerProviders
- facets that provide pointers to this audience- Since:
- 4.0.0
-
-
Method Details
-
addViewer
Add a member to this audience.- Parameters:
viewer
- the viewer- Since:
- 4.0.0
-
removeViewer
Remove a viewer from this audience.- Parameters:
viewer
- the viewer to remove- Since:
- 4.0.0
-
refresh
public void refresh()Refresh the audience.- Since:
- 4.0.0
-
sendMessage
public void sendMessage(@NotNull @NotNull Identity source, @NotNull @NotNull Component original, @NotNull @NotNull MessageType type) - Specified by:
sendMessage
in interfaceAudience
-
sendActionBar
- Specified by:
sendActionBar
in interfaceAudience
-
playSound
-
playSound
-
playSound
-
stopSound
-
openBook
-
showTitle
-
sendTitlePart
- Specified by:
sendTitlePart
in interfaceAudience
-
clearTitle
public void clearTitle()- Specified by:
clearTitle
in interfaceAudience
-
resetTitle
public void resetTitle()- Specified by:
resetTitle
in interfaceAudience
-
showBossBar
- Specified by:
showBossBar
in interfaceAudience
-
hideBossBar
- Specified by:
hideBossBar
in interfaceAudience
-
sendPlayerListHeader
- Specified by:
sendPlayerListHeader
in interfaceAudience
-
pointers
-
contributePointers
-
close
public void close()- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-