ListData
Link to listdata
Importing the class
Link to 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.
ZenScript Copyimport crafttweaker.api.data.ListData;
Implemented Interfaces
Link to implemented-interfaces
ListData implements the following interfaces. That means all methods defined in these interfaces are also available in ListData
Constructors
Link to constructors
ZenScript Copynew ListData() as ListData
new ListData();
ZenScript Copynew ListData(list as stdlib.List<IData>) as ListData
Parameter | Type |
---|---|
Parameter list | Type stdlib.List<IData> |
Casters
Link to 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
Link to methods
Name: asBool
Casts this IData to a boolean.
Returns: this data as a bool
Return Type: boolean
ZenScript Copy// ListData.asBool() as boolean
(["Hello", "World", "!"] as IData).asBool();
Name: asByte
Casts this IData to a byte.
Returns: this data as a byte
Return Type: byte
ZenScript Copy// ListData.asByte() as byte
(["Hello", "World", "!"] as IData).asByte();
Name: asDouble
Casts this IData to a double.
Returns: this data as a double
Return Type: double
ZenScript Copy// ListData.asDouble() as double
(["Hello", "World", "!"] as IData).asDouble();
Name: asFloat
Casts this IData to a float.
Returns: this data as a float
Return Type: float
ZenScript Copy// ListData.asFloat() as float
(["Hello", "World", "!"] as IData).asFloat();
Name: asInt
Casts this IData to an int.
Returns: this data as an int
Return Type: int
ZenScript Copy// ListData.asInt() as int
(["Hello", "World", "!"] as IData).asInt();
Name: asLong
Casts this IData to a long.
Returns: this data as a long
Return Type: long
ZenScript Copy// ListData.asLong() as long
(["Hello", "World", "!"] as IData).asLong();
Name: asMap
Casts this IData to a map.
Returns: this data as a map
Return Type: IData[string]
ZenScript Copy// ListData.asMap() as IData[string]
(["Hello", "World", "!"] as IData).asMap();
Name: asShort
Casts this IData to a short.
Returns: this data as a short
Return Type: short
ZenScript Copy// ListData.asShort() as short
(["Hello", "World", "!"] as IData).asShort();
Name: asString
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
ZenScript Copy// ListData.asString() as string
(["Hello", "World", "!"] as IData).asString();
Name: compareTo
Compares this IData to the other IData
Returns: The comparison result.
Return Type: int
ZenScript Copy// 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. |
Name: getAsString
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
ZenScript Copy// ListData.getAsString() as string
(["Hello", "World", "!"] as IData).getAsString();
Name: getId
Gets the internal ID of this data.
Returns: the intenral ID of this data.
Return Type: byte
ZenScript Copy// ListData.getId() as byte
(["Hello", "World", "!"] as IData).getId();
Name: isEmpty
Checks if this data is empty.
Returns: True if empty.
Return Type: boolean
ZenScript Copy// ListData.isEmpty() as boolean
(["Hello", "World", "!"] as IData).isEmpty();
Name: map
Maps this IData to another IData based on the given operation.
Returns: A new IData from the operation
Return Type: IData
ZenScript Copy// 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 |
Name: remove
Removes the stored data at the given key.
ZenScript Copy// ListData.remove(key as string)
{key: "value"} as IData.remove("key");
Parameter | Type | Description |
---|---|---|
Parameter key | Type string | Description The key to remove. |
Name: setAt
Sets the given value inside this IData at the given index.
ZenScript CopyListData.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
Link to operators
Name: AND
Applies a bitwise AND (&) operation to this IData and the other IData
ZenScript CopymyListData & other as IData
(["Hello", "World", "!"] as IData) & 2
Name: CAT
Concatenates the given IData to this IData.
ZenScript CopymyListData ~ other as IData
(["Hello", "World", "!"] as IData) ~ 2
Name: COMPARE
Compares this IData to the other IData
ZenScript CopymyListData < other as IData
(["Hello", "World", "!"] as IData) < 5
Name: DIV
Divides the given IData from this IData.
ZenScript CopymyListData / other as IData
(["Hello", "World", "!"] as IData) / 2
Name: INDEXGET
Gets the data at the given key.
ZenScript Copy[myListData]
Name: MOD
Applies a modulo operation to this IData against the other IData.
ZenScript CopymyListData % other as IData
(["Hello", "World", "!"] as IData) % 2
Name: MUL
Multiplies the given IData to this IData.
ZenScript CopymyListData * other as IData
(["Hello", "World", "!"] as IData) * 2
Name: NEG
Negates this IData.
ZenScript Copy-myListData
-(["Hello", "World", "!"] as IData)
Name: NOT
Applies a NOT (!) operation to this IData.
ZenScript Copy!myListData
!true
Name: OR
Applies a bitwise OR (|) operation to this IData and the other IData
ZenScript CopymyListData | other as IData
(["Hello", "World", "!"] as IData) | 2
Name: SHL
Applies a SHL (<<) operation to this data by the other data
ZenScript CopymyListData << other as IData
(["Hello", "World", "!"] as IData) << 2
Name: SHR
Applies a SHR (>>) operation to this data by the other data
ZenScript CopymyListData >> other as IData
(["Hello", "World", "!"] as IData) >> 2
Name: SUB
Subtracts the given IData from this IData.
ZenScript CopymyListData - other as IData
(["Hello", "World", "!"] as IData) - 2
Name: XOR
Applies a bitwise XOR (^) operation to this IData and the other IData
ZenScript CopymyListData ^ other as IData
(["Hello", "World", "!"] as IData) ^ 2
Properties
Link to 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. |