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>

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

Nested Classes

Modifier and Type	Interface	Description
static interface	SelectorComponent.Builder	A selector component builder.

Method Summary

Modifier and Type	Method	Description
@NonNull String	pattern()	Gets the selector pattern.
@NonNull SelectorComponent	pattern(@NonNull String pattern)	Sets the selector pattern.

Methods inherited from interface net.kyori.adventure.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.adventure.text.Component

asComponent, asHoverEvent, children, clickEvent, color, componentBuilderApply, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, style, style

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, 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, style, style, style

Method Details

pattern

@NonNull String pattern()

Gets the selector pattern.

Returns:

the selector pattern

Since:

4.0.0

pattern

@Contract(pure=true)
@NonNull SelectorComponent pattern(@NonNull String pattern)

Sets the selector pattern.

Parameters:

pattern - the selector pattern

Returns:

a selector component

Since:

4.0.0