The ICollection data is used to represent a collection of crafttweaker.api.data.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

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.

ZenScript
Copy
crafttweaker.api.data.ICollectionData

Implemented Interfaces

Link to implemented-interfaces

ICollectionData implements the following interfaces. That means any method available to them can also be used on this class.

ZenScript
Copy
new ListData(["Hello", "World"]).add(value as crafttweaker.api.data.IData);
new ListData(["Hello", "World"]).add("today");
ParameterTypeDescription
Parameter
value
Type
crafttweaker.api.data.IData
Description
The value to add to the list
ZenScript
Copy
new ListData(["Hello", "World"]).add(index as int, value as crafttweaker.api.data.IData);
new ListData(["Hello", "World"]).add(1, "beautiful");
ParameterTypeDescription
Parameter
index
Type
int
Description
The index to add to. Subsequent items will be moved one index higher
Parameter
value
Type
crafttweaker.api.data.IData
Description
The value to add to the list

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

Returns: null if this IData is not a list.

Returns List<crafttweaker.api.data.IData>

ZenScript
Copy
new ListData(["Hello", "World"]).asList();

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

Returns: null if this IData is not a map.

Returns crafttweaker.api.data.IData[String]

ZenScript
Copy
new ListData(["Hello", "World"]).asMap();

Gets the String representation of this IData

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

Returns String

ZenScript
Copy
new ListData(["Hello", "World"]).asString();

Removes every element in the list

ZenScript
Copy
new ListData(["Hello", "World"]).clear();

Checks if this IData contains another IData, mainly used in subclasses of crafttweaker.api.data.ICollectionData, is the same as an equals check on other IData types

Returns boolean

ZenScript
Copy
new ListData(["Hello", "World"]).contains(data as crafttweaker.api.data.IData);
new ListData(["Hello", "World"]).contains("Display");
ParameterTypeDescription
Parameter
data
Type
crafttweaker.api.data.IData
Description
data to check if it is contained

Makes a copy of this IData.

IData is immutable by default, use this to create a proper copy of the object.

Returns: a copy of this IData.

Returns crafttweaker.api.data.IData

ZenScript
Copy
new ListData(["Hello", "World"]).copy();

Retrieves the crafttweaker.api.data.IData stored at the given index.

Returns crafttweaker.api.data.IData

ZenScript
Copy
new ListData(["Hello", "World"]).get(index as int);
new ListData(["Hello", "World"]).get(0);
ParameterTypeDescription
Parameter
index
Type
int
Description
The index (0-based)

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.

Returns byte

ZenScript
Copy
new ListData(["Hello", "World"]).getId();

Gets the String representation of the internal INBT tag

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

Returns String

ZenScript
Copy
new ListData(["Hello", "World"]).getString();

Removes the crafttweaker.api.data.IData stored at the given index.

Returns crafttweaker.api.data.IData

ZenScript
Copy
new ListData(["Hello", "World"]).remove(index as int);
new ListData(["Hello", "World"]).remove(0);
ParameterTypeDescription
Parameter
index
Type
int
Description
The index (0-based)

Sets the item at the provided index to the given value

Returns crafttweaker.api.data.IData

ZenScript
Copy
new ListData(["Hello", "World"]).set(index as int, value as crafttweaker.api.data.IData);
new ListData(["Hello", "World"]).set(0, "Bye");
ParameterTypeDescription
Parameter
index
Type
int
Description
The index to set (0-based)
Parameter
value
Type
crafttweaker.api.data.IData
Description
The new Value
NameTypeHas GetterHas Setter
Name
size
Type
int
Has Getter
true
Has Setter
false