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

IData

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

add

Adds the given IData to this IData.

Returns: A new IData after adding the other data.
Return Type: IData

// BoolData.add(other as IData) as IData

(true as IData).add(2);

Parameter	Type	Description
Parameter other	Type IData	Description the other data to add.

asByteArray

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();

asIntArray

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();

asList

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();

asLongArray

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();

asMap

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();

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

// BoolData.asString() as string

(true as IData).asString();

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

// BoolData.getAsString() as string

(true as IData).getAsString();

getByteData

Return Type: ByteData

// BoolData.getByteData() as ByteData

(true as IData).getByteData();

getId

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();

getKeys

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();

isEmpty

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

// BoolData.isEmpty() as boolean

(true as IData).isEmpty();

length

Gets the length of this IData.

Returns: The length of this IData.
Return Type: int

// BoolData.length() as int

(true as IData).length();

map

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

merge

Merges the given data with this data.

Returns: the result of merging the datas.
Return Type: IData

BoolData.merge(other as IData) as IData

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

put

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.

remove

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.

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.

setAt

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

ADD

Adds the given IData to this IData.

myBoolData + other as IData
(true as IData) + 2

CAT

Concatenates the given IData to this IData.

myBoolData ~ other as IData
(true as IData) ~ 2

DIV

Divides the given IData from this IData.

myBoolData / other as IData
(true as IData) / 2

INDEXGET

Gets the data at the given index.

[myBoolData]
[[1, 2, 3] as IData]

INDEXSET

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

[myBoolData] = index as string
[new MapData()] = "key"

MOD

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

myBoolData % other as IData
(true as IData) % 2

MUL

Multiplies the given IData to this IData.

myBoolData * other as IData
(true as IData) * 2

NEG

Negates this IData.

-myBoolData
-(true as IData)

SHL

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

myBoolData << other as IData
(true as IData) << 2

SHR

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

myBoolData >> other as IData
(true as IData) >> 2

SUB

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.