Package net.kyori.adventure.text

Interface VirtualComponent

All Superinterfaces:

Buildable<TextComponent,TextComponent.Builder>, BuildableComponent<TextComponent,TextComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>, ScopedComponent<TextComponent>, StyleGetter, StyleSetter<Component>, TextComponent

@NonExtendable
public interface VirtualComponent
extends TextComponent

A virtual component.

This component type is transient and not guaranteed to survive during any sort of transformations or serialization.

Since:

4.18.0

See Also:

• Component.virtual(Class, VirtualComponentRenderer)

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.text.TextComponent

TextComponent.Builder

Field Summary

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

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
@NotNull Class<?>	contextType()	Gets the renderer context type.
@NotNull VirtualComponentRenderer<?>	renderer()	Gets the renderer.

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

toBuilder

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

asHoverEvent, children, clickEvent, color, compact, componentBuilderApply, contains, contains, decoration, decorations, detectCycle, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, shadowColor, spliterator, spliterator, 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, append, append, appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, decorationIfAbsent, decorations, font, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style, style

Methods inherited from interface net.kyori.adventure.text.format.StyleSetter

decorate, decorations

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

content, content, examinableProperties

Method Details

contextType

@NotNull
@NotNull Class<?> contextType()

Gets the renderer context type.

Returns:

the renderer context type

Since:

4.18.0

renderer

@NotNull
@NotNull VirtualComponentRenderer<?> renderer()

Gets the renderer.

Returns:

the renderer

Since:

4.18.0