Home Migration Guide Getting Started With Scripts Commands Examples
BracketHandlers

StringData

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.data.StringData;

Implemented Interfaces

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

Constructors

No Description Provided

script.zs
new StringData(internal as string) as StringData
ParameterTypeDescription
Parameter
internal
Type
string
Description
No Description Provided

Casters

Result typeIs Implicit
Result type
boolean
Is Implicit
false
Result type
ICollectionData
Is Implicit
false
Result type
INumberData
Is Implicit
false

Methods

Return Type: boolean

script.zs
// StringData.asBoolean() as boolean
new StringData("Hello").asBoolean();

Return Type: ICollectionData

script.zs
// StringData.asCollection() as ICollectionData
new StringData("Hello").asCollection();

Return Type: MCTextComponent

script.zs
StringData.asFormattedText(indentation as string, indentDepth as int) as MCTextComponent
ParameterTypeDescription
Parameter
indentation
Type
string
Description
No Description Provided
Parameter
indentDepth
Type
int
Description
No Description Provided

Gets a List representation of this IData, returns null on anything but ListData.

Returns: null if this IData is not a list.
Return Type: stdlib.List<IData>

script.zs
// StringData.asList() as stdlib.List<IData>
new StringData("Hello").asList();

Gets a Map<String, IData> representation of this IData, returns null on anything but MapData.

Returns: null if this IData is not a map.
Return Type: IData[string]

script.zs
// StringData.asMap() as IData[string]
new StringData("Hello").asMap();

Return Type: INumberData

script.zs
// StringData.asNumber() as INumberData
new StringData("Hello").asNumber();

Gets the ID of the internal NBT tag.

Used to determine what NBT type is stored (in a list for example)

Returns: ID of the NBT tag that this data represents.
Return Type: byte

script.zs
// StringData.getId() as byte
new StringData("Hello").getId();

Gets the String representation of the internal INBT tag

Returns: String that represents the internal INBT of this IData.
Return Type: string

script.zs
// StringData.getString() as string
new StringData("Hello").getString();

Operators

Concatenates the two string Datas and returns the result.

script.zs
myStringData + data as StringData
new StringData("Hello") + new StringData("World")