ShortData - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide

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

Implemented Interfaces

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

IData

Constructors

ZenScript
 Copy
new ShortData(internal as short) as ShortData

Parameter	Type
Parameter internal	Type short

Casters

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

Methods

asByteArray

Name: asByteArray

Casts this IData to a byte array.

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

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

(1058 as IData).asByteArray();

asIntArray

Name: asIntArray

Casts this IData to an int array.

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

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

(1058 as IData).asIntArray();

asList

Name: asList

Casts this IData to a list.

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

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

(1058 as IData).asList();

asLongArray

Name: asLongArray

Casts this IData to a long array.

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

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

(1058 as IData).asLongArray();

asMap

Name: asMap

Casts this IData to a map.

Returns: this data as a map
Return Type: IData[string]

ZenScript
 Copy
// ShortData.asMap() as IData[string]

(1058 as IData).asMap();

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

(1058 as IData).asString();

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

(1058 as IData).getAsString();

getId

Name: getId

Gets the internal ID of this data.

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

ZenScript
 Copy
// ShortData.getId() as byte

(1058 as IData).getId();

getKeys

Name: getKeys

Gets the keys of this IData

Returns: The keys of this IData.
Return Type: Set<string>

ZenScript
 Copy
// ShortData.getKeys() as Set<string>

(1058 as IData).getKeys();

isEmpty

Name: isEmpty

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

ZenScript
 Copy
// ShortData.isEmpty() as boolean

(1058 as IData).isEmpty();

length

Name: length

Gets the length of this IData.

Returns: The length of this IData.
Return Type: int

ZenScript
 Copy
// ShortData.length() as int

(1058 as IData).length();

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
// ShortData.map(operation as Function<IData,IData>) as IData

(1058 as IData).map((data) => 3);

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

merge

Name: merge

Merges the given data with this data.

Returns: the result of merging the datas.
Return Type: IData

ZenScript
 Copy
ShortData.merge(other as IData) as IData

Parameter	Type	Description
Parameter other	Type IData	Description the data to merge

put

Name: put

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

ZenScript
 Copy
// ShortData.put(index as string, value as IData?)

new MapData().put("key", "value");

Parameter	Type	Description
Parameter index	Type string	Description The key to store the data at
Parameter value	Type IData?	Description The data to store.

remove

Name: remove

Removes the stored data at the given index.

ZenScript
 Copy
// ShortData.remove(index as int)

[1, 2, 3] as IData.remove(0);

Parameter	Type	Description
Parameter index	Type int	Description The index to remove.

remove

Name: remove

Removes the stored data at the given key.

ZenScript
 Copy
// ShortData.remove(key as string)

{key: "value"} as IData.remove("key");

Parameter	Type	Description
Parameter key	Type string	Description The key to remove.

setAt

Name: setAt

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

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

CAT

Name: CAT

Concatenates the given IData to this IData.

ZenScript
 Copy
myShortData ~ other as IData
(1058 as IData) ~ 2

INDEXGET

Name: INDEXGET

Gets the data at the given index.

ZenScript
 Copy
[myShortData]
[[1, 2, 3] as IData]

INDEXSET

Name: INDEXSET

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

ZenScript
 Copy
[myShortData] = index as string
[new MapData()] = "key"

NOT

Name: NOT

Applies a NOT (!) operation to this IData.

ZenScript
 Copy
!myShortData
!true

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.
Name keys	Type Set<string>	Has Getter true	Has Setter false	Description Gets the keys of this IData
Name length	Type int	Has Getter true	Has Setter false	Description Gets the length of this IData.