Package net.kyori.adventure.text
Interface SelectorComponent
- All Superinterfaces:
Buildable<SelectorComponent,
,SelectorComponent.Builder> BuildableComponent<SelectorComponent,
,SelectorComponent.Builder> Component
,ComponentBuilderApplicable
,ComponentLike
,net.kyori.examination.Examinable
,HoverEventSource<Component>
,ScopedComponent<SelectorComponent>
,StyleGetter
,StyleSetter<Component>
public interface SelectorComponent
extends BuildableComponent<SelectorComponent,SelectorComponent.Builder>, ScopedComponent<SelectorComponent>
A component that can display the name of entities found with a given selector.
This component consists of:
- selector
- a Minecraft selector.(e.g
@p
,@a
)
This component is rendered serverside and can therefore receive platform-defined context. See the documentation for your respective platform for more info
- Since:
- 4.0.0
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
A selector component builder. -
Field Summary
Fields inherited from interface net.kyori.adventure.text.Component
EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY
-
Method Summary
Modifier and TypeMethodDescriptiondefault @NotNull Stream<? extends net.kyori.examination.ExaminableProperty>
@NotNull String
pattern()
Gets the selector pattern.@NotNull SelectorComponent
Sets the selector pattern.@Nullable Component
Gets the separator.@NotNull SelectorComponent
separator
(@Nullable ComponentLike separator) Sets the separator.Methods inherited from interface net.kyori.adventure.text.BuildableComponent
toBuilder
Methods inherited from interface net.kyori.adventure.text.Component
appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, asHoverEvent, children, clickEvent, color, compact, componentBuilderApply, contains, contains, decoration, decorationIfAbsent, decorations, decorations, detectCycle, font, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, shadowColor, spliterator, spliterator, style, style
Methods inherited from interface net.kyori.examination.Examinable
examinableName, examine
Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource
asHoverEvent
Methods inherited from interface net.kyori.adventure.text.ScopedComponent
append, append, append, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style
Methods inherited from interface net.kyori.adventure.text.format.StyleSetter
decorate, decorations
-
Method Details
-
pattern
Gets the selector pattern.- Returns:
- the selector pattern
- Since:
- 4.0.0
-
pattern
Sets the selector pattern.- Parameters:
pattern
- the selector pattern- Returns:
- a selector component
- Since:
- 4.0.0
-
separator
Gets the separator.- Returns:
- the separator
- Since:
- 4.8.0
-
separator
Sets the separator.- Parameters:
separator
- the separator- Returns:
- the separator
- Since:
- 4.8.0
-
examinableProperties
@NotNull default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()- Specified by:
examinableProperties
in interfaceComponent
- Specified by:
examinableProperties
in interfacenet.kyori.examination.Examinable
-