ByteData
Link to bytedata
Importing the class
Link to 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 Copyimport crafttweaker.api.data.ByteData;
Implemented Interfaces
Link to implemented-interfaces
ByteData implements the following interfaces. That means all methods defined in these interfaces are also available in ByteData
Constructors
Link to constructors
ZenScript Copynew ByteData(internal as byte) as ByteData
Parameter | Type |
---|---|
Parameter internal | Type byte |
Casters
Link to 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
Link to methods
Name: asByteArray
Casts this IData to a byte array.
Returns: this data as a byte array
Return Type: byte[]
ZenScript Copy// ByteData.asByteArray() as byte[]
(4 as IData).asByteArray();
Name: asIntArray
Casts this IData to an int array.
Returns: this data as an int array
Return Type: int[]
ZenScript Copy// ByteData.asIntArray() as int[]
(4 as IData).asIntArray();
Name: asList
Casts this IData to a list.
Returns: this data as a list
Return Type: stdlib.List<IData>
ZenScript Copy// ByteData.asList() as stdlib.List<IData>
(4 as IData).asList();
Name: asLongArray
Casts this IData to a long array.
Returns: this data as a long array
Return Type: long[]
ZenScript Copy// ByteData.asLongArray() as long[]
(4 as IData).asLongArray();
Name: asMap
Casts this IData to a map.
Returns: this data as a map
Return Type: IData[string]
ZenScript Copy// ByteData.asMap() as IData[string]
(4 as IData).asMap();
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// ByteData.asString() as string
(4 as IData).asString();
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// ByteData.getAsString() as string
(4 as IData).getAsString();
Name: getId
Gets the internal ID of this data.
Returns: the intenral ID of this data.
Return Type: byte
ZenScript Copy// ByteData.getId() as byte
(4 as IData).getId();
Name: getKeys
Gets the keys of this IData
Returns: The keys of this IData.
Return Type: Set<string>
ZenScript Copy// ByteData.getKeys() as Set<string>
(4 as IData).getKeys();
Name: isEmpty
Checks if this data is empty.
Returns: True if empty.
Return Type: boolean
ZenScript Copy// ByteData.isEmpty() as boolean
(4 as IData).isEmpty();
Name: length
Gets the length of this IData.
Returns: The length of this IData.
Return Type: int
ZenScript Copy// ByteData.length() as int
(4 as IData).length();
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// ByteData.map(operation as Function<IData,IData>) as IData
(4 as IData).map((data) => 3);
Parameter | Type | Description |
---|---|---|
Parameter operation | Type Function<IData,IData> | Description The operation to apply to this IData |
Name: put
Puts the given value inside this IData at the given index.
ZenScript Copy// ByteData.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. |
Name: remove
Removes the stored data at the given index.
ZenScript Copy// ByteData.remove(index as int)
[1, 2, 3] as IData.remove(0);
Parameter | Type | Description |
---|---|---|
Parameter index | Type int | Description The index to remove. |
Name: remove
Removes the stored data at the given key.
ZenScript Copy// ByteData.remove(key as string)
{key: "value"} as IData.remove("key");
Parameter | Type | Description |
---|---|---|
Parameter key | Type string | Description The key to remove. |
Name: setAt
Sets the given value inside this IData at the given index.
ZenScript CopyByteData.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
Link to operators
Name: CAT
Concatenates the given IData to this IData.
ZenScript CopymyByteData ~ other as IData
(4 as IData) ~ 2
Name: INDEXGET
Gets the data at the given index.
ZenScript Copy[myByteData]
[[1, 2, 3] as IData]
Name: INDEXSET
Puts the given value inside this IData at the given index.
ZenScript Copy[myByteData] = index as string
[new MapData()] = "key"
Name: NOT
Applies a NOT (!) operation to this IData.
ZenScript Copy!myByteData
!true
Name: SHL
Applies a SHL (<<) operation to this data by the other data
ZenScript CopymyByteData << other as IData
(4 as IData) << 2
Name: SHR
Applies a SHR (>>) operation to this data by the other data
ZenScript CopymyByteData >> other as IData
(4 as IData) >> 2
Properties
Link to 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. |