Version:

Home Commands Examples Getting Started With Scripts Global Keywords

ICollectionData

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

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

IData

Static Methods

Creates the most specific ICollectionData form possible for the provided members.

Tries to return (in order) ByteArrayData, IntArrayData, LongArrayData or if neither is applicable ListData

Return Type: ICollectionData

ICollectionData.getFromMembers(members as IData[]) as ICollectionData

Parameter	Type
Parameter members	Type IData[]

Casters

Result Type	Is Implicit
Result Type boolean	Is Implicit false
Result Type ICollectionData	Is Implicit false
Result Type INumberData	Is Implicit false

Methods

// ICollectionData.add(value as IData)

new ListData(["Hello", "World"]).add("today");

Parameter	Type	Description
Parameter value	Type IData	Description The value to add to the list

// ICollectionData.add(index as int, value as IData)

new ListData(["Hello", "World"]).add(1, "beautiful");

Parameter	Type	Description
Parameter index	Type int	Description The index to add to. Subsequent items will be moved one index higher
Parameter value	Type IData	Description The value to add to the list

Return Type: boolean

// ICollectionData.asBoolean() as boolean

new ListData(["Hello", "World"]).asBoolean();

Return Type: ICollectionData

// ICollectionData.asCollection() as ICollectionData

new ListData(["Hello", "World"]).asCollection();

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>

// ICollectionData.asList() as stdlib.List<IData>

new ListData(["Hello", "World"]).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]

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

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

Return Type: INumberData

// ICollectionData.asNumber() as INumberData

new ListData(["Hello", "World"]).asNumber();

Gets the String representation of this IData

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

// ICollectionData.asString() as string

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

Removes every element in the list

// ICollectionData.clear()

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

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

Returns: true if the given IData is contained in this IData
Return Type: boolean

// ICollectionData.contains(data as IData) as boolean

new ListData(["Hello", "World"]).contains("Display");

Parameter	Type	Description
Parameter data	Type IData	Description data to check if it is contained

Retrieves the IData stored at the given index.

Returns: The IData
Return Type: IData

// ICollectionData.getAt(index as int) as IData

new ListData(["Hello", "World"]).getAt(0);

Parameter	Type	Description
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.
Return Type: byte

// ICollectionData.getId() as byte

new ListData(["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

// ICollectionData.getString() as string

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

Return Type: boolean

// ICollectionData.isEmpty() as boolean

new ListData(["Hello", "World"]).isEmpty();

Removes the IData stored at the given index.

Returns: The IData that was removed
Return Type: IData

// ICollectionData.remove(index as int) as IData

new ListData(["Hello", "World"]).remove(0);

Parameter	Type	Description
Parameter index	Type int	Description The index (0-based)

Sets the item at the provided index to the given value

Returns: The replaced value
Return Type: IData

// ICollectionData.setAt(index as int, value as IData) as IData

new ListData(["Hello", "World"]).setAt(0, "Bye");

Parameter	Type	Description
Parameter index	Type int	Description The index to set (0-based)
Parameter value	Type IData	Description The new Value

Properties

Name	Type	Has Getter	Has Setter
Name empty	Type boolean	Has Getter true	Has Setter false
Name size	Type int	Has Getter true	Has Setter false