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.

crafttweaker.api.data.ICollectionData

Constructors

ZenScript
 Copy
new crafttweaker.api.data.ListData();

ZenScript
 Copy
new crafttweaker.api.data.ListData(list as List<crafttweaker.api.data.IData>);

Parameter	Type	Description	IsOptional	Default Value
Parameter list	Type List<crafttweaker.api.data.IData>	Description No description provided	IsOptional true	Default Value null

Methods

add

ZenScript
 Copy
["Hello", "World", "!"].add(value as crafttweaker.api.data.IData);
["Hello", "World", "!"].add("today");

Parameter	Type	Description
Parameter value	Type crafttweaker.api.data.IData	Description The 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");

Parameter	Type	Description
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

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);

Parameter	Type	Description
Parameter index	Type int	Description The 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);

Parameter	Type	Description
Parameter index	Type int	Description The 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");

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

Properties

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

Casters

Result type	Is Implicit
Result type List<crafttweaker.api.data.IData>	Is Implicit true