Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
BoolData ByteArrayData ByteData DoubleData EmptyData FloatData IData IntArrayData IntData ListData LongArrayData LongData MapData ShortData StringData
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
FloatData IntArrayData
Next

IData

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

Description

Loaders

This type is available in the following loaders:

  • crafttweaker
  • tags

Implements

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Operators

+
+(other as IData) as IData
Adds the given IData to this IData.
script.zs
// (IData + (other as IData)) as IData
(1 as IData) + 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
// (IData & (other as IData)) as IData
(1 as IData) & 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
// (IData ~ (other as IData)) as IData
(1 as IData) ~ myIData

Parameters:

other Type: IData - the other data to concatenate.

Return Type: IData

in
in(other as IData) as bool
Checks if this IData contains the other IData


For most data types, this will check equality of the data, but for map data, it will check if the other data is a string, and then check if it contains a key with that name

script.zs
// ((other as IData) in IData) as bool
myIData in (1 as IData)

Parameters:

other Type: IData - the other data to check

Return Type: bool

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

Parameters:

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

Return Type: IData

==
==(other as IData) as bool
Checks if this IData is equal to the other IData.
script.zs
// (IData == (other as IData)) as bool
(1 as IData) == myIData

Parameters:

other Type: IData - The data to check equality of.

Return Type: bool

[]
[](index as int) as IData
Gets the data at the given index.
script.zs
// IData[index as int] as IData
(1 as IData)[myInt]

Parameters:

index Type: int - The index to get

Return Type: IData

[](key as string) as IData
Gets the data at the given key.
script.zs
// IData[key as string] as IData
(1 as IData)[myString]

Parameters:

key Type: string - The key to get

Return Type: IData

%
%(other as IData) as IData
Applies a modulo operation to this IData against the other IData.
script.zs
// (IData % (other as IData)) as IData
(1 as IData) % 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
// (IData * (other as IData)) as IData
(1 as IData) * myIData

Parameters:

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

Return Type: IData

-
- as IData
Negates this IData.
script.zs
// (-IData) as IData
-(1 as IData)

Return Type: IData

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

Return Type: IData

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

Parameters:

other Type: IData - the other data.

Return Type: IData

[]=
[]=(index as string, value as IData)
Puts the given value inside this IData at the given index.
script.zs
// IData[index as string] = (value as IData)
(1 as IData)[myString] = myIData

Parameters:

index Type: string - The key to store the data at
value Type: IData - The data to store.
<<
<<(other as IData) as IData
Applies a SHL (<<) operation to this data by the other data
script.zs
// (IData << (other as IData)) as IData
(1 as IData) << 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
// (IData >> (other as IData)) as IData
(1 as IData) >> 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
// (IData - (other as IData)) as IData
-(1 as IData)

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
// (IData ^ (other as IData)) as IData
(1 as IData) ^ 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
// IData.add(other as IData) as IData;
(1 as IData).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
// IData.asBool() as bool;
(1 as IData).asBool();

Return Type: bool

as bool
Casts this IData to a boolean.
script.zs
// IData as bool
(1 as IData) as bool

Return Type: bool

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

Returns: this data as a byte

script.zs
// IData.asByte() as byte;
(1 as IData).asByte();

Return Type: byte

as byte
Casts this IData to a byte.
script.zs
// IData as byte
(1 as IData) 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
// IData.asByteArray() as byte[];
(1 as IData).asByteArray();

Return Type: byte[]

as byte[]
Casts this IData to a byte array.
script.zs
// IData as byte[]
(1 as IData) as byte[]

Return Type: byte[]

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

Returns: this data as a double

script.zs
// IData.asDouble() as double;
(1 as IData).asDouble();

Return Type: double

as double
Casts this IData to a double.
script.zs
// IData as double
(1 as IData) as double

Return Type: double

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

Returns: this data as a float

script.zs
// IData.asFloat() as float;
(1 as IData).asFloat();

Return Type: float

as float
Casts this IData to a float.
script.zs
// IData as float
(1 as IData) as float

Return Type: float

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

Returns: this data as an int

script.zs
// IData.asInt() as int;
(1 as IData).asInt();

Return Type: int

as int
Casts this IData to an int.
script.zs
// IData as int
(1 as IData) 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
// IData.asIntArray() as int[];
(1 as IData).asIntArray();

Return Type: int[]

as int[]
Casts this IData to an int array.
script.zs
// IData as int[]
(1 as IData) as int[]

Return Type: int[]

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

Returns: this data as a list

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

Return Type: List<IData>

as List<IData>
Casts this IData to a list.
script.zs
// IData as List<IData>
(1 as IData) 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
// IData.asLong() as long;
(1 as IData).asLong();

Return Type: long

as long
Casts this IData to a long.
script.zs
// IData as long
(1 as IData) 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
// IData.asLongArray() as long[];
(1 as IData).asLongArray();

Return Type: long[]

as long[]
Casts this IData to a long array.
script.zs
// IData as long[]
(1 as IData) as long[]

Return Type: long[]

asMap
asMap() as IData[string]
Casts this IData to a map.

Returns: this data as a map

script.zs
// IData.asMap() as IData[string];
(1 as IData).asMap();

Return Type: IData[string]

as IData[string]
Casts this IData to a map.
script.zs
// IData as IData[string]
(1 as IData) as IData[string]

Return Type: IData[string]

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

Returns: this data as a short

script.zs
// IData.asShort() as short;
(1 as IData).asShort();

Return Type: short

as short
Casts this IData to a short.
script.zs
// IData as short
(1 as IData) 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
// IData.asString() as string;
(1 as IData).asString();

Return Type: string

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

Returns: The comparison result.

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

Parameters:

other Type: IData - the data to be compared.

Return Type: int

copy
copy() as IData
script.zs
// IData.copy() as IData;
(1 as IData).copy();

Return Type: IData

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
// IData.getAsString() as string;
(1 as IData).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
// IData as string
(1 as IData) 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
// IData.getId() as byte;
(1 as IData).getId();

Return Type: byte

isEmpty
Getter
Checks if this data is empty.
script.zs
// IData.isEmpty as bool
(1 as IData).isEmpty

Return Type: bool

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

Returns: True if empty.

script.zs
// IData.isEmpty() as bool;
(1 as IData).isEmpty();

Return Type: bool

keys
Getter
Gets the keys of this IData
script.zs
// IData.keys as Set<string>
(1 as IData).keys

Return Type: Set<string>

keys() as Set<string>
Gets the keys of this IData

Returns: The keys of this IData.

script.zs
// IData.keys() as Set<string>;
(1 as IData).keys();

Return Type: Set<string>

length
Getter
Gets the length of this IData.
script.zs
// IData.length as int
(1 as IData).length

Return Type: int

length() as int
Gets the length of this IData.

Returns: The length of this IData.

script.zs
// IData.length() as int;
(1 as IData).length();

Return Type: int

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
// IData.listOf(members as IData[]) as IData;
IData.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
// IData.map(operation as function(r as IData) as IData) as IData;
(1 as IData).map((data) => 3);

Parameters:

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

Return Type: IData

merge
merge(other as IData) as IData
Merges the given data with this data.

Returns: the result of merging the datas.

script.zs
// IData.merge(other as IData) as IData;
(1 as IData).merge(myIData);

Parameters:

other Type: IData - the data to merge

Return Type: IData

put
put(index as string, value as IData)
Puts the given value inside this IData at the given index.
script.zs
// IData.put(index as string, value as IData);
(1 as IData).put("key", "value");

Parameters:

index Type: string - The key to store the data at
value Type: IData - The data to store.
remove
remove(index as int)
Removes the stored data at the given index.
script.zs
// IData.remove(index as int);
(1 as IData).remove(0);

Parameters:

index Type: int - The index to remove.
remove(key as string)
Removes the stored data at the given key.
script.zs
// IData.remove(key as string);
(1 as IData).remove("key");

Parameters:

key Type: string - The key to remove.
setAt
setAt(name as string, data as IData)
Sets the given value inside this IData at the given index.
script.zs
// IData.setAt(name as string, data as IData);
(1 as IData).setAt(myString, myIData);

Parameters:

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