Style - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.text.Style;

Static Methods

empty

Name: empty

Return Type: Style

ZenScript
 Copy
// Style.empty() as Style

Style.empty();

Methods

applyFormat

Name: applyFormat

Return Type: Style

ZenScript
 Copy
Style.applyFormat(format as ChatFormatting) as Style

Parameter	Type
Parameter format	Type ChatFormatting

applyFormats

Name: applyFormats

Return Type: Style

ZenScript
 Copy
Style.applyFormats(formattings as ChatFormatting[]) as Style

Parameter	Type
Parameter formattings	Type ChatFormatting[]

applyLegacyFormat

Name: applyLegacyFormat

Return Type: Style

ZenScript
 Copy
Style.applyLegacyFormat(format as ChatFormatting) as Style

Parameter	Type
Parameter format	Type ChatFormatting

applyTo

Name: applyTo

Return Type: Style

ZenScript
 Copy
Style.applyTo(style as Style) as Style

Parameter	Type
Parameter style	Type Style

getColor

Name: getColor

Return Type: TextColor?

ZenScript
 Copy
// Style.getColor() as TextColor?

myStyle.getColor();

getFont

Name: getFont

Return Type: ResourceLocation

ZenScript
 Copy
// Style.getFont() as ResourceLocation

myStyle.getFont();

getInsertion

Name: getInsertion

Return Type: string?

ZenScript
 Copy
// Style.getInsertion() as string?

myStyle.getInsertion();

isBold

Name: isBold

Return Type: boolean

ZenScript
 Copy
// Style.isBold() as boolean

myStyle.isBold();

isEmpty

Name: isEmpty

Return Type: boolean

ZenScript
 Copy
// Style.isEmpty() as boolean

myStyle.isEmpty();

isItalic

Name: isItalic

Return Type: boolean

ZenScript
 Copy
// Style.isItalic() as boolean

myStyle.isItalic();

isObfuscated

Name: isObfuscated

Return Type: boolean

ZenScript
 Copy
// Style.isObfuscated() as boolean

myStyle.isObfuscated();

isStrikethrough

Name: isStrikethrough

Return Type: boolean

ZenScript
 Copy
// Style.isStrikethrough() as boolean

myStyle.isStrikethrough();

isUnderlined

Name: isUnderlined

Return Type: boolean

ZenScript
 Copy
// Style.isUnderlined() as boolean

myStyle.isUnderlined();

setBold

Name: setBold

Return Type: Style

ZenScript
 Copy
// Style.setBold() as Style

myStyle.setBold();

setItalic

Name: setItalic

Return Type: Style

ZenScript
 Copy
// Style.setItalic() as Style

myStyle.setItalic();

setObfuscated

Name: setObfuscated

Return Type: Style

ZenScript
 Copy
// Style.setObfuscated() as Style

myStyle.setObfuscated();

setStrikethrough

Name: setStrikethrough

Return Type: Style

ZenScript
 Copy
// Style.setStrikethrough() as Style

myStyle.setStrikethrough();

setUnderlined

Name: setUnderlined

Return Type: Style

ZenScript
 Copy
// Style.setUnderlined() as Style

myStyle.setUnderlined();

withBold

Name: withBold

Return Type: Style

ZenScript
 Copy
Style.withBold(value as bool?) as Style

Parameter	Type
Parameter value	Type bool?

withColor

Name: withColor

Return Type: Style

ZenScript
 Copy
Style.withColor(color as int) as Style

Parameter	Type
Parameter color	Type int

withColor

Name: withColor

Return Type: Style

ZenScript
 Copy
Style.withColor(formatting as ChatFormatting?) as Style

Parameter	Type
Parameter formatting	Type ChatFormatting?

withColor

Name: withColor

Return Type: Style

ZenScript
 Copy
Style.withColor(textColor as TextColor?) as Style

Parameter	Type
Parameter textColor	Type TextColor?

withFont

Name: withFont

Return Type: Style

ZenScript
 Copy
Style.withFont(fontId as ResourceLocation?) as Style

Parameter	Type
Parameter fontId	Type ResourceLocation?

withInsertion

Name: withInsertion

Return Type: Style

ZenScript
 Copy
Style.withInsertion(content as string?) as Style

Parameter	Type
Parameter content	Type string?

withItalic

Name: withItalic

Return Type: Style

ZenScript
 Copy
Style.withItalic(value as bool?) as Style

Parameter	Type
Parameter value	Type bool?

withObfuscated

Name: withObfuscated

Return Type: Style

ZenScript
 Copy
Style.withObfuscated(value as bool?) as Style

Parameter	Type
Parameter value	Type bool?

withStrikethrough

Name: withStrikethrough

Return Type: Style

ZenScript
 Copy
Style.withStrikethrough(value as bool?) as Style

Parameter	Type
Parameter value	Type bool?

withUnderlined

Name: withUnderlined

Return Type: Style

ZenScript
 Copy
Style.withUnderlined(value as bool?) as Style

Parameter	Type
Parameter value	Type bool?

Properties

Name	Type	Has Getter	Has Setter
Name bold	Type boolean	Has Getter true	Has Setter false
Name color	Type TextColor?	Has Getter true	Has Setter false
Name empty	Type boolean	Has Getter true	Has Setter false
Name font	Type ResourceLocation	Has Getter true	Has Setter false
Name insertion	Type string?	Has Getter true	Has Setter false
Name italic	Type boolean	Has Getter true	Has Setter false
Name obfucated	Type boolean	Has Getter true	Has Setter false
Name strikethrough	Type boolean	Has Getter true	Has Setter false
Name underlined	Type boolean	Has Getter true	Has Setter false