ICollectionData

The ICollection data is used to represent a collection of IData like a List

This class was added by a mod with mod-id crafttweaker. So you need to have this mod installed if you want to use this feature.

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

Implemented Interfaces

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

Methods

add

Return Type: void

ICollectionData.add(value as IData) as void
new ListData(["Hello", "World"]).add("today");
ParameterTypeDescription
valueIDataThe value to add to the list

Return Type: void

ICollectionData.add(index as int, value as IData) as void
new ListData(["Hello", "World"]).add(1, "beautiful");
ParameterTypeDescription
indexintThe index to add to. Subsequent items will be moved one index higher
valueIDataThe value to add to the list

clear

Removes every element in the list

Return Type: void

ICollectionData.clear() as void
new ListData(["Hello", "World"]).clear();

getAt

Retrieves the IData stored at the given index.

Return Type: IData

ICollectionData.getAt(index as int) as IData
new ListData(["Hello", "World"]).getAt(0);
ParameterTypeDescription
indexintThe index (0-based)

remove

Removes the IData stored at the given index.

Return Type: IData

ICollectionData.remove(index as int) as IData
new ListData(["Hello", "World"]).remove(0);
ParameterTypeDescription
indexintThe index (0-based)

setAt

Sets the item at the provided index to the given value

Return Type: IData

ICollectionData.setAt(index as int, value as IData) as IData
new ListData(["Hello", "World"]).setAt(0, "Bye");
ParameterTypeDescription
indexintThe index to set (0-based)
valueIDataThe new Value

Properties

NameTypeHas GetterHas Setter
sizeinttruefalse