Class MinecraftString<T>

Minecraft exportable string.

Type Parameters

T extends string

Raw string to be parsed.

Hierarchy

MinecraftString

Index

Constructors

constructor

new MinecraftString<T>(text: `§f§r${T}`, unsafe?: boolean): MinecraftString<T>
Construct a Minecraft string from a string of text, can include color and style codes.
Type Parameters
- T extends string
Parameters
- text: `§f§r${T}`
  
  The text to parse.
- unsafe: boolean = false
  
  Test the length against the Java string limit instead of Minecraft's.
Returns MinecraftString<T>
- Defined in core/components/minecraft/MinecraftString.ts:103

Properties

raw

raw: `§f§r${T}`

segments

segments: SimpleMinecraftString<string, ColorObj, SegmentOptions<ColorObj, TsegmentOptions<ColorObj>>>[] = []

The segments of the Minecraft string.

text

text: string

Clean stripped coloring & styling codes text

`Static` `Readonly` colorRegex

colorRegex: RegExp = ...

`Static` `Readonly` javaStringLimit

javaStringLimit: 2147483647 = 2_147_483_647

`Static` `Readonly` mcStringLimit

mcStringLimit: 262144 = 262_144

`Static` `Readonly` regex

regex: RegExp = ...

Regular expression to match Minecraft color & style codes.

`Static` `Readonly` styleMap

styleMap: {
    k: "obfuscated";
    l: "bold";
    m: "strikethrough";
    n: "underlined";
    o: "italic";
    r: "reset";
} = ...

Object containing the style codes and their corresponding style.

Type declaration

Readonly k: "obfuscated"
Readonly l: "bold"
Readonly m: "strikethrough"
Readonly n: "underlined"
Readonly o: "italic"
Readonly r: "reset"

`Static` `Readonly` styleRegex

styleRegex: RegExp = ...

Accessors

`Static` emptyString

get emptyString(): MinecraftString<" ">
Returns MinecraftString<" ">
- Defined in core/components/minecraft/MinecraftString.ts:74

Methods

export

export<T>(nbt?: T): RawMCString<T, string[]>
Export the Minecraft string to a list of simple Minecraft strings.

Returns
Vanilla Minecraft text with the given formatting.
Type Parameters
- T extends boolean = false
Parameters
- nbt: T = ...
Returns RawMCString<T, string[]>
- Defined in core/components/minecraft/MinecraftString.ts:152

`Static` bold

bold<T>(text: T, color?: MinecraftColor<number, number, number>): SimpleMinecraftString<T, ColorObj, {
bold: true;
color: MinecraftColor<number, number, number>;
}>
Apply the bold style to the string.

Returns
A new Minecraft string with bold text.
Type Parameters
- T extends string
Parameters
- text: T
  
  The text to bold.
- color: MinecraftColor<number, number, number> = ...
Returns SimpleMinecraftString<T, ColorObj, {
bold: true;
color: MinecraftColor<number, number, number>;
}>
- Defined in core/components/minecraft/MinecraftString.ts:43

`Static` italic

italic<T>(text: T, color?: MinecraftColor<number, number, number>): SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
italic: true;
}>
Apply the italic style to the string.

Returns
A new Minecraft string with italicized text.
Type Parameters
- T extends string
Parameters
- text: T
  
  The text to italicize.
- color: MinecraftColor<number, number, number> = ...
Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
italic: true;
}>
- Defined in core/components/minecraft/MinecraftString.ts:52

`Static` obfuscated

obfuscated<T>(text: T, color?: MinecraftColor<number, number, number>): SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
obfuscated: true;
}>
Apply the obfuscated style to the string.

Returns
A new Minecraft string with obfuscated text.
Type Parameters
- T extends string
Parameters
- text: T
  
  The text to obfuscate.
- color: MinecraftColor<number, number, number> = ...
Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
obfuscated: true;
}>
- Defined in core/components/minecraft/MinecraftString.ts:34

`Static` strikethrough

strikethrough<T>(text: T, color?: MinecraftColor<number, number, number>): SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
strikethrough: true;
}>
Apply the strikethrough style to the string.

Returns
A new Minecraft string with strikethrough text.
Type Parameters
- T extends string
Parameters
- text: T
  
  The text to strikethrough.
- color: MinecraftColor<number, number, number> = ...
Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
strikethrough: true;
}>
- Defined in core/components/minecraft/MinecraftString.ts:70

`Static` underlined

underlined<T>(text: T, color?: MinecraftColor<number, number, number>): SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
underlined: true;
}>
Apply the underline style to the string.

Returns
A new Minecraft string with underlined text.
Type Parameters
- T extends string
Parameters
- text: T
  
  The text to underline.
- color: MinecraftColor<number, number, number> = ...
Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
underlined: true;
}>
- Defined in core/components/minecraft/MinecraftString.ts:61

Class MinecraftString<T>

Minecraft exportable string.

Type Parameters

T extends string

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends string

Parameters

text: `§f§r${T}`

unsafe: boolean = false

Returns MinecraftString<T>

Properties

raw

segments

text

Static Readonly colorRegex

Static Readonly javaStringLimit

Static Readonly mcStringLimit

Static Readonly regex

Static Readonly styleMap

Type declaration

Readonly k: "obfuscated"

Readonly l: "bold"

Readonly m: "strikethrough"

Readonly n: "underlined"

Readonly o: "italic"

Readonly r: "reset"

Static Readonly styleRegex

Accessors

Static emptyString

Returns MinecraftString<" ">

Methods

export

Returns

Type Parameters

T extends boolean = false

Parameters

nbt: T = ...

Returns RawMCString<T, string[]>

Static bold

Returns

Type Parameters

T extends string

Parameters

text: T

color: MinecraftColor<number, number, number> = ...

Returns SimpleMinecraftString<T, ColorObj, { bold: true; color: MinecraftColor<number, number, number>; }>

Static italic

Returns

Type Parameters

T extends string

Parameters

text: T

color: MinecraftColor<number, number, number> = ...

Returns SimpleMinecraftString<T, ColorObj, { color: MinecraftColor<number, number, number>; italic: true; }>

Static obfuscated

Returns

Type Parameters

T extends string

Parameters

text: T

color: MinecraftColor<number, number, number> = ...

Returns SimpleMinecraftString<T, ColorObj, { color: MinecraftColor<number, number, number>; obfuscated: true; }>

Static strikethrough

Returns

Type Parameters

T extends string

Parameters

text: T

color: MinecraftColor<number, number, number> = ...

Returns SimpleMinecraftString<T, ColorObj, { color: MinecraftColor<number, number, number>; strikethrough: true; }>

Static underlined

Returns

`Static` `Readonly` colorRegex

`Static` `Readonly` javaStringLimit

`Static` `Readonly` mcStringLimit

`Static` `Readonly` regex

`Static` `Readonly` styleMap

`Readonly` k: "obfuscated"

`Readonly` l: "bold"

`Readonly` m: "strikethrough"

`Readonly` n: "underlined"

`Readonly` o: "italic"

`Readonly` r: "reset"

`Static` `Readonly` styleRegex

`Static` emptyString

`Static` bold

Returns SimpleMinecraftString<T, ColorObj, {
bold: true;
color: MinecraftColor<number, number, number>;
}>

`Static` italic

Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
italic: true;
}>

`Static` obfuscated

Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
obfuscated: true;
}>

`Static` strikethrough

Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
strikethrough: true;
}>

`Static` underlined

Returns SimpleMinecraftString<T, ColorObj, {
color: MinecraftColor<number, number, number>;
underlined: true;
}>