ListData

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.api.data.ListData;

Description

Implements

ListData implements the following interfaces:

IData

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Constructors

// new ListData();
new ListData();

// new ListData(list as List<IData>);
new ListData(myList);

Parameters:

list: List<IData> Type: List<IData>

// new ListData(array as IData[]);
new ListData(myIData[]);

Parameters:

array: IData[] Type: IData[]

Operators

Applies a bitwise AND (&) operation to this IData and the other IData

// (ListData & (other as IData)) as IData
myListData & myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Concatenates the given IData to this IData.

// (ListData ~ (other as IData)) as IData
myListData ~ myIData

Parameters:

other: IData Type: IData - the other data to concatenate.

Return Type: IData

Divides the given IData from this IData.

// (ListData / (other as IData)) as IData
myListData / myIData

Parameters:

other: IData Type: IData - the other data to divide by.

Return Type: IData

Gets the data at the given key.

// ListData[key as string] as IData
myListData[myString]

Parameters:

key: string Type: string - The key to get

Return Type: IData

Applies a modulo operation to this IData against the other IData.

// (ListData % (other as IData)) as IData
myListData % myIData

Parameters:

other: IData Type: IData - the other data to modulo by.

Return Type: IData

Multiplies the given IData to this IData.

// (ListData * (other as IData)) as IData
myListData * myIData

Parameters:

other: IData Type: IData - the other data to multiply by.

Return Type: IData

Negates this IData.

// (-ListData) as IData
-myListData

Return Type: IData

Applies a NOT (!) operation to this IData.

// (!ListData) as IData
!myListData

Return Type: IData

Applies a bitwise OR (|) operation to this IData and the other IData

// (ListData | (other as IData)) as IData
myListData | myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Applies a SHL (<<) operation to this data by the other data

// (ListData << (other as IData)) as IData
myListData << myIData

Parameters:

other: IData Type: IData - The data to SHL by.

Return Type: IData

Applies a SHR (>>) operation to this data by the other data

// (ListData >> (other as IData)) as IData
myListData >> myIData

Parameters:

other: IData Type: IData - The data to SHR by.

Return Type: IData

Subtracts the given IData from this IData.

// (ListData - (other as IData)) as IData
-myListData

Parameters:

other: IData Type: IData - the other data to remove.

Return Type: IData

Applies a bitwise XOR (^) operation to this IData and the other IData

// (ListData ^ (other as IData)) as IData
myListData ^ myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Members

Casts this IData to a boolean.

Returns: this data as a bool

// ListData.asBool() as bool;
myListData.asBool();

Return Type: bool

Casts this IData to a boolean.

// ListData as bool
myListData as bool

Return Type: bool

Casts this IData to a byte.

Returns: this data as a byte

// ListData.asByte() as byte;
myListData.asByte();

Return Type: byte

Casts this IData to a byte.

// ListData as byte
myListData as byte

Return Type: byte

Casts this IData to a double.

Returns: this data as a double

// ListData.asDouble() as double;
myListData.asDouble();

Return Type: double

Casts this IData to a double.

// ListData as double
myListData as double

Return Type: double

Casts this IData to a float.

Returns: this data as a float

// ListData.asFloat() as float;
myListData.asFloat();

Return Type: float

Casts this IData to a float.

// ListData as float
myListData as float

Return Type: float

Casts this IData to an int.

Returns: this data as an int

// ListData.asInt() as int;
myListData.asInt();

Return Type: int

Casts this IData to an int.

// ListData as int
myListData as int

Return Type: int

Casts this IData to a long.

Returns: this data as a long

// ListData.asLong() as long;
myListData.asLong();

Return Type: long

Casts this IData to a long.

// ListData as long
myListData as long

Return Type: long

Casts this IData to a map.

Returns: this data as a map

// ListData.asMap() as IData[string];
myListData.asMap();

Return Type: IData[string]

Casts this IData to a map.

// ListData as IData[string]
myListData as IData[string]

Return Type: IData[string]

Casts this IData to a short.

Returns: this data as a short

// ListData.asShort() as short;
myListData.asShort();

Return Type: short

Casts this IData to a short.

// ListData as short
myListData as short

Return Type: short

Gets an escaped string version of this IData, quotes are included in the output

E.G println(("hello" as IData).asString()) prints "hello"

Returns: The escaped string version of this IData.

// ListData.asString() as string;
myListData.asString();

Return Type: string

Compares this IData to the other IData

Returns: The comparison result.

// ListData.compareTo(other as IData) as int;
myListData.compareTo(5);

Parameters:

other: IData Type: IData - the data to be compared.

Return Type: int

Gets the literal string version of this IData.

E.G println(("hello" as IData).getAsString()) prints hello

Returns: The literal string version of this IData.

// ListData.getAsString() as string;
myListData.getAsString();

Return Type: string

Gets the literal string version of this IData.

E.G println(("hello" as IData).getAsString()) prints hello

// ListData as string
myListData as string

Return Type: string

Gets the internal ID of this data.

Returns: the intenral ID of this data.

// ListData.getId() as byte;
myListData.getId();

Return Type: byte

Checks if this data is empty.

// ListData.isEmpty as bool
myListData.isEmpty

Return Type: bool

Checks if this data is empty.

Returns: True if empty.

// ListData.isEmpty() as bool;
myListData.isEmpty();

Return Type: bool

Creates a collection of the given IData members.

This attempts to give the most accurate type for the given members, for example, if all the members are bytes, then it returns a ByteArrayData.
However if the types are mixed or do not have a *ArrayData version, then a ListData is returned.

Returns: A list of the given members.

// ListData.listOf(members as IData[]) as IData;
ListData.listOf(1, 2, 3);

Parameters:

members: IData[] Type: IData[] - The members to put in the list.

Return Type: IData

Maps this IData to another IData based on the given operation.

Returns: A new IData from the operation

// ListData.map(operation as function(r as IData) as IData) as IData;
myListData.map((data) => 3);

Parameters:

operation: function(r as IData) as IData Type: function(r as IData) as IData - The operation to apply to this IData

Return Type: IData

Merges the given data with this data.

Returns: the result of merging the datas.

// ListData.merge(other as IData) as IData;
myListData.merge(myIData);

Parameters:

other: IData Type: IData - the data to merge

Return Type: IData

Removes the stored data at the given key.

// ListData.remove(key as string);
myListData.remove("key");

Parameters:

key: string Type: string - The key to remove.

Sets the given value inside this IData at the given index.

// ListData.setAt(name as string, data as IData);
myListData.setAt(myString, myIData);

Parameters:

name: string Type: string - The key to store the data at

data: IData Type: IData - The data to store.