Home Migration Guide Getting Started With Scripts Commands Examples
BracketHandlers

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.

script.zs
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

No Description Provided

script.zs
new BoolData(internal as boolean) as BoolData
ParameterTypeDescription
Parameter
internal
Type
boolean
Description
No Description Provided

Casters

Result typeIs Implicit
Result type
boolean
Is Implicit
false
Result type
ByteData
Is Implicit
false
Result type
ICollectionData
Is Implicit
false

Methods

Return Type: boolean

script.zs
// BoolData.asBoolean() as boolean
true.asBoolean();

Return Type: ICollectionData

script.zs
// BoolData.asCollection() as ICollectionData
true.asCollection();

Return Type: MCTextComponent

script.zs
BoolData.asFormattedText(indentation as string, indentDepth as int) as MCTextComponent
ParameterTypeDescription
Parameter
indentation
Type
string
Description
No Description Provided
Parameter
indentDepth
Type
int
Description
No Description Provided

Gets a List representation of this IData, returns null on anything but ListData.

Returns: null if this IData is not a list.
Return Type: stdlib.List<IData>

script.zs
// BoolData.asList() as stdlib.List<IData>
true.asList();

Gets a Map<String, IData> representation of this IData, returns null on anything but MapData.

Returns: null if this IData is not a map.
Return Type: IData[string]

script.zs
// BoolData.asMap() as IData[string]
true.asMap();

Checks if this IData contains another IData, mainly used in subclasses of ICollectionData, is the same as an equals check on other IData types

Returns: true if the given IData is contained in this IData
Return Type: boolean

script.zs
// BoolData.contains(data as IData) as boolean
true.contains("Display");
ParameterTypeDescription
Parameter
data
Type
IData
Description
data to check if it is contained

Converts this BoolData to a ByteData object. This will be used when this Data is converted to NBT

Return Type: ByteData

script.zs
// BoolData.getByteData() as ByteData
true.getByteData();

Gets the ID of the internal NBT tag.

Used to determine what NBT type is stored (in a list for example)

Returns: ID of the NBT tag that this data represents.
Return Type: byte

script.zs
// BoolData.getId() as byte
true.getId();

Gets the String representation of the internal INBT tag

Returns: String that represents the internal INBT of this IData.
Return Type: string

script.zs
// BoolData.getString() as string
true.getString();