com.viaversion.viaversion.libs.mcstructs.text.components

Class KeybindComponent

java.lang.Object

com.viaversion.viaversion.libs.mcstructs.text.TextComponent

com.viaversion.viaversion.libs.mcstructs.text.components.KeybindComponent

All Implemented Interfaces:

com.viaversion.viaversion.libs.mcstructs.core.Copyable<TextComponent>

public class KeybindComponent
extends TextComponent

Nested Class Summary

Nested classes/interfaces inherited from class com.viaversion.viaversion.libs.mcstructs.text.TextComponent

TextComponent.ComponentConsumer

Constructor Summary

Constructors

Constructor and Description
KeybindComponent(java.lang.String keybind)
KeybindComponent(java.lang.String keybind, Translator translator)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asSingleString()
java.lang.String	getKeybind()
KeybindComponent	setKeybind(java.lang.String keybind) Set the keybind of this component.
KeybindComponent	setTranslator(Translator translator) Set the translator function used to translate the key.
TextComponent	shallowCopy() Create a shallow copy of this component. This will only copy the component itself (including style) and not its siblings.
java.lang.String	toString()

Methods inherited from class com.viaversion.viaversion.libs.mcstructs.text.TextComponent

append, append, append, append, asLegacyFormatString, asSingleString, asUnformattedString, asUnformattedString, atlasSprite, atlasSprite, atlasSprite, atlasSprite, blockNbt, blockNbt, copy, copyMetaTo, empty, entityNbt, entityNbt, forEach, formatted, getSiblings, getStyle, keybind, mergeSiblingParentStyle, of, of, of, of, score, score, selector, selector, setParentStyle, setSiblingParentStyle, setStyle, storageNbt, storageNbt, styled, translation, translation, visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KeybindComponent

public KeybindComponent(java.lang.String keybind)

KeybindComponent

public KeybindComponent(java.lang.String keybind,
                        @Nonnull
                        Translator translator)

Method Detail

getKeybind

public java.lang.String getKeybind()

Returns:

The keybind of this component

setKeybind

public KeybindComponent setKeybind(java.lang.String keybind)

Set the keybind of this component.

Parameters:

keybind - The keybind

Returns:

This component

setTranslator

public KeybindComponent setTranslator(@Nullable
                                      Translator translator)

Set the translator function used to translate the key.

Parameters:

translator - The translator function

Returns:

This component

asSingleString

public java.lang.String asSingleString()

Specified by:

asSingleString in class TextComponent

Returns:

An unformatted string representation of this component

shallowCopy

public TextComponent shallowCopy()

Description copied from class: TextComponent

Create a shallow copy of this component.
This will only copy the component itself (including style) and not its siblings.

Specified by:

shallowCopy in class TextComponent

Returns:

The shallow copy

toString

public java.lang.String toString()

Specified by:

toString in class TextComponent