Version:

Language:

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.

ZenScript
 Copy
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

ZenScript
 Copy
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

Name: add

Adds the given IData to this IData.

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

ZenScript
 Copy
// 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

Name: asByteArray

Casts this IData to a byte array.

Returns: this data as a byte array
Return Type: byte[]

ZenScript
 Copy
// BoolData.asByteArray() as byte[]

(true as IData).asByteArray();

asIntArray

Name: asIntArray

Casts this IData to an int array.

Returns: this data as an int array
Return Type: int[]

ZenScript
 Copy
// BoolData.asIntArray() as int[]

(true as IData).asIntArray();

asList

Name: asList

Casts this IData to a list.

Returns: this data as a list
Return Type: stdlib.List<IData>

ZenScript
 Copy
// BoolData.asList() as stdlib.List<IData>

(true as IData).asList();

asLongArray

Name: asLongArray

Casts this IData to a long array.

Returns: this data as a long array
Return Type: long[]

ZenScript
 Copy
// BoolData.asLongArray() as long[]

(true as IData).asLongArray();

asMap

Name: asMap

Casts this IData to a map.

Returns: this data as a map
Return Type: IData[string]

ZenScript
 Copy
// BoolData.asMap() as IData[string]

(true as IData).asMap();

asString

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
// BoolData.asString() as string

(true as IData).asString();

getAsString

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
// BoolData.getAsString() as string

(true as IData).getAsString();

getByteData

Name: getByteData

Return Type: ByteData

ZenScript
 Copy
// BoolData.getByteData() as ByteData

(true as IData).getByteData();

getId

Name: getId

Gets the internal ID of this data.

Returns: the intenral ID of this data.
Return Type: byte

ZenScript
 Copy
// BoolData.getId() as byte

(true as IData).getId();

getKeys

Name: getKeys

Gets the keys of this IData

Returns: The keys of this IData.
Return Type: Set<string>

ZenScript
 Copy
// BoolData.getKeys() as Set<string>

(true as IData).getKeys();

isEmpty

Name: isEmpty

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

ZenScript
 Copy
// BoolData.isEmpty() as boolean

(true as IData).isEmpty();

length

Name: length

Gets the length of this IData.

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

ZenScript
 Copy
// BoolData.length() as int

(true as IData).length();

map

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
// 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

Name: merge

Merges the given data with this data.

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

ZenScript
 Copy
BoolData.merge(other as IData) as IData

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

put

Name: put

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

ZenScript
 Copy
// 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

Name: remove

Removes the stored data at the given index.

ZenScript
 Copy
// 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

Name: remove

Removes the stored data at the given key.

ZenScript
 Copy
// BoolData.remove(key as string)

{key: "value"} as IData.remove("key");

Parameter	Type	Description
Parameter key	Type string	Description The key to remove.

setAt

Name: setAt

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

ZenScript
 Copy
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

Name: ADD

Adds the given IData to this IData.

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

CAT

Name: CAT

Concatenates the given IData to this IData.

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

DIV

Name: DIV

Divides the given IData from this IData.

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

INDEXGET

Name: INDEXGET

Gets the data at the given index.

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

INDEXSET

Name: INDEXSET

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

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

MOD

Name: MOD

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

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

MUL

Name: MUL

Multiplies the given IData to this IData.

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

NEG

Name: NEG

Negates this IData.

ZenScript
 Copy
-myBoolData
-(true as IData)

SHL

Name: SHL

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

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

SHR

Name: SHR

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

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

SUB

Name: SUB

Subtracts the given IData from this IData.

ZenScript
 Copy
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.