ByteArrayData

Version:

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

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.

import crafttweaker.api.data.ByteArrayData;

Description

Implements

ByteArrayData implements the following interfaces:

IData

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Constructors

// new ByteArrayData(internal as byte[]);
new ByteArrayData(myByte[]);

Parameters:

internal: byte[] Type: byte[]

Operators

Adds the given IData to this IData.

// (ByteArrayData + (other as IData)) as IData
([4, 1, 2] as IData) + myIData

Parameters:

other: IData Type: IData - the other data to add.

Return Type: IData

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

// (ByteArrayData & (other as IData)) as IData
([4, 1, 2] as IData) & myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Concatenates the given IData to this IData.

// (ByteArrayData ~ (other as IData)) as IData
([4, 1, 2] as IData) ~ myIData

Parameters:

other: IData Type: IData - the other data to concatenate.

Return Type: IData

Divides the given IData from this IData.

// (ByteArrayData / (other as IData)) as IData
([4, 1, 2] as IData) / myIData

Parameters:

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

Return Type: IData

Gets the data at the given key.

// ByteArrayData[key as string] as IData
([4, 1, 2] as IData)[myString]

Parameters:

key: string Type: string - The key to get

Return Type: IData

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

// (ByteArrayData % (other as IData)) as IData
([4, 1, 2] as IData) % myIData

Parameters:

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

Return Type: IData

Multiplies the given IData to this IData.

// (ByteArrayData * (other as IData)) as IData
([4, 1, 2] as IData) * myIData

Parameters:

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

Return Type: IData

Negates this IData.

// (-ByteArrayData) as IData
-([4, 1, 2] as IData)

Return Type: IData

Applies a NOT (!) operation to this IData.

// (!ByteArrayData) as IData
!([4, 1, 2] as IData)

Return Type: IData

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

// (ByteArrayData | (other as IData)) as IData
([4, 1, 2] as IData) | myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

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

// (ByteArrayData << (other as IData)) as IData
([4, 1, 2] as IData) << myIData

Parameters:

other: IData Type: IData - The data to SHL by.

Return Type: IData

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

// (ByteArrayData >> (other as IData)) as IData
([4, 1, 2] as IData) >> myIData

Parameters:

other: IData Type: IData - The data to SHR by.

Return Type: IData

Subtracts the given IData from this IData.

// (ByteArrayData - (other as IData)) as IData
-([4, 1, 2] as IData)

Parameters:

other: IData Type: IData - the other data to remove.

Return Type: IData

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

// (ByteArrayData ^ (other as IData)) as IData
([4, 1, 2] as IData) ^ myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Members

Adds the given IData to this IData.

Returns: A new IData after adding the other data.

// ByteArrayData.add(other as IData) as IData;
([4, 1, 2] as IData).add(2);

Parameters:

other: IData Type: IData - the other data to add.

Return Type: IData

Casts this IData to a boolean.

Returns: this data as a bool

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

Return Type: bool

Casts this IData to a boolean.

// ByteArrayData as bool
([4, 1, 2] as IData) as bool

Return Type: bool

Casts this IData to a byte.

Returns: this data as a byte

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

Return Type: byte

Casts this IData to a byte.

// ByteArrayData as byte
([4, 1, 2] as IData) as byte

Return Type: byte

Casts this IData to a double.

Returns: this data as a double

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

Return Type: double

Casts this IData to a double.

// ByteArrayData as double
([4, 1, 2] as IData) as double

Return Type: double

Casts this IData to a float.

Returns: this data as a float

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

Return Type: float

Casts this IData to a float.

// ByteArrayData as float
([4, 1, 2] as IData) as float

Return Type: float

Casts this IData to an int.

Returns: this data as an int

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

Return Type: int

Casts this IData to an int.

// ByteArrayData as int
([4, 1, 2] as IData) as int

Return Type: int

Casts this IData to a long.

Returns: this data as a long

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

Return Type: long

Casts this IData to a long.

// ByteArrayData as long
([4, 1, 2] as IData) as long

Return Type: long

Casts this IData to a map.

Returns: this data as a map

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

Return Type: IData[string]

Casts this IData to a map.

// ByteArrayData as IData[string]
([4, 1, 2] as IData) as IData[string]

Return Type: IData[string]

Casts this IData to a short.

Returns: this data as a short

// ByteArrayData.asShort() as short;
([4, 1, 2] as IData).asShort();

Return Type: short

Casts this IData to a short.

// ByteArrayData as short
([4, 1, 2] as IData) as short

Return Type: short

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.

// ByteArrayData.asString() as string;
([4, 1, 2] as IData).asString();

Return Type: 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.

// ByteArrayData.getAsString() as string;
([4, 1, 2] as IData).getAsString();

Return Type: string

Gets the literal string version of this IData.

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

// ByteArrayData as string
([4, 1, 2] as IData) as string

Return Type: string

Gets the internal ID of this data.

Returns: the intenral ID of this data.

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

Return Type: byte

Checks if this data is empty.

// ByteArrayData.isEmpty as bool
([4, 1, 2] as IData).isEmpty

Return Type: bool

Checks if this data is empty.

Returns: True if empty.

// ByteArrayData.isEmpty() as bool;
([4, 1, 2] as IData).isEmpty();

Return Type: bool

Gets the keys of this IData

// ByteArrayData.keys as Set<string>
([4, 1, 2] as IData).keys

Return Type: Set<string>

Gets the keys of this IData

Returns: The keys of this IData.

// ByteArrayData.keys() as Set<string>;
([4, 1, 2] as IData).keys();

Return Type: Set<string>

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.

// ByteArrayData.listOf(members as IData[]) as IData;
ByteArrayData.listOf(1, 2, 3);

Parameters:

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

Return Type: IData

Maps this IData to another IData based on the given operation.

Returns: A new IData from the operation

// ByteArrayData.map(operation as function(r as IData) as IData) as IData;
([4, 1, 2] as IData).map((data) => 3);

Parameters:

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

Return Type: IData

Merges the given data with this data.

Returns: the result of merging the datas.

// ByteArrayData.merge(other as IData) as IData;
([4, 1, 2] as IData).merge(myIData);

Parameters:

other: IData Type: IData - the data to merge

Return Type: IData

Removes the stored data at the given key.

// ByteArrayData.remove(key as string);
([4, 1, 2] as IData).remove("key");

Parameters:

key: string Type: string - The key to remove.

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

// ByteArrayData.setAt(name as string, data as IData);
([4, 1, 2] as IData).setAt(myString, myIData);

Parameters:

name: string Type: string - The key to store the data at

data: IData Type: IData - The data to store.