Package net.kyori.adventure.text

Interface ObjectComponent

All Superinterfaces:

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

public interface ObjectComponent
extends BuildableComponent<ObjectComponent,ObjectComponent.Builder>, ScopedComponent<ObjectComponent>

Displays a non-text object.

Since:

4.25.0

Since Minecraft:

1.21.9

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ObjectComponent.Builder	An object component 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 ObjectContents	contents()	Gets the contents of this object component.
@NotNull ObjectComponent	contents(@NotNull ObjectContents contents)	Creates a copy of this object component with the given contents.
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()

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

toBuilder

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

asHoverEvent, children, clickEvent, color, compact, 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

Method Details

contents

@NotNull
@NotNull ObjectContents contents()

Gets the contents of this object component.

Returns:

the contents

Since:

4.25.0

contents

@NotNull
@NotNull ObjectComponent contents(@NotNull
 @NotNull ObjectContents contents)

Creates a copy of this object component with the given contents.

Parameters:

contents - the contents to set

Returns:

new object component

Since:

4.25.0

examinableProperties

@NotNull
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface Component

Specified by:

examinableProperties in interface net.kyori.examination.Examinable