Package dev.vankka.mcdiscordreserializer.renderer.implementation

Class DefaultMinecraftRenderer

java.lang.Object

dev.vankka.mcdiscordreserializer.renderer.implementation.DefaultMinecraftRenderer

All Implemented Interfaces:

MinecraftNodeRenderer, MinecraftRenderer, NodeRenderer<net.kyori.adventure.text.Component>

public class DefaultMinecraftRenderer
extends java.lang.Object
implements MinecraftRenderer

The default implementation for the MinecraftRenderer.

Field Summary

Fields

Modifier and Type	Field	Description
static DefaultMinecraftRenderer	INSTANCE	The instance of DefaultMinecraftRenderer.

Constructor Summary

Constructors

Constructor	Description
DefaultMinecraftRenderer()	Creates a new instance of the DefaultMinecraftRenderer unless you're extending the class you shouldn't use this.

Method Summary

Modifier and Type	Method	Description
net.kyori.adventure.text.Component	appendChannelMention(net.kyori.adventure.text.Component component, java.lang.String id)	Renders a channel mention and appends it to the provided Component.
net.kyori.adventure.text.Component	appendEmoteMention(net.kyori.adventure.text.Component component, java.lang.String name, java.lang.String id)	Renders a emote mention and appends it to the provided Component.
net.kyori.adventure.text.Component	appendQuote(net.kyori.adventure.text.Component component, net.kyori.adventure.text.Component content)	Adds the required formatting for quotes to the provided Component.
net.kyori.adventure.text.Component	appendRoleMention(net.kyori.adventure.text.Component component, java.lang.String id)	Renders a role mention and appends it to the provided Component.
net.kyori.adventure.text.Component	appendSpoiler(net.kyori.adventure.text.Component component, net.kyori.adventure.text.Component content)	Renders the spoiler and appends it to the provided Component.
net.kyori.adventure.text.Component	appendUserMention(net.kyori.adventure.text.Component component, java.lang.String id)	Renders a user mention and appends it to the provided Component.
net.kyori.adventure.text.Component	bold(net.kyori.adventure.text.Component component)	Renders the provided Component as bold.
net.kyori.adventure.text.Component	codeBlock(net.kyori.adventure.text.Component component)	Renders the provided Component as a code block.
net.kyori.adventure.text.Component	codeString(net.kyori.adventure.text.Component component)	Renders the provided Component as a code string.
net.kyori.adventure.text.Component	italics(net.kyori.adventure.text.Component component)	Renders the provided Component as italics.
net.kyori.adventure.text.Component	strikethrough(net.kyori.adventure.text.Component component)	Renders the provided Component as strikethrough.
net.kyori.adventure.text.Component	underline(net.kyori.adventure.text.Component component)	Renders the provided Component as underlined.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.vankka.mcdiscordreserializer.renderer.MinecraftRenderer

render

Methods inherited from interface dev.vankka.mcdiscordreserializer.renderer.NodeRenderer

renderAfterChildren

Field Detail

INSTANCE

public static final DefaultMinecraftRenderer INSTANCE

The instance of DefaultMinecraftRenderer.

Constructor Detail

DefaultMinecraftRenderer

public DefaultMinecraftRenderer()

Creates a new instance of the DefaultMinecraftRenderer unless you're extending the class you shouldn't use this.

See Also:

INSTANCE

Method Detail

strikethrough

public net.kyori.adventure.text.Component strikethrough(net.kyori.adventure.text.Component component)

Description copied from interface: MinecraftRenderer

Renders the provided Component as strikethrough.

Specified by:

strikethrough in interface MinecraftRenderer

Parameters:

component - the Component to render as strikethrough

Returns:

the strikethrough Component or null if this renderer does not process that kinds of styles

underline

public net.kyori.adventure.text.Component underline(net.kyori.adventure.text.Component component)

Description copied from interface: MinecraftRenderer

Renders the provided Component as underlined.

Specified by:

underline in interface MinecraftRenderer

Parameters:

component - the Component to render as underlined

Returns:

the underlined Component or null if this renderer does not process that kinds of styles

italics

public net.kyori.adventure.text.Component italics(net.kyori.adventure.text.Component component)

Description copied from interface: MinecraftRenderer

Renders the provided Component as italics.

Specified by:

italics in interface MinecraftRenderer

Parameters:

component - the Component to render as italics

Returns:

the italics Component or null if this renderer does not process that kinds of styles

bold

public net.kyori.adventure.text.Component bold(net.kyori.adventure.text.Component component)

Description copied from interface: MinecraftRenderer

Renders the provided Component as bold.

Specified by:

bold in interface MinecraftRenderer

Parameters:

component - the Component to render as bold

Returns:

the bold Component or null if this renderer does not process that kinds of styles

codeString

public net.kyori.adventure.text.Component codeString(net.kyori.adventure.text.Component component)

Description copied from interface: MinecraftRenderer

Renders the provided Component as a code string.

Specified by:

codeString in interface MinecraftRenderer

Parameters:

component - the Component to render the code string to

Returns:

the code stringed Component or null if this renderer does not process that kinds of styles

codeBlock

public net.kyori.adventure.text.Component codeBlock(net.kyori.adventure.text.Component component)

Description copied from interface: MinecraftRenderer

Renders the provided Component as a code block.

Specified by:

codeBlock in interface MinecraftRenderer

Parameters:

component - the Component to render as a code block

Returns:

the code blocked Component or null if this renderer does not process that kinds of styles

appendSpoiler

public net.kyori.adventure.text.Component appendSpoiler(net.kyori.adventure.text.Component component,
                                                        net.kyori.adventure.text.Component content)

Description copied from interface: MinecraftRenderer

Renders the spoiler and appends it to the provided Component.

Specified by:

appendSpoiler in interface MinecraftRenderer

Parameters:

component - the Component to render the spoiler to

content - the content of the spoiler

Returns:

the spoiler'ed Component or null if this renderer does not process that kinds of styles

appendQuote

public net.kyori.adventure.text.Component appendQuote(net.kyori.adventure.text.Component component,
                                                      net.kyori.adventure.text.Component content)

Description copied from interface: MinecraftRenderer

Adds the required formatting for quotes to the provided Component.

Specified by:

appendQuote in interface MinecraftRenderer

Parameters:

component - the Component to render to

content - the content of the quote

Returns:

the Component with the quote rendered or null if this renderer does not process that kinds of styles

appendEmoteMention

public net.kyori.adventure.text.Component appendEmoteMention(net.kyori.adventure.text.Component component,
                                                             java.lang.String name,
                                                             java.lang.String id)

Description copied from interface: MinecraftRenderer

Renders a emote mention and appends it to the provided Component.

Specified by:

appendEmoteMention in interface MinecraftRenderer

Parameters:

component - the Component to render to

name - the name of the emote

id - the id of the emote

Returns:

the Component with emote rendered or null if this renderer does not process that kinds of styles

appendChannelMention

public net.kyori.adventure.text.Component appendChannelMention(net.kyori.adventure.text.Component component,
                                                               java.lang.String id)

Description copied from interface: MinecraftRenderer

Renders a channel mention and appends it to the provided Component.

Specified by:

appendChannelMention in interface MinecraftRenderer

Parameters:

component - the Component to render to

id - the id of the channel

Returns:

the Component with the channel mention rendered or null if this renderer does not process that kinds of styles

appendUserMention

public net.kyori.adventure.text.Component appendUserMention(net.kyori.adventure.text.Component component,
                                                            java.lang.String id)

Description copied from interface: MinecraftRenderer

Renders a user mention and appends it to the provided Component.

Specified by:

appendUserMention in interface MinecraftRenderer

Parameters:

component - the Component to render to

id - the id of the user

Returns:

the Component with the user mention rendered or null if this renderer does not process that kinds of styles

appendRoleMention

public net.kyori.adventure.text.Component appendRoleMention(net.kyori.adventure.text.Component component,
                                                            java.lang.String id)

Description copied from interface: MinecraftRenderer

Renders a role mention and appends it to the provided Component.

Specified by:

appendRoleMention in interface MinecraftRenderer

Parameters:

component - the Component to render to

id - the id of the role

Returns:

the Component with the role mention rendered or null if this renderer does not process that kinds of styles