MapData

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

Implemented Interfaces

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

IData

Constructors

new MapData() as MapData
new MapData();

new MapData(map as IData[string]) as MapData

Parameter	Type
Parameter map	Type IData[string]

Casters

Result Type	Is Implicit
Result Type boolean	Is Implicit false
Result Type byte	Is Implicit false
Result Type byte[]	Is Implicit false
Result Type double	Is Implicit false
Result Type float	Is Implicit false
Result Type int	Is Implicit false
Result Type int[]	Is Implicit false
Result Type long	Is Implicit false
Result Type long[]	Is Implicit false
Result Type short	Is Implicit false
Result Type stdlib.List<IData>	Is Implicit false
Result Type string	Is Implicit false

Methods

Adds the given IData to this IData.

Returns: A new IData after adding the other data.
Return Type: IData

// MapData.add(other as IData) as IData

(Hello: "World", Somewhere: "Over the rainbow").add(2);

Parameter	Type	Description
Parameter other	Type IData	Description the other data to add.

Casts this IData to a boolean.

Returns: this data as a bool
Return Type: boolean

// MapData.asBool() as boolean

(Hello: "World", Somewhere: "Over the rainbow").asBool();

Casts this IData to a byte.

Returns: this data as a byte
Return Type: byte

// MapData.asByte() as byte

(Hello: "World", Somewhere: "Over the rainbow").asByte();

Casts this IData to a byte array.

Returns: this data as a byte array
Return Type: byte[]

// MapData.asByteArray() as byte[]

(Hello: "World", Somewhere: "Over the rainbow").asByteArray();

Casts this IData to a double.

Returns: this data as a double
Return Type: double

// MapData.asDouble() as double

(Hello: "World", Somewhere: "Over the rainbow").asDouble();

Casts this IData to a float.

Returns: this data as a float
Return Type: float

// MapData.asFloat() as float

(Hello: "World", Somewhere: "Over the rainbow").asFloat();

Casts this IData to an int.

Returns: this data as an int
Return Type: int

// MapData.asInt() as int

(Hello: "World", Somewhere: "Over the rainbow").asInt();

Casts this IData to an int array.

Returns: this data as an int array
Return Type: int[]

// MapData.asIntArray() as int[]

(Hello: "World", Somewhere: "Over the rainbow").asIntArray();

Casts this IData to a list.

Returns: this data as a list
Return Type: stdlib.List<IData>

// MapData.asList() as stdlib.List<IData>

(Hello: "World", Somewhere: "Over the rainbow").asList();

Casts this IData to a long.

Returns: this data as a long
Return Type: long

// MapData.asLong() as long

(Hello: "World", Somewhere: "Over the rainbow").asLong();

Casts this IData to a long array.

Returns: this data as a long array
Return Type: long[]

// MapData.asLongArray() as long[]

(Hello: "World", Somewhere: "Over the rainbow").asLongArray();

Casts this IData to a short.

Returns: this data as a short
Return Type: short

// MapData.asShort() as short

(Hello: "World", Somewhere: "Over the rainbow").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

// MapData.asString() as string

(Hello: "World", Somewhere: "Over the rainbow").asString();

Compares this IData to the other IData

Returns: The comparison result.
Return Type: int

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

(Hello: "World", Somewhere: "Over the rainbow").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

// MapData.getAsString() as string

(Hello: "World", Somewhere: "Over the rainbow").getAsString();

Gets the internal ID of this data.

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

// MapData.getId() as byte

(Hello: "World", Somewhere: "Over the rainbow").getId();

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

// MapData.isEmpty() as boolean

(Hello: "World", Somewhere: "Over the rainbow").isEmpty();

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

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

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

(Hello: "World", Somewhere: "Over the rainbow").map((data) => 3);

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

Adds all entries from the given map into this one. Can override existing keys.

// MapData.putAll(map as IData[string])

(Hello: "World", Somewhere: "Over the rainbow").putAll({Hello: "Goodbye", Item: "Bedrock"});

Parameter	Type	Description
Parameter map	Type IData[string]	Description The other entries to be added to this map

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

MapData.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

Adds the given IData to this IData.

myMapData + other as IData
(Hello: "World", Somewhere: "Over the rainbow") + 2

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

myMapData & other as IData
(Hello: "World", Somewhere: "Over the rainbow") & 2

Concatenates the given IData to this IData.

myMapData ~ other as IData
(Hello: "World", Somewhere: "Over the rainbow") ~ 2

Compares this IData to the other IData

myMapData < other as IData
(Hello: "World", Somewhere: "Over the rainbow") < 5

Divides the given IData from this IData.

myMapData / other as IData
(Hello: "World", Somewhere: "Over the rainbow") / 2

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

myMapData % other as IData
(Hello: "World", Somewhere: "Over the rainbow") % 2

Multiplies the given IData to this IData.

myMapData * other as IData
(Hello: "World", Somewhere: "Over the rainbow") * 2

Negates this IData.

-myMapData
-(Hello: "World", Somewhere: "Over the rainbow")

Applies a NOT (!) operation to this IData.

!myMapData
!true

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

myMapData | other as IData
(Hello: "World", Somewhere: "Over the rainbow") | 2

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

myMapData << other as IData
(Hello: "World", Somewhere: "Over the rainbow") << 2

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

myMapData >> other as IData
(Hello: "World", Somewhere: "Over the rainbow") >> 2

Subtracts the given IData from this IData.

myMapData - other as IData
(Hello: "World", Somewhere: "Over the rainbow") - 2

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

myMapData ^ other as IData
(Hello: "World", Somewhere: "Over the rainbow") ^ 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.