Package com.velocitypowered.api.command

Class VelocityBrigadierMessage

java.lang.Object

com.velocitypowered.api.command.VelocityBrigadierMessage

All Implemented Interfaces:

com.mojang.brigadier.Message, ComponentLike

public final class VelocityBrigadierMessage
extends Object
implements com.mojang.brigadier.Message, ComponentLike

Represents an implementation of brigadier's Message, providing support for Component messages.

Method Summary

Modifier and Type	Method	Description
@NotNull Component	asComponent()
String	getString()	Returns the message as a plain text.
static VelocityBrigadierMessage	tooltip(Component message)	Creates a new VelocityBrigadierMessage using the given Component as the message.

Methods inherited from class java.lang.Object

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

Method Details

tooltip

public static VelocityBrigadierMessage tooltip(Component message)

Creates a new VelocityBrigadierMessage using the given Component as the message.

Parameters:

message - the component to use as the tooltip message

Returns:

a new instance of VelocityBrigadierMessage

asComponent

@NotNull
public @NotNull Component asComponent()

Specified by:

asComponent in interface ComponentLike

getString

public String getString()

Returns the message as a plain text.

Specified by:

getString in interface com.mojang.brigadier.Message

Returns:

message as plain text