Class SimpleMinecraftString<T, Color, U>

Simple Minecraft string.

Type Parameters

T extends string

String to apply effects on.
Color extends ColorObj = ColorObj

Color object with RGB values.
U extends SegmentOptions<Color> = SegmentOptions<Color>

Effects to apply.

Hierarchy

SimpleMinecraftString

Index

Constructors

Properties

bold color italic obfuscated strikethrough text underlined

Methods

export toString from

Constructors

constructor

new SimpleMinecraftString<T, Color, U>(text: T, options?: U): SimpleMinecraftString<T, Color, U>
Construct a Minecraft string with basic formatting & options.

Returns
A new Minecraft string with the given formatting.
Type Parameters
- T extends string
- Color extends ColorObj = ColorObj
- U extends SegmentOptions<Color, TsegmentOptions<Color>, U> = SegmentOptions<Color, TsegmentOptions<Color>>
Parameters
- text: T
  
  The text to format.
- options: U = ...
  
  The options to apply to the string.
Returns SimpleMinecraftString<T, Color, U>
- Defined in core/components/minecraft/SimpleMinecraftString.ts:70

Properties

bold

bold: U["bold"]

color

color: U["color"]

italic

italic: U["italic"]

obfuscated

obfuscated: U["obfuscated"]

strikethrough

strikethrough: U["strikethrough"]

text

text: T

The text to format.

underlined

underlined: U["underlined"]

Methods

export

export<T>(nbt: T): SimpleRawMCString<T, T>
Export the Minecraft string as a JSON object.

Returns
The serialized version of this string.
Type Parameters
- T extends boolean = false
Parameters
- nbt: T
Returns SimpleRawMCString<T, T>
- Defined in core/components/minecraft/SimpleMinecraftString.ts:83

toString

toString(altCode?: string): string
Returns
Vanilla Minecraft text with the given formatting.
Parameters
- altCode: string = "&"
  
  An alternate code symbol to use.
Returns string
- Defined in core/components/minecraft/SimpleMinecraftString.ts:99

`Static` from

from(obj: SimpleRawMCString<false, string>): SimpleMinecraftString<string, ColorObj, SegmentOptions<ColorObj, TsegmentOptions<ColorObj>>>
Parameters
- obj: SimpleRawMCString<false, string>
Returns SimpleMinecraftString<string, ColorObj, SegmentOptions<ColorObj, TsegmentOptions<ColorObj>>>
- Defined in core/components/minecraft/SimpleMinecraftString.ts:46

Generated using TypeDoc