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.
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
// Component.empty() as MutableComponent
Component.empty();Return Type: MutableComponent
Component.keybind(name as string) as MutableComponent| Parameter | Type |
|---|---|
Parameter name | Type string |
Return Type: MutableComponent
Component.literal(content as string) as MutableComponent| Parameter | Type |
|---|---|
Parameter content | Type string |
Return Type: Component
Component.nullToEmpty(content as string?) as Component| Parameter | Type |
|---|---|
Parameter content | Type string? |
Return Type: MutableComponent
Component.score(name as string, objective as string) as MutableComponent| Parameter | Type |
|---|---|
Parameter name | Type string |
Parameter objective | Type string |
Return Type: MutableComponent
Component.selector(pattern as string, separator as Component?) as MutableComponent| Parameter | Type | Optional |
|---|---|---|
Parameter pattern | Type string | Optional false |
Parameter separator | Type Component? | Optional true |
Return Type: MutableComponent
Component.translatable(content as string, args as Component[]) as MutableComponent| Parameter | Type |
|---|---|
Parameter content | Type string |
Parameter args | Type Component[] |
Return Type: MutableComponent
Component.translatable(content as string, args as string[]) as MutableComponent| Parameter | Type |
|---|---|
Parameter content | Type string |
Parameter args | Type string[] |
Methods
Return Type: MutableComponent
// Component.copy() as MutableComponent
myComponent.copy();Return Type: ComponentContents
// Component.getContents() as ComponentContents
myComponent.getContents();Return Type: stdlib.List<Component>
// Component.getSiblings() as stdlib.List<Component>
myComponent.getSiblings();Return Type: string
Component.getString(maxLength as int) as string| Parameter | Type |
|---|---|
Parameter maxLength | Type int |
Return Type: Style
// Component.getStyle() as Style
myComponent.getStyle();Return Type: MutableComponent
// Component.plainCopy() as MutableComponent
myComponent.plainCopy();Properties
| Name | Type | Has Getter | Has 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 |