ListData

Version:

Home Migration Guide Getting Started With Scripts Commands Examples

BoolData ByteArrayData ByteData DoubleData FloatData ICollectionData IData INumberData IntArrayData IntData ListData LongArrayData LongData MapData ShortData 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.

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

ICollectionData

Static Methods

Return Type: ListData

// ListData.create() as ListData

ListData.create();

Constructors

No Description Provided

new ListData() as ListData
new ListData();

No Description Provided

new ListData(list as stdlib.List<IData>) as ListData

Parameter	Type	Description
Parameter list	Type stdlib.List<IData>	Description No Description Provided

Casters

Result type	Is 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

// ListData.asBoolean() as boolean

["Hello", "World", "!"].asBoolean();

Return Type: ICollectionData

// ListData.asCollection() as ICollectionData

["Hello", "World", "!"].asCollection();

Return Type: MCTextComponent

ListData.asFormattedText(indentation as string, indentDepth as int) as MCTextComponent

Parameter	Type	Description
Parameter indentation	Type string	Description No Description Provided
Parameter indentDepth	Type int	Description No Description Provided

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]

// ListData.asMap() as IData[string]

["Hello", "World", "!"].asMap();

Return Type: INumberData

// ListData.asNumber() as INumberData

["Hello", "World", "!"].asNumber();

Return Type: T

ListData.getData<T : IData>(index as int) as T

Parameter	Type	Description
Parameter index	Type int	Description No Description Provided
Parameter T	Type IData	Description No Description Provided

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

// 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

// ListData.getString() as string

["Hello", "World", "!"].getString();