Component
Link to component
Importing the class
Link to 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 Copyimport crafttweaker.api.text.Component;
Implemented Interfaces
Link to implemented-interfaces
Component implements the following interfaces. That means all methods defined in these interfaces are also available in Component
Static Methods
Link to static-methods
Name: empty
Return Type: MutableComponent
ZenScript Copy// Component.empty() as MutableComponent
Component.empty();
Name: keybind
Return Type: MutableComponent
ZenScript CopyComponent.keybind(name as string) as MutableComponent
| Parameter | Type |
|---|---|
Parameter name | Type string |
Name: literal
Return Type: MutableComponent
ZenScript CopyComponent.literal(content as string) as MutableComponent
| Parameter | Type |
|---|---|
Parameter content | Type string |
Name: nullToEmpty
Return Type: Component
ZenScript CopyComponent.nullToEmpty(content as string?) as Component
| Parameter | Type |
|---|---|
Parameter content | Type string? |
Name: score
Return Type: MutableComponent
ZenScript CopyComponent.score(name as string, objective as string) as MutableComponent
| Parameter | Type |
|---|---|
Parameter name | Type string |
Parameter objective | Type string |
Name: selector
Return Type: MutableComponent
ZenScript CopyComponent.selector(pattern as string, separator as Component?) as MutableComponent
| Parameter | Type | Optional |
|---|---|---|
Parameter pattern | Type string | Optional false |
Parameter separator | Type Component? | Optional true |
Name: translatable
Return Type: MutableComponent
ZenScript CopyComponent.translatable(content as string, args as Component[]) as MutableComponent
| Parameter | Type |
|---|---|
Parameter content | Type string |
Parameter args | Type Component[] |
Name: translatable
Return Type: MutableComponent
ZenScript CopyComponent.translatable(content as string, args as string[]) as MutableComponent
| Parameter | Type |
|---|---|
Parameter content | Type string |
Parameter args | Type string[] |
Casters
Link to casters
| Result Type | Is Implicit |
|---|---|
Result Type IData | Is Implicit true |
Methods
Link to methods
Name: asIData
Return Type: IData
ZenScript Copy// Component.asIData() as IData
myComponent.asIData();
Name: copy
Return Type: MutableComponent
ZenScript Copy// Component.copy() as MutableComponent
myComponent.copy();
Name: getContents
Return Type: invalid
ZenScript Copy// Component.getContents() as invalid
myComponent.getContents();
Name: getSiblings
Return Type: stdlib.List<Component>
ZenScript Copy// Component.getSiblings() as stdlib.List<Component>
myComponent.getSiblings();
Name: getString
Return Type: string
ZenScript CopyComponent.getString(maxLength as int) as string
| Parameter | Type |
|---|---|
Parameter maxLength | Type int |
Name: getStyle
Return Type: Style
ZenScript Copy// Component.getStyle() as Style
myComponent.getStyle();
Name: plainCopy
Return Type: MutableComponent
ZenScript Copy// Component.plainCopy() as MutableComponent
myComponent.plainCopy();
Properties
Link to properties
| Name | Type | Has Getter | Has Setter |
|---|---|---|---|
Name contents | Type invalid | 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 |