Previous
ByteArrayData DoubleData
Next

ByteData

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

Description

Implements

ByteData implements the following interfaces:

IData

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Constructors

new
new(internal as byte)
script.zs
// new ByteData(internal as byte);
new ByteData(myByte);

Parameters:

internal Type: byte

Operators

~
~(other as IData) as IData
Concatenates the given IData to this IData.
script.zs
// (ByteData ~ (other as IData)) as IData
myByteData ~ myIData

Parameters:

other Type: IData - the other data to concatenate.

Return Type: IData

[]
[](index as int) as IData
Gets the data at the given index.
script.zs
// ByteData[index as int] as IData
myByteData[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
// ByteData[key as string] as IData
myByteData[myString]

Parameters:

key Type: string - The key to get

Return Type: IData

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

Return Type: IData

[]=
[]=(index as string, value as IData)
Puts the given value inside this IData at the given index.
script.zs
// ByteData[index as string] = (value as IData)
myByteData[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
// (ByteData << (other as IData)) as IData
myByteData << 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
// (ByteData >> (other as IData)) as IData
myByteData >> myIData

Parameters:

other Type: IData - The data to SHR by.

Return Type: IData

Members

asByteArray
asByteArray() as byte[]
Casts this IData to a byte array.

Returns: this data as a byte array

script.zs
// ByteData.asByteArray() as byte[];
myByteData.asByteArray();

Return Type: byte[]

as byte[]
Casts this IData to a byte array.
script.zs
// ByteData as byte[]
myByteData as byte[]

Return Type: byte[]

asIntArray
asIntArray() as int[]
Casts this IData to an int array.

Returns: this data as an int array

script.zs
// ByteData.asIntArray() as int[];
myByteData.asIntArray();

Return Type: int[]

as int[]
Casts this IData to an int array.
script.zs
// ByteData as int[]
myByteData as int[]

Return Type: int[]

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

Returns: this data as a list

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

Return Type: List<IData>

as List<IData>
Casts this IData to a list.
script.zs
// ByteData as List<IData>
myByteData as List<IData>

Return Type: List<IData>

asLongArray
asLongArray() as long[]
Casts this IData to a long array.

Returns: this data as a long array

script.zs
// ByteData.asLongArray() as long[];
myByteData.asLongArray();

Return Type: long[]

as long[]
Casts this IData to a long array.
script.zs
// ByteData as long[]
myByteData as long[]

Return Type: long[]

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

Returns: this data as a map

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

Return Type: IData[string]

as IData[string]
Casts this IData to a map.
script.zs
// ByteData as IData[string]
myByteData as IData[string]

Return Type: IData[string]

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
// ByteData.asString() as string;
myByteData.asString();

Return Type: string

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

Return Type: byte

isEmpty
Getter
Checks if this data is empty.
script.zs
// ByteData.isEmpty as bool
myByteData.isEmpty

Return Type: bool

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

Returns: True if empty.

script.zs
// ByteData.isEmpty() as bool;
myByteData.isEmpty();

Return Type: bool

keys
Getter
Gets the keys of this IData
script.zs
// ByteData.keys as Set<string>
myByteData.keys

Return Type: Set<string>

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

Returns: The keys of this IData.

script.zs
// ByteData.keys() as Set<string>;
myByteData.keys();

Return Type: Set<string>

length
Getter
Gets the length of this IData.
script.zs
// ByteData.length as int
myByteData.length

Return Type: int

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

Returns: The length of this IData.

script.zs
// ByteData.length() as int;
myByteData.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
// ByteData.listOf(members as IData[]) as IData;
ByteData.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
// ByteData.map(operation as function(r as IData) as IData) as IData;
myByteData.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
// ByteData.merge(other as IData) as IData;
myByteData.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
// ByteData.put(index as string, value as IData);
myByteData.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
// ByteData.remove(index as int);
myByteData.remove(0);

Parameters:

index Type: int - The index to remove.
remove(key as string)
Removes the stored data at the given key.
script.zs
// ByteData.remove(key as string);
myByteData.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
// ByteData.setAt(name as string, data as IData);
myByteData.setAt(myString, myIData);

Parameters:

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