ListData

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.

ZenScript
Copy
crafttweaker.api.data.ListData

Implemented Interfaces

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

Constructors

ZenScript
Copy
new crafttweaker.api.data.ListData();
ZenScript
Copy
new crafttweaker.api.data.ListData(list as List<crafttweaker.api.data.IData>);
ParameterTypeDescriptionIsOptionalDefault Value
listList<crafttweaker.api.data.IData>No description providedtruenull

Methods

add

ZenScript
Copy
["Hello", "World", "!"].add(value as crafttweaker.api.data.IData);
["Hello", "World", "!"].add("today");
ParameterTypeDescription
valuecrafttweaker.api.data.IDataThe value to add to the list
ZenScript
Copy
["Hello", "World", "!"].add(index as int, value as crafttweaker.api.data.IData);
["Hello", "World", "!"].add(1, "beautiful");
ParameterTypeDescription
indexintThe index to add to. Subsequent items will be moved one index higher
valuecrafttweaker.api.data.IDataThe value to add to the list

clear

Removes every element in the list

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

get

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

Returns crafttweaker.api.data.IData

ZenScript
Copy
["Hello", "World", "!"].get(index as int);
["Hello", "World", "!"].get(0);
ParameterTypeDescription
indexintThe index (0-based)

remove

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

Returns crafttweaker.api.data.IData

ZenScript
Copy
["Hello", "World", "!"].remove(index as int);
["Hello", "World", "!"].remove(0);
ParameterTypeDescription
indexintThe index (0-based)

set

Sets the item at the provided index to the given value

Returns crafttweaker.api.data.IData

ZenScript
Copy
["Hello", "World", "!"].set(index as int, value as crafttweaker.api.data.IData);
["Hello", "World", "!"].set(0, "Bye");
ParameterTypeDescription
indexintThe index to set (0-based)
valuecrafttweaker.api.data.IDataThe new Value

Properties

NameTypeHas GetterHas Setter
sizeinttruefalse

Casters

Result typeIs Implicit
List<crafttweaker.api.data.IData>true