Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
BoolData ByteArrayData ByteData DoubleData EmptyData FloatData IData IntArrayData IntData ListData LongArrayData LongData MapData ShortData StringData
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
TypedDataComponent ByteArrayData
Next

BoolData

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.api.data.BoolData;

Description

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.

Implements

BoolData implements the following interfaces:

IData

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Constructors

new
new(internalValue as bool)
script.zs
// new BoolData(internalValue as bool);
new BoolData(myBool);

Parameters:

internalValue Type: bool

Operators

+
+(other as IData) as IData
Adds the given IData to this IData.
script.zs
// (BoolData + (other as IData)) as IData
(true as IData) + myIData

Parameters:

other Type: IData - the other data to add.

Return Type: IData

~
~(other as IData) as IData
Concatenates the given IData to this IData.
script.zs
// (BoolData ~ (other as IData)) as IData
(true as IData) ~ myIData

Parameters:

other Type: IData - the other data to concatenate.

Return Type: IData

/
/(other as IData) as IData
Divides the given IData from this IData.
script.zs
// (BoolData / (other as IData)) as IData
(true as IData) / myIData

Parameters:

other Type: IData - the other data to divide by.

Return Type: IData

[]
[](index as int) as IData
Gets the data at the given index.
script.zs
// BoolData[index as int] as IData
(true as IData)[myInt]

Parameters:

index Type: int - The index to get

Return Type: IData

[](key as string) as IData
Gets the data at the given key.
script.zs
// BoolData[key as string] as IData
(true as IData)[myString]

Parameters:

key Type: string - The key to get

Return Type: IData

%
%(other as IData) as IData
Applies a modulo operation to this IData against the other IData.
script.zs
// (BoolData % (other as IData)) as IData
(true as IData) % myIData

Parameters:

other Type: IData - the other data to modulo by.

Return Type: IData

*
*(other as IData) as IData
Multiplies the given IData to this IData.
script.zs
// (BoolData * (other as IData)) as IData
(true as IData) * myIData

Parameters:

other Type: IData - the other data to multiply by.

Return Type: IData

-
- as IData
Negates this IData.
script.zs
// (-BoolData) as IData
-(true as IData)

Return Type: IData

[]=
[]=(index as string, value as IData)
Puts the given value inside this IData at the given index.
script.zs
// BoolData[index as string] = (value as IData)
(true as IData)[myString] = myIData

Parameters:

index Type: string - The key to store the data at
value Type: IData - The data to store.
<<
<<(other as IData) as IData
Applies a SHL (<<) operation to this data by the other data
script.zs
// (BoolData << (other as IData)) as IData
(true as IData) << myIData

Parameters:

other Type: IData - The data to SHL by.

Return Type: IData

>>
>>(other as IData) as IData
Applies a SHR (>>) operation to this data by the other data
script.zs
// (BoolData >> (other as IData)) as IData
(true as IData) >> myIData

Parameters:

other Type: IData - The data to SHR by.

Return Type: IData

-
-(other as IData) as IData
Subtracts the given IData from this IData.
script.zs
// (BoolData - (other as IData)) as IData
-(true as IData)

Parameters:

other Type: IData - the other data to remove.

Return Type: IData

Members

add
add(other as IData) as IData
Adds the given IData to this IData.

Returns: A new IData after adding the other data.

script.zs
// BoolData.add(other as IData) as IData;
(true as IData).add(2);

Parameters:

other Type: IData - the other data to add.

Return Type: IData

asBool
implicit as bool
script.zs
// BoolData as bool
(true as IData) as bool

Return Type: bool

asByteArray
asByteArray() as byte[]
Casts this IData to a byte array.

Returns: this data as a byte array

script.zs
// BoolData.asByteArray() as byte[];
(true as IData).asByteArray();

Return Type: byte[]

as byte[]
Casts this IData to a byte array.
script.zs
// BoolData as byte[]
(true as IData) as byte[]

Return Type: byte[]

asIntArray
asIntArray() as int[]
Casts this IData to an int array.

Returns: this data as an int array

script.zs
// BoolData.asIntArray() as int[];
(true as IData).asIntArray();

Return Type: int[]

as int[]
Casts this IData to an int array.
script.zs
// BoolData as int[]
(true as IData) as int[]

Return Type: int[]

asList
asList() as List<IData>
Casts this IData to a list.

Returns: this data as a list

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

Return Type: List<IData>

as List<IData>
Casts this IData to a list.
script.zs
// BoolData as List<IData>
(true as IData) as List<IData>

Return Type: List<IData>

asLongArray
asLongArray() as long[]
Casts this IData to a long array.

Returns: this data as a long array

script.zs
// BoolData.asLongArray() as long[];
(true as IData).asLongArray();

Return Type: long[]

as long[]
Casts this IData to a long array.
script.zs
// BoolData as long[]
(true as IData) as long[]

Return Type: long[]

asMap
asMap() as IData[string]
Casts this IData to a map.

Returns: this data as a map

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

Return Type: IData[string]

as IData[string]
Casts this IData to a map.
script.zs
// BoolData as IData[string]
(true as IData) as IData[string]

Return Type: IData[string]

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

script.zs
// BoolData.asString() as string;
(true as IData).asString();

Return Type: string

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

script.zs
// BoolData.getAsString() as string;
(true as IData).getAsString();

Return Type: string

as string
Gets the literal string version of this IData.

E.G println(("hello" as IData).getAsString()) prints hello

script.zs
// BoolData as string
(true as IData) as string

Return Type: string

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

Return Type: ByteData

as ByteData
script.zs
// BoolData as ByteData
(true as IData) as ByteData

Return Type: ByteData

getId
getId() as byte
Gets the internal ID of this data.

Returns: the intenral ID of this data.

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

Return Type: byte

isEmpty
Getter
Checks if this data is empty.
script.zs
// BoolData.isEmpty as bool
(true as IData).isEmpty

Return Type: bool

isEmpty() as bool
Checks if this data is empty.

Returns: True if empty.

script.zs
// BoolData.isEmpty() as bool;
(true as IData).isEmpty();

Return Type: bool

keys
Getter
Gets the keys of this IData
script.zs
// BoolData.keys as Set<string>
(true as IData).keys

Return Type: Set<string>

keys() as Set<string>
Gets the keys of this IData

Returns: The keys of this IData.

script.zs
// BoolData.keys() as Set<string>;
(true as IData).keys();

Return Type: Set<string>

length
Getter
Gets the length of this IData.
script.zs
// BoolData.length as int
(true as IData).length

Return Type: int

length() as int
Gets the length of this IData.

Returns: The length of this IData.

script.zs
// BoolData.length() as int;
(true as IData).length();

Return Type: int

listOf
static listOf(members as IData[]) as IData
Creates a collection of the given IData members.


This attempts to give the most accurate type for the given members, for example, if all the members are bytes, then it returns a ByteArrayData.
However if the types are mixed or do not have a *ArrayData version, then a ListData is returned.

Returns: A list of the given members.

script.zs
// BoolData.listOf(members as IData[]) as IData;
BoolData.listOf(1, 2, 3);

Parameters:

members Type: IData[] - The members to put in the list.

Return Type: IData

map
map(operation as function(r as IData) as IData) as IData
Maps this IData to another IData based on the given operation.

Returns: A new IData from the operation

script.zs
// BoolData.map(operation as function(r as IData) as IData) as IData;
(true as IData).map((data) => 3);

Parameters:

operation Type: function(r as IData) as IData - The operation to apply to this IData

Return Type: IData

merge
merge(other as IData) as IData
Merges the given data with this data.

Returns: the result of merging the datas.

script.zs
// BoolData.merge(other as IData) as IData;
(true as IData).merge(myIData);

Parameters:

other Type: IData - the data to merge

Return Type: IData

put
put(index as string, value as IData)
Puts the given value inside this IData at the given index.
script.zs
// BoolData.put(index as string, value as IData);
(true as IData).put("key", "value");

Parameters:

index Type: string - The key to store the data at
value Type: IData - The data to store.
remove
remove(index as int)
Removes the stored data at the given index.
script.zs
// BoolData.remove(index as int);
(true as IData).remove(0);

Parameters:

index Type: int - The index to remove.
remove(key as string)
Removes the stored data at the given key.
script.zs
// BoolData.remove(key as string);
(true as IData).remove("key");

Parameters:

key Type: string - The key to remove.
setAt
setAt(name as string, data as IData)
Sets the given value inside this IData at the given index.
script.zs
// BoolData.setAt(name as string, data as IData);
(true as IData).setAt(myString, myIData);

Parameters:

name Type: string - The key to store the data at
data Type: IData - The data to store.
Previous
TypedDataComponent ByteArrayData
Next