MapData - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

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
 Copy
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

ZenScript
 Copy
new MapData() as MapData
new MapData();

ZenScript
 Copy
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

add

Name: add

Adds the given IData to this IData.

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

ZenScript
 Copy
// 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.

asBool

Name: asBool

Casts this IData to a boolean.

Returns: this data as a bool
Return Type: boolean

ZenScript
 Copy
// MapData.asBool() as boolean

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

asByte

Name: asByte

Casts this IData to a byte.

Returns: this data as a byte
Return Type: byte

ZenScript
 Copy
// MapData.asByte() as byte

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

asByteArray

Name: asByteArray

Casts this IData to a byte array.

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

ZenScript
 Copy
// MapData.asByteArray() as byte[]

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

asDouble

Name: asDouble

Casts this IData to a double.

Returns: this data as a double
Return Type: double

ZenScript
 Copy
// MapData.asDouble() as double

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

asFloat

Name: asFloat

Casts this IData to a float.

Returns: this data as a float
Return Type: float

ZenScript
 Copy
// MapData.asFloat() as float

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

asInt

Name: asInt

Casts this IData to an int.

Returns: this data as an int
Return Type: int

ZenScript
 Copy
// MapData.asInt() as int

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

asIntArray

Name: asIntArray

Casts this IData to an int array.

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

ZenScript
 Copy
// MapData.asIntArray() as int[]

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

asList

Name: asList

Casts this IData to a list.

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

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

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

asLong

Name: asLong

Casts this IData to a long.

Returns: this data as a long
Return Type: long

ZenScript
 Copy
// MapData.asLong() as long

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

asLongArray

Name: asLongArray

Casts this IData to a long array.

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

ZenScript
 Copy
// MapData.asLongArray() as long[]

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

asShort

Name: asShort

Casts this IData to a short.

Returns: this data as a short
Return Type: short

ZenScript
 Copy
// MapData.asShort() as short

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

asString

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
// MapData.asString() as string

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

compareTo

Name: compareTo

Compares this IData to the other IData

Returns: The comparison result.
Return Type: int

ZenScript
 Copy
// 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.

getAsString

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
// MapData.getAsString() as string

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

getId

Name: getId

Gets the internal ID of this data.

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

ZenScript
 Copy
// MapData.getId() as byte

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

isEmpty

Name: isEmpty

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

ZenScript
 Copy
// MapData.isEmpty() as boolean

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

map

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
// 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

putAll

Name: putAll

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

ZenScript
 Copy
// 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

setAt

Name: setAt

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

ZenScript
 Copy
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

ADD

Name: ADD

Adds the given IData to this IData.

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

AND

Name: AND

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

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

CAT

Name: CAT

Concatenates the given IData to this IData.

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

COMPARE

Name: COMPARE

Compares this IData to the other IData

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

DIV

Name: DIV

Divides the given IData from this IData.

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

MOD

Name: MOD

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

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

MUL

Name: MUL

Multiplies the given IData to this IData.

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

NEG

Name: NEG

Negates this IData.

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

NOT

Name: NOT

Applies a NOT (!) operation to this IData.

ZenScript
 Copy
!myMapData
!true

Name: OR

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

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

SHL

Name: SHL

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

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

SHR

Name: SHR

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

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

SUB

Name: SUB

Subtracts the given IData from this IData.

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

XOR

Name: XOR

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

ZenScript
 Copy
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.