BoolData
Careful with BoolData: While it works for specifying boolean attributes in JSON syntax, using it in Tags will instead use a ByteData object. Reason for this is that Minecraft does not have Boolean NBT values.
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.
import crafttweaker.api.data.BoolData;
Implemented Interfaces
BoolData implements the following interfaces. That means all methods defined in these interfaces are also available in BoolData
Constructors
new BoolData(internalValue as boolean) as BoolData
Parameter | Type |
---|---|
Parameter internalValue | Type boolean |
Casters
Result Type | Is Implicit |
---|---|
Result Type boolean | Is Implicit true |
Result Type byte[] | Is Implicit false |
Result Type ByteData | 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
Casts this IData to a byte array.
Returns: this data as a byte array
Return Type: byte[]
// BoolData.asByteArray() as byte[]
(true as IData).asByteArray();
Casts this IData to an int array.
Returns: this data as an int array
Return Type: int[]
// BoolData.asIntArray() as int[]
(true as IData).asIntArray();
Casts this IData to a list.
Returns: this data as a list
Return Type: stdlib.List<IData>
// BoolData.asList() as stdlib.List<IData>
(true as IData).asList();
Casts this IData to a long array.
Returns: this data as a long array
Return Type: long[]
// BoolData.asLongArray() as long[]
(true as IData).asLongArray();
Casts this IData to a map.
Returns: this data as a map
Return Type: IData[string]
// BoolData.asMap() as IData[string]
(true as IData).asMap();
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
// BoolData.asString() as string
(true as IData).asString();
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
// BoolData.getAsString() as string
(true as IData).getAsString();
Return Type: ByteData
// BoolData.getByteData() as ByteData
(true as IData).getByteData();
Gets the internal ID of this data.
Returns: the intenral ID of this data.
Return Type: byte
// BoolData.getId() as byte
(true as IData).getId();
Gets the keys of this IData
Returns: The keys of this IData.
Return Type: Set<string>
// BoolData.getKeys() as Set<string>
(true as IData).getKeys();
Checks if this data is empty.
Returns: True if empty.
Return Type: boolean
// BoolData.isEmpty() as boolean
(true as IData).isEmpty();
Gets the length of this IData.
Returns: The length of this IData.
Return Type: int
// BoolData.length() as int
(true as IData).length();
Maps this IData to another IData based on the given operation.
Returns: A new IData from the operation
Return Type: IData
// BoolData.map(operation as Function<IData,IData>) as IData
(true as IData).map((data) => 3);
Parameter | Type | Description |
---|---|---|
Parameter operation | Type Function<IData,IData> | Description The operation to apply to this IData |
Puts the given value inside this IData at the given index.
// BoolData.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. |
Removes the stored data at the given index.
// BoolData.remove(index as int)
[1, 2, 3] as IData.remove(0);
Parameter | Type | Description |
---|---|---|
Parameter index | Type int | Description The index to remove. |
Removes the stored data at the given key.
// BoolData.remove(key as string)
{key: "value"} as IData.remove("key");
Parameter | Type | Description |
---|---|---|
Parameter key | Type string | Description The key to remove. |
Sets the given value inside this IData at the given index.
BoolData.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
Adds the given IData to this IData.
myBoolData + other as IData(true as IData) + 2
Concatenates the given IData to this IData.
myBoolData ~ other as IData(true as IData) ~ 2
Divides the given IData from this IData.
myBoolData / other as IData(true as IData) / 2
Gets the data at the given index.
[myBoolData][[1, 2, 3] as IData]
Puts the given value inside this IData at the given index.
[myBoolData] = index as string[new MapData()] = "key"
Applies a modulo operation to this IData against the other IData.
myBoolData % other as IData(true as IData) % 2
Multiplies the given IData to this IData.
myBoolData * other as IData(true as IData) * 2
Negates this IData.
-myBoolData-(true as IData)
Applies a SHL (<<) operation to this data by the other data
myBoolData << other as IData(true as IData) << 2
Applies a SHR (>>) operation to this data by the other data
myBoolData >> other as IData(true as IData) >> 2
Subtracts the given IData from this IData.
myBoolData - other as IData(true 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 |
Name length | Type int | Has Getter true | Has Setter false | Description Gets the length of this IData. |