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

Implemented Interfaces

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

IData

Constructors

ZenScript
 Copy
new ByteArrayData(internal as byte[]) as ByteArrayData

Parameter	Type
Parameter internal	Type byte[]

Casters

Result Type	Is Implicit
Result Type boolean	Is Implicit false
Result Type byte	Is Implicit false
Result Type double	Is Implicit false
Result Type float	Is Implicit false
Result Type IData[string]	Is Implicit false
Result Type int	Is Implicit false
Result Type long	Is Implicit false
Result Type short	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
// ByteArrayData.add(other as IData) as IData

([4, 1, 2] as IData).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
// ByteArrayData.asBool() as boolean

([4, 1, 2] as IData).asBool();

asByte

Name: asByte

Casts this IData to a byte.

Returns: this data as a byte
Return Type: byte

ZenScript
 Copy
// ByteArrayData.asByte() as byte

([4, 1, 2] as IData).asByte();

asDouble

Name: asDouble

Casts this IData to a double.

Returns: this data as a double
Return Type: double

ZenScript
 Copy
// ByteArrayData.asDouble() as double

([4, 1, 2] as IData).asDouble();

asFloat

Name: asFloat

Casts this IData to a float.

Returns: this data as a float
Return Type: float

ZenScript
 Copy
// ByteArrayData.asFloat() as float

([4, 1, 2] as IData).asFloat();

asInt

Name: asInt

Casts this IData to an int.

Returns: this data as an int
Return Type: int

ZenScript
 Copy
// ByteArrayData.asInt() as int

([4, 1, 2] as IData).asInt();

asLong

Name: asLong

Casts this IData to a long.

Returns: this data as a long
Return Type: long

ZenScript
 Copy
// ByteArrayData.asLong() as long

([4, 1, 2] as IData).asLong();

asMap

Name: asMap

Casts this IData to a map.

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

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

([4, 1, 2] as IData).asMap();

asShort

Name: asShort

Casts this IData to a short.

Returns: this data as a short
Return Type: short

ZenScript
 Copy
// ByteArrayData.asShort() as short

([4, 1, 2] as IData).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
// ByteArrayData.asString() as string

([4, 1, 2] 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
// ByteArrayData.getAsString() as string

([4, 1, 2] 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
// ByteArrayData.getId() as byte

([4, 1, 2] as IData).getId();

getKeys

Name: getKeys

Gets the keys of this IData

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

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

([4, 1, 2] as IData).getKeys();

isEmpty

Name: isEmpty

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

ZenScript
 Copy
// ByteArrayData.isEmpty() as boolean

([4, 1, 2] as IData).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
// ByteArrayData.map(operation as Function<IData,IData>) as IData

([4, 1, 2] 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
ByteArrayData.merge(other as IData) as IData

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

remove

Name: remove

Removes the stored data at the given key.

ZenScript
 Copy
// ByteArrayData.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
ByteArrayData.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
myByteArrayData + other as IData
([4, 1, 2] as IData) + 2

AND

Name: AND

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

ZenScript
 Copy
myByteArrayData & other as IData
([4, 1, 2] as IData) & 2

CAT

Name: CAT

Concatenates the given IData to this IData.

ZenScript
 Copy
myByteArrayData ~ other as IData
([4, 1, 2] as IData) ~ 2

DIV

Name: DIV

Divides the given IData from this IData.

ZenScript
 Copy
myByteArrayData / other as IData
([4, 1, 2] as IData) / 2

INDEXGET

Name: INDEXGET

Gets the data at the given key.

ZenScript
 Copy
[myByteArrayData]

MOD

Name: MOD

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

ZenScript
 Copy
myByteArrayData % other as IData
([4, 1, 2] as IData) % 2

MUL

Name: MUL

Multiplies the given IData to this IData.

ZenScript
 Copy
myByteArrayData * other as IData
([4, 1, 2] as IData) * 2

NEG

Name: NEG

Negates this IData.

ZenScript
 Copy
-myByteArrayData
-([4, 1, 2] as IData)

NOT

Name: NOT

Applies a NOT (!) operation to this IData.

ZenScript
 Copy
!myByteArrayData
!true

Name: OR

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

ZenScript
 Copy
myByteArrayData | other as IData
([4, 1, 2] as IData) | 2

SHL

Name: SHL

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

ZenScript
 Copy
myByteArrayData << other as IData
([4, 1, 2] as IData) << 2

SHR

Name: SHR

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

ZenScript
 Copy
myByteArrayData >> other as IData
([4, 1, 2] as IData) >> 2

SUB

Name: SUB

Subtracts the given IData from this IData.

ZenScript
 Copy
myByteArrayData - other as IData
([4, 1, 2] as IData) - 2

XOR

Name: XOR

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

ZenScript
 Copy
myByteArrayData ^ other as IData
([4, 1, 2] as IData) ^ 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.
Name keys	Type Set<string>	Has Getter true	Has Setter false	Description Gets the keys of this IData