ListData

Version:

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.ListData;

Implemented Interfaces

ListData implements the following interfaces. That means all methods defined in these interfaces are also available in ListData

IData

Constructors

new ListData() as ListData
new ListData();

new ListData(list as stdlib.List<IData>) as ListData

Parameter	Type
Parameter list	Type stdlib.List<IData>

Casters

Result Type	Is Implicit
Result Type boolean	Is Implicit false
Result Type byte	Is Implicit false
Result Type double	Is Implicit false
Result Type float	Is Implicit false
Result Type IData[string]	Is Implicit false
Result Type int	Is Implicit false
Result Type long	Is Implicit false
Result Type short	Is Implicit false
Result Type string	Is Implicit false

Methods

Casts this IData to a boolean.

Returns: this data as a bool
Return Type: boolean

// ListData.asBool() as boolean

(["Hello", "World", "!"] as IData).asBool();

Casts this IData to a byte.

Returns: this data as a byte
Return Type: byte

// ListData.asByte() as byte

(["Hello", "World", "!"] as IData).asByte();

Casts this IData to a double.

Returns: this data as a double
Return Type: double

// ListData.asDouble() as double

(["Hello", "World", "!"] as IData).asDouble();

Casts this IData to a float.

Returns: this data as a float
Return Type: float

// ListData.asFloat() as float

(["Hello", "World", "!"] as IData).asFloat();

Casts this IData to an int.

Returns: this data as an int
Return Type: int

// ListData.asInt() as int

(["Hello", "World", "!"] as IData).asInt();

Casts this IData to a long.

Returns: this data as a long
Return Type: long

// ListData.asLong() as long

(["Hello", "World", "!"] as IData).asLong();

Casts this IData to a map.

Returns: this data as a map
Return Type: IData[string]

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

(["Hello", "World", "!"] as IData).asMap();

Casts this IData to a short.

Returns: this data as a short
Return Type: short

// ListData.asShort() as short

(["Hello", "World", "!"] as IData).asShort();

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.
Return Type: string

// ListData.asString() as string

(["Hello", "World", "!"] as IData).asString();

Compares this IData to the other IData

Returns: The comparison result.
Return Type: int

// ListData.compareTo(other as IData) as int

(["Hello", "World", "!"] as IData).compareTo(5);

Parameter	Type	Description
Parameter other	Type IData	Description the data to be compared.

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.
Return Type: string

// ListData.getAsString() as string

(["Hello", "World", "!"] as IData).getAsString();

Gets the internal ID of this data.

Returns: the intenral ID of this data.
Return Type: byte

// ListData.getId() as byte

(["Hello", "World", "!"] as IData).getId();

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

// ListData.isEmpty() as boolean

(["Hello", "World", "!"] as IData).isEmpty();

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

Returns: A new IData from the operation
Return Type: IData

// ListData.map(operation as Function<IData,IData>) as IData

(["Hello", "World", "!"] as IData).map((data) => 3);

Parameter	Type	Description
Parameter operation	Type Function<IData,IData>	Description The operation to apply to this IData

Merges the given data with this data.

Returns: the result of merging the datas.
Return Type: IData

ListData.merge(other as IData) as IData

Parameter	Type	Description
Parameter other	Type IData	Description the data to merge

Removes the stored data at the given key.

// ListData.remove(key as string)

{key: "value"} as IData.remove("key");

Parameter	Type	Description
Parameter key	Type string	Description The key to remove.

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

ListData.setAt(name as string, data as IData?)

Parameter	Type	Description
Parameter name	Type string	Description The key to store the data at
Parameter data	Type IData?	Description The data to store.

Operators

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

myListData & other as IData
(["Hello", "World", "!"] as IData) & 2

Concatenates the given IData to this IData.

myListData ~ other as IData
(["Hello", "World", "!"] as IData) ~ 2

Compares this IData to the other IData

myListData < other as IData
(["Hello", "World", "!"] as IData) < 5

Divides the given IData from this IData.

myListData / other as IData
(["Hello", "World", "!"] as IData) / 2

Gets the data at the given key.

[myListData]

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

myListData % other as IData
(["Hello", "World", "!"] as IData) % 2

Multiplies the given IData to this IData.

myListData * other as IData
(["Hello", "World", "!"] as IData) * 2

Negates this IData.

-myListData
-(["Hello", "World", "!"] as IData)

Applies a NOT (!) operation to this IData.

!myListData
!true

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

myListData | other as IData
(["Hello", "World", "!"] as IData) | 2

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

myListData << other as IData
(["Hello", "World", "!"] as IData) << 2

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

myListData >> other as IData
(["Hello", "World", "!"] as IData) >> 2

Subtracts the given IData from this IData.

myListData - other as IData
(["Hello", "World", "!"] as IData) - 2

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

myListData ^ other as IData
(["Hello", "World", "!"] as IData) ^ 2

Properties

Name	Type	Has Getter	Has Setter	Description
Name isEmpty	Type boolean	Has Getter true	Has Setter false	Description Checks if this data is empty.