Previous
LongData ShortData
Next

MapData

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.

script.zs
import crafttweaker.api.data.MapData;

Description

Implements

MapData implements the following interfaces:

IData

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Constructors

new
new()
script.zs
// new MapData();
new MapData();
new(map as IData[string])
script.zs
// new MapData(map as IData[string]);
new MapData(myMap);

Parameters:

map Type: IData[string]

Operators

+
+(other as IData) as IData
Adds the given IData to this IData.
script.zs
// (MapData + (other as IData)) as IData
myMapData + myIData

Parameters:

other Type: IData - the other data to add.

Return Type: IData

&
&(other as IData) as IData
Applies a bitwise AND (&) operation to this IData and the other IData
script.zs
// (MapData & (other as IData)) as IData
myMapData & myIData

Parameters:

other Type: IData - the other data.

Return Type: IData

~
~(other as IData) as IData
Concatenates the given IData to this IData.
script.zs
// (MapData ~ (other as IData)) as IData
myMapData ~ myIData

Parameters:

other Type: IData - the other data to concatenate.

Return Type: IData

/
/(other as IData) as IData
Divides the given IData from this IData.
script.zs
// (MapData / (other as IData)) as IData
myMapData / myIData

Parameters:

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

Return Type: IData

%
%(other as IData) as IData
Applies a modulo operation to this IData against the other IData.
script.zs
// (MapData % (other as IData)) as IData
myMapData % myIData

Parameters:

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

Return Type: IData

*
*(other as IData) as IData
Multiplies the given IData to this IData.
script.zs
// (MapData * (other as IData)) as IData
myMapData * myIData

Parameters:

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

Return Type: IData

-
- as IData
Negates this IData.
script.zs
// (-MapData) as IData
-myMapData

Return Type: IData

!
! as IData
Applies a NOT (!) operation to this IData.
script.zs
// (!MapData) as IData
!myMapData

Return Type: IData

|
|(other as IData) as IData
Applies a bitwise OR (|) operation to this IData and the other IData
script.zs
// (MapData | (other as IData)) as IData
myMapData | myIData

Parameters:

other Type: IData - the other data.

Return Type: IData

<<
<<(other as IData) as IData
Applies a SHL (<<) operation to this data by the other data
script.zs
// (MapData << (other as IData)) as IData
myMapData << myIData

Parameters:

other Type: IData - The data to SHL by.

Return Type: IData

>>
>>(other as IData) as IData
Applies a SHR (>>) operation to this data by the other data
script.zs
// (MapData >> (other as IData)) as IData
myMapData >> myIData

Parameters:

other Type: IData - The data to SHR by.

Return Type: IData

-
-(other as IData) as IData
Subtracts the given IData from this IData.
script.zs
// (MapData - (other as IData)) as IData
-myMapData

Parameters:

other Type: IData - the other data to remove.

Return Type: IData

^
^(other as IData) as IData
Applies a bitwise XOR (^) operation to this IData and the other IData
script.zs
// (MapData ^ (other as IData)) as IData
myMapData ^ myIData

Parameters:

other Type: IData - the other data.

Return Type: IData

Members

add
add(other as IData) as IData
Adds the given IData to this IData.

Returns: A new IData after adding the other data.

script.zs
// MapData.add(other as IData) as IData;
myMapData.add(2);

Parameters:

other Type: IData - the other data to add.

Return Type: IData

asBool
asBool() as bool
Casts this IData to a boolean.

Returns: this data as a bool

script.zs
// MapData.asBool() as bool;
myMapData.asBool();

Return Type: bool

as bool
Casts this IData to a boolean.
script.zs
// MapData as bool
myMapData as bool

Return Type: bool

asByte
asByte() as byte
Casts this IData to a byte.

Returns: this data as a byte

script.zs
// MapData.asByte() as byte;
myMapData.asByte();

Return Type: byte

as byte
Casts this IData to a byte.
script.zs
// MapData as byte
myMapData as byte

Return Type: byte

asByteArray
asByteArray() as byte[]
Casts this IData to a byte array.

Returns: this data as a byte array

script.zs
// MapData.asByteArray() as byte[];
myMapData.asByteArray();

Return Type: byte[]

as byte[]
Casts this IData to a byte array.
script.zs
// MapData as byte[]
myMapData as byte[]

Return Type: byte[]

asDouble
asDouble() as double
Casts this IData to a double.

Returns: this data as a double

script.zs
// MapData.asDouble() as double;
myMapData.asDouble();

Return Type: double

as double
Casts this IData to a double.
script.zs
// MapData as double
myMapData as double

Return Type: double

asFloat
asFloat() as float
Casts this IData to a float.

Returns: this data as a float

script.zs
// MapData.asFloat() as float;
myMapData.asFloat();

Return Type: float

as float
Casts this IData to a float.
script.zs
// MapData as float
myMapData as float

Return Type: float

asInt
asInt() as int
Casts this IData to an int.

Returns: this data as an int

script.zs
// MapData.asInt() as int;
myMapData.asInt();

Return Type: int

as int
Casts this IData to an int.
script.zs
// MapData as int
myMapData as int

Return Type: int

asIntArray
asIntArray() as int[]
Casts this IData to an int array.

Returns: this data as an int array

script.zs
// MapData.asIntArray() as int[];
myMapData.asIntArray();

Return Type: int[]

as int[]
Casts this IData to an int array.
script.zs
// MapData as int[]
myMapData as int[]

Return Type: int[]

asList
asList() as List<IData>
Casts this IData to a list.

Returns: this data as a list

script.zs
// MapData.asList() as List<IData>;
myMapData.asList();

Return Type: List<IData>

as List<IData>
Casts this IData to a list.
script.zs
// MapData as List<IData>
myMapData as List<IData>

Return Type: List<IData>

asLong
asLong() as long
Casts this IData to a long.

Returns: this data as a long

script.zs
// MapData.asLong() as long;
myMapData.asLong();

Return Type: long

as long
Casts this IData to a long.
script.zs
// MapData as long
myMapData as long

Return Type: long

asLongArray
asLongArray() as long[]
Casts this IData to a long array.

Returns: this data as a long array

script.zs
// MapData.asLongArray() as long[];
myMapData.asLongArray();

Return Type: long[]

as long[]
Casts this IData to a long array.
script.zs
// MapData as long[]
myMapData as long[]

Return Type: long[]

asShort
asShort() as short
Casts this IData to a short.

Returns: this data as a short

script.zs
// MapData.asShort() as short;
myMapData.asShort();

Return Type: short

as short
Casts this IData to a short.
script.zs
// MapData as short
myMapData as short

Return Type: short

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

script.zs
// MapData.asString() as string;
myMapData.asString();

Return Type: string

compareTo
compareTo(other as IData) as int
Compares this IData to the other IData

Returns: The comparison result.

script.zs
// MapData.compareTo(other as IData) as int;
myMapData.compareTo(5);

Parameters:

other Type: IData - the data to be compared.

Return Type: int

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

script.zs
// MapData.getAsString() as string;
myMapData.getAsString();

Return Type: string

as string
Gets the literal string version of this IData.

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

script.zs
// MapData as string
myMapData as string

Return Type: string

getId
getId() as byte
Gets the internal ID of this data.

Returns: the intenral ID of this data.

script.zs
// MapData.getId() as byte;
myMapData.getId();

Return Type: byte

isEmpty
Getter
Checks if this data is empty.
script.zs
// MapData.isEmpty as bool
myMapData.isEmpty

Return Type: bool

isEmpty() as bool
Checks if this data is empty.

Returns: True if empty.

script.zs
// MapData.isEmpty() as bool;
myMapData.isEmpty();

Return Type: bool

listOf
static listOf(members as IData[]) as IData
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.

script.zs
// MapData.listOf(members as IData[]) as IData;
MapData.listOf(1, 2, 3);

Parameters:

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

Return Type: IData

map
map(operation as function(r as IData) as IData) as IData
Maps this IData to another IData based on the given operation.

Returns: A new IData from the operation

script.zs
// MapData.map(operation as function(r as IData) as IData) as IData;
myMapData.map((data) => 3);

Parameters:

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

Return Type: IData

putAll
putAll(map as IData[string])
Adds all entries from the given map into this one. Can override existing keys.
script.zs
// MapData.putAll(map as IData[string]);
myMapData.putAll({Hello: "Goodbye", Item: "Bedrock"});

Parameters:

map Type: IData[string] - The other entries to be added to this map
setAt
setAt(name as string, data as IData)
Sets the given value inside this IData at the given index.
script.zs
// MapData.setAt(name as string, data as IData);
myMapData.setAt(myString, myIData);

Parameters:

name Type: string - The key to store the data at
data Type: IData - The data to store.
Previous
LongData ShortData
Next