MCTextComponent - CraftTweaker Documentation

Version:

Language:

Home Migration Guide Getting Started With Scripts Commands Examples

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.util.text.MCTextComponent;

Static Methods

createStringTextComponent

Name: createStringTextComponent

Return Type: MCTextComponent

ZenScript
 Copy
MCTextComponent.createStringTextComponent(text as string) as MCTextComponent

Parameter	Type	Description
Parameter text	Type string	Description No Description Provided

createTranslationTextComponent

Name: createTranslationTextComponent

Return Type: MCTextComponent

ZenScript
 Copy
MCTextComponent.createTranslationTextComponent(translationKey as string) as MCTextComponent

Parameter	Type	Description
Parameter translationKey	Type string	Description No Description Provided

createTranslationTextComponent

Name: createTranslationTextComponent

Return Type: MCTextComponent

ZenScript
 Copy
MCTextComponent.createTranslationTextComponent(translationKey as string, args as Object[]) as MCTextComponent

Parameter	Type	Description
Parameter translationKey	Type string	Description No Description Provided
Parameter args	Type Object[]	Description No Description Provided

Casters

Result type	Is Implicit
Result type string	Is Implicit false

Methods

appendSibling

Name: appendSibling

Return Type: MCTextComponent

ZenScript
 Copy
MCTextComponent.appendSibling(component as MCTextComponent) as MCTextComponent

Parameter	Type	Description
Parameter component	Type MCTextComponent	Description No Description Provided

appendText

Name: appendText

Return Type: MCTextComponent

ZenScript
 Copy
MCTextComponent.appendText(text as string) as MCTextComponent

Parameter	Type	Description
Parameter text	Type string	Description No Description Provided

copyRaw

Name: copyRaw

Return Type: MCTextComponent

ZenScript
 Copy
// MCTextComponent.copyRaw() as MCTextComponent

MCTextComponent.createStringTextComponent("Hello World!").copyRaw();

deepCopy

Name: deepCopy

Return Type: MCTextComponent

ZenScript
 Copy
// MCTextComponent.deepCopy() as MCTextComponent

MCTextComponent.createStringTextComponent("Hello World!").deepCopy();

getString

Name: getString

Return Type: string

ZenScript
 Copy
// MCTextComponent.getString() as string

MCTextComponent.createStringTextComponent("Hello World!").getString();

getStringTruncated

Name: getStringTruncated

Return Type: string

ZenScript
 Copy
MCTextComponent.getStringTruncated(maxLen as int) as string

Parameter	Type	Description
Parameter maxLen	Type int	Description No Description Provided

getStyle

Name: getStyle

Return Type: MCStyle

ZenScript
 Copy
// MCTextComponent.getStyle() as MCStyle

MCTextComponent.createStringTextComponent("Hello World!").getStyle();

getTranslationKey

Name: getTranslationKey

If this is a Translation Text Component, return the actual translation key used for localization. If this is not a Translation Text Component, returns an empty string.

Returns: the translation key or an empty string.
Return Type: string

ZenScript
 Copy
// MCTextComponent.getTranslationKey() as string

MCTextComponent.createStringTextComponent("Hello World!").getTranslationKey();

getUnformattedComponentText

Name: getUnformattedComponentText

Return Type: string

ZenScript
 Copy
// MCTextComponent.getUnformattedComponentText() as string

MCTextComponent.createStringTextComponent("Hello World!").getUnformattedComponentText();

setStyle

Name: setStyle

Return Type: MCTextComponent

ZenScript
 Copy
MCTextComponent.setStyle(style as MCStyle) as MCTextComponent

Parameter	Type	Description
Parameter style	Type MCStyle	Description No Description Provided

Operators

ADD

Name: ADD

ZenScript
 Copy
myMCTextComponent + component as MCTextComponent

CAT

Name: CAT

ZenScript
 Copy
myMCTextComponent ~ component as MCTextComponent

SHL

Name: SHL

ZenScript
 Copy
myMCTextComponent << component as MCTextComponent

Properties

Name	Type	Has Getter	Has Setter	Description
Name formattedText	Type string	Has Getter true	Has Setter false	Description No Description Provided
Name siblings	Type stdlib.List<MCTextComponent>	Has Getter true	Has Setter false	Description No Description Provided
Name style	Type MCStyle	Has Getter true	Has Setter false	Description No Description Provided
Name translationKey	Type string	Has Getter true	Has Setter false	Description If this is a Translation Text Component, return the actual translation key used for localization. If this is not a Translation Text Component, returns an empty string.
Name unformattedComponentText	Type string	Has Getter true	Has Setter false	Description No Description Provided