ListData

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.ListData;

Implemented Interfaces

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

Static Methods

Return Type: ListData

script.zs
// ListData.create() as ListData
ListData.create();

Constructors

script.zs
new ListData() as ListData
new ListData();
script.zs
new ListData(list as stdlib.List<IData>) as ListData
ParameterType
Parameter
list
Type
stdlib.List<IData>

Casters

Result TypeIs Implicit
Result Type
boolean
Is Implicit
false
Result Type
ICollectionData
Is Implicit
false
Result Type
INumberData
Is Implicit
false
Result Type
stdlib.List<IData>
Is Implicit
true

Methods

Return Type: boolean

script.zs
// ListData.asBoolean() as boolean
["Hello", "World", "!"].asBoolean();

Return Type: ICollectionData

script.zs
// ListData.asCollection() as ICollectionData
["Hello", "World", "!"].asCollection();

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
// ListData.asMap() as IData[string]
["Hello", "World", "!"].asMap();

Return Type: INumberData

script.zs
// ListData.asNumber() as INumberData
["Hello", "World", "!"].asNumber();

Gets the String representation of this IData

Returns: String that represents this IData (value and type).
Return Type: string

script.zs
// ListData.asString() as string
["Hello", "World", "!"].asString();

Return Type: @org.openzen.zencode.java.ZenCodeType.Nullable T

script.zs
ListData.getData<T : IData>(index as int) as @org.openzen.zencode.java.ZenCodeType.Nullable T
ParameterType
Parameter
index
Type
int
Parameter
T
Type
IData

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
// ListData.getId() as byte
["Hello", "World", "!"].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
// ListData.getString() as string
["Hello", "World", "!"].getString();