MapData

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

Constructors

No Description Provided

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

No Description Provided

ZenScript
Copy
new MapData(map as IData[string]) as MapData
ParameterTypeDescription
mapIData[string]No Description Provided

Casters

Result typeIs Implicit
ICollectionDatafalse
IData[string]true
INumberDatafalse

Methods

asCollection

Return Type: ICollectionData

ZenScript
Copy
// MapData.asCollection() as ICollectionData

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

Gets a List representation of this IData, returns null on anything but ListData.

Returns: null if this IData is not a list.
Return Type: stdlib.List<IData>

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

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

Return Type: INumberData

ZenScript
Copy
// MapData.asNumber() as INumberData

{Hello : "World", Somewhere: "Over the rainbow"}.asNumber();
contains

Checks if the Map contains the given key.

Returns: True if the Map contains the key
Return Type: boolean

ZenScript
Copy
// MapData.contains(key as string) as boolean

{Hello : "World", Somewhere: "Over the rainbow"}.contains("Hello");
ParameterTypeDescription
keystringThe key to search for
getAt

Retrieves the value associated with the key

Returns: The value if present, null otherwise
Return Type: IData

ZenScript
Copy
// MapData.getAt(key as string) as IData

{Hello : "World", Somewhere: "Over the rainbow"}.getAt("Hello");
ParameterTypeDescription
keystringThe key to search for
getId

Gets the ID of the internal NBT tag.

Used to determine what NBT type is stored (in a list for example)

Returns: ID of the NBT tag that this data represents.
Return Type: byte

ZenScript
Copy
// MapData.getId() as byte

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

Gets the String representation of the internal INBT tag

Returns: String that represents the internal INBT of this IData.
Return Type: string

ZenScript
Copy
// MapData.getString() as string

{Hello : "World", Somewhere: "Over the rainbow"}.getString();
merge

Merges this map and the other map. If entries from this map and the other map share the values are tried to be merged. If that does not work, then the value from the other map is used.

Returns: This map, after the merge
Return Type: MapData

ZenScript
Copy
// MapData.merge(other as MapData) as MapData

{Hello : "World", Somewhere: "Over the rainbow"}.merge({Doodle: "Do"});
ParameterTypeDescription
otherMapDataThe other map.
put

Adds sets the value for the given key or creates a new entry if it did not exist before.

Returns: The previous value if present, null otherwise
Return Type: IData

ZenScript
Copy
// MapData.put(key as string, value as IData) as IData

{Hello : "World", Somewhere: "Over the rainbow"}.put("Hello", "Goodbye");
ParameterTypeDescription
keystringThe key to set the value for.
valueIDataThe value to set.
putAll

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

Return Type: void

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

{Hello : "World", Somewhere: "Over the rainbow"}.putAll({Hello: "Goodbye", Item: "Bedrock"});
ParameterTypeDescription
mapIData[string]The other entries to be added to this map
remove

Removes the entry with the given key from the Map

Return Type: void

ZenScript
Copy
// MapData.remove(key as string) as void

{Hello : "World", Somewhere: "Over the rainbow"}.remove("Somewhere");
ParameterTypeDescription
keystringThe key of the entry to remove

Operators

ADD

Adds all entries from the given IData to this entry

ZenScript
Copy
myMapData + data as IData
MEMBERGETTER

Retrieves the value associated with the key

ZenScript
Copy
myMapData.key as string
{Hello : "World", Somewhere: "Over the rainbow"}."Hello"
MEMBERSETTER

Adds sets the value for the given key or creates a new entry if it did not exist before.

ZenScript
Copy
myMapData.key as string = value as IData
{Hello : "World", Somewhere: "Over the rainbow"}."Hello" = "Goodbye"

Properties

NameTypeHas GetterHas SetterDescription
isEmptybooleantruefalseNo Description Provided
keySetSet<string>truefalseNo Description Provided
sizeinttruefalseNo Description Provided