Home Commands Examples Getting Started With Scripts Global Keywords

Component

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.

script.zs
import crafttweaker.api.text.Component;

Implemented Interfaces

Component implements the following interfaces. That means all methods defined in these interfaces are also available in Component

Static Methods

Return Type: MutableComponent

script.zs
// Component.empty() as MutableComponent
Component.empty();

Return Type: MutableComponent

script.zs
Component.keybind(name as string) as MutableComponent
ParameterType
Parameter
name
Type
string

Return Type: MutableComponent

script.zs
Component.literal(content as string) as MutableComponent
ParameterType
Parameter
content
Type
string

Return Type: Component

script.zs
Component.nullToEmpty(content as string?) as Component
ParameterType
Parameter
content
Type
string?

Return Type: MutableComponent

script.zs
Component.score(name as string, objective as string) as MutableComponent
ParameterType
Parameter
name
Type
string
Parameter
objective
Type
string

Return Type: MutableComponent

script.zs
Component.selector(pattern as string, separator as Component?) as MutableComponent
ParameterTypeOptional
Parameter
pattern
Type
string
Optional
false
Parameter
separator
Type
Component?
Optional
true

Return Type: MutableComponent

script.zs
Component.translatable(content as string, args as Component[]) as MutableComponent
ParameterType
Parameter
content
Type
string
Parameter
args
Type
Component[]

Return Type: MutableComponent

script.zs
Component.translatable(content as string, args as string[]) as MutableComponent
ParameterType
Parameter
content
Type
string
Parameter
args
Type
string[]

Methods

Return Type: MutableComponent

script.zs
// Component.copy() as MutableComponent
myComponent.copy();

Return Type: ComponentContents

script.zs
// Component.getContents() as ComponentContents
myComponent.getContents();

Return Type: stdlib.List<Component>

script.zs
// Component.getSiblings() as stdlib.List<Component>
myComponent.getSiblings();

Return Type: string

script.zs
Component.getString(maxLength as int) as string
ParameterType
Parameter
maxLength
Type
int

Return Type: Style

script.zs
// Component.getStyle() as Style
myComponent.getStyle();

Return Type: MutableComponent

script.zs
// Component.plainCopy() as MutableComponent
myComponent.plainCopy();

Properties

NameTypeHas GetterHas Setter
Name
contents
Type
ComponentContents
Has Getter
true
Has Setter
false
Name
siblings
Type
stdlib.List<Component>
Has Getter
true
Has Setter
false
Name
style
Type
Style
Has Getter
true
Has Setter
false