Package com.datdeveloper.datmoddingapi.util

Class DatMessageFormatter

java.lang.Object

com.datdeveloper.datmoddingapi.util.DatMessageFormatter

public class DatMessageFormatter
extends Object

A class for formatting

Constructor Summary

Constructors

Constructor	Description
DatMessageFormatter(String formatString, Object... args)

Method Summary

Modifier and Type	Method	Description
static net.minecraft.network.chat.Component	formatChatString(String formatString, Object... args)	Format the given chat string into a chat component using objects passed as arguments
net.minecraft.network.chat.Component	parse()	Parse the given formatString using the arguments

Methods inherited from class java.lang.Object

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

Constructor Details

DatMessageFormatter

public DatMessageFormatter(String formatString,
 Object... args)

Parameters:

formatString - The string to be formatted

args - Arguments to be used to format the string

Method Details

formatChatString

public static net.minecraft.network.chat.Component formatChatString(String formatString,
 Object... args)

Format the given chat string into a chat component using objects passed as arguments

A shortcut function for DatMessageFormatter(java.lang.String, java.lang.Object...)

When an error is encountered in the DatMessageFormatter(java.lang.String, java.lang.Object...), it is caught and dumped in the chat message.

DatMessageFormatter(java.lang.String, java.lang.Object...) should be used directly if you desire handling the error yourself.

Parameters:

formatString - The string that is processed

args - The arguments to use to format the string

Returns:

A chat component containing the formatted text

See Also:

• DatMessageFormatter(java.lang.String, java.lang.Object...)

parse

public net.minecraft.network.chat.Component parse()
                                           throws ChatParseException

Parse the given formatString using the arguments

Returns:

The processed message

Throws:

ChatParseException - Thrown when an exception is encountered whilst parsing the string