Home Commands Examples Getting Started With Scripts Global Keywords
Block BlockIngredient BlockState
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
BlockIngredient CommandStringDisplayable
Next

BlockState

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.block.BlockState;

Description

Extends

BlockState extends BlockStateBase.

Implements

Undocumented Interfaces

IForgeBlockState

Operators

|
|(other as CTBlockIngredient) as CTBlockIngredient
script.zs
// (BlockState | (other as CTBlockIngredient)) as CTBlockIngredient
myBlockState | myCTBlockIngredient

Parameters:

other Type: BlockIngredient

Return Type: BlockIngredient

Members

asBlockIngredient
implicit as CTBlockIngredient
script.zs
// BlockState as CTBlockIngredient
myBlockState as CTBlockIngredient

Return Type: BlockIngredient

asString
asString() as string
script.zs
// BlockState.asString() as string;
myBlockState.asString();

Return Type: string

block
Getter
Gets the base Block of this BlockState.
The Block will not contain any of the properties of this BlockState.
script.zs
// BlockState.block as Block
myBlockState.block

Return Type: Block

implicit as Block
Gets the base Block of this BlockState.
The Block will not contain any of the properties of this BlockState.
script.zs
// BlockState as Block
myBlockState as Block

Return Type: Block

canOcclude
Getter
Checks whether this BlockState is solid.
script.zs
// BlockState.canOcclude as bool
myBlockState.canOcclude

Return Type: bool

canOcclude() as bool
Checks whether this BlockState is solid.

Returns: True if this BlockState is solid. False otherwise.

script.zs
// BlockState.canOcclude() as bool;
myBlockState.canOcclude();

Return Type: bool

commandString
Getter
Gets the blockstate bracket handler syntax for this BlockState.
E.G. <blockstate:minecraft:grass:snowy=true>
script.zs
// BlockState.commandString as string
myBlockState.commandString

Return Type: string

commandString() as string
Gets the blockstate bracket handler syntax for this BlockState.
E.G. <blockstate:minecraft:grass:snowy=true>

Returns: The blockstate bracket handler syntax for this BlockState.

script.zs
// BlockState.commandString() as string;
myBlockState.commandString();

Return Type: string

as string
Gets the blockstate bracket handler syntax for this BlockState.
E.G. <blockstate:minecraft:grass:snowy=true>
script.zs
// BlockState as string
myBlockState as string

Return Type: string

destroySpeed
Getter
Gets the hardness of this BlockState.
script.zs
// BlockState.destroySpeed as float
myBlockState.destroySpeed

Return Type: float

Setter
Sets the destroy speed of this BlockState.
script.zs
// BlockState.destroySpeed = (destroySpeed as float);
myBlockState.destroySpeed = myFloat;

Parameters:

destroySpeed Type: float - the new destroy speed of this BlockState
destroySpeed() as float
Gets the hardness of this BlockState.

Returns: The hardness of this BlockState.

script.zs
// BlockState.destroySpeed() as float;
myBlockState.destroySpeed();

Return Type: float

destroySpeed(destroySpeed as float)
Sets the destroy speed of this BlockState.
script.zs
// BlockState.destroySpeed(destroySpeed as float);
myBlockState.destroySpeed(2.4f);

Parameters:

destroySpeed Type: float - the new destroy speed of this BlockState
getAllowedValuesForProperty
getAllowedValuesForProperty(name as string) as List<string>
Gets a list of allowed values for a given property.

Returns: a List of allowed values.

script.zs
// BlockState.getAllowedValuesForProperty(name as string) as List<string>;
myBlockState.getAllowedValuesForProperty("snowy");

Parameters:

name Type: string - The name of the property to find the allowed values for.

Return Type: List<string>

getPropertyValue
getPropertyValue(name as string) as string
Gets the value of the given property.

Returns: The value of the property on this BlockState.

script.zs
// BlockState.getPropertyValue(name as string) as string;
myBlockState.getPropertyValue(myString);

Parameters:

name Type: string - "snowy"

Return Type: string

hasBlockEntity
Getter
Checks whether this BlockState has a net.minecraft.world.level.block.entity.BlockEntity.
script.zs
// BlockState.hasBlockEntity as bool
myBlockState.hasBlockEntity

Return Type: bool

hasBlockEntity() as bool
Checks whether this BlockState has a net.minecraft.world.level.block.entity.BlockEntity.

Returns: True if this BlockState has a net.minecraft.world.level.block.entity.BlockEntity. False otherwise.

script.zs
// BlockState.hasBlockEntity() as bool;
myBlockState.hasBlockEntity();

Return Type: bool

hasProperty
hasProperty(name as string) as bool
Checks whether this BlockState has the given property.

Returns: True if this BlockState has the property. False otherwise.

script.zs
// BlockState.hasProperty(name as string) as bool;
myBlockState.hasProperty("snowy");

Parameters:

name Type: string - the name of the property to check.

Return Type: bool

isRandomlyTicking
Getter
Checks whether this BlockState ticks randomly.
script.zs
// BlockState.isRandomlyTicking as bool
myBlockState.isRandomlyTicking

Return Type: bool

isRandomlyTicking() as bool
Checks whether this BlockState ticks randomly.

Returns: True if this BlockState ticks randomly. False otherwise.

script.zs
// BlockState.isRandomlyTicking() as bool;
myBlockState.isRandomlyTicking();

Return Type: bool

isSignalSource
Getter
Checks whether this BlockState can provide Redstone Power
script.zs
// BlockState.isSignalSource as bool
myBlockState.isSignalSource

Return Type: bool

isSignalSource() as bool
Checks whether this BlockState can provide Redstone Power

Returns: True if this BlockState can provide Redstone Power. False otherwise.

script.zs
// BlockState.isSignalSource() as bool;
myBlockState.isSignalSource();

Return Type: bool

lightEmission
Getter
Gets the light level of this BlockState
script.zs
// BlockState.lightEmission as int
myBlockState.lightEmission

Return Type: int

lightEmission() as int
Gets the light level of this BlockState

Returns: The light level of this BlockState.

script.zs
// BlockState.lightEmission() as int;
myBlockState.lightEmission();

Return Type: int

properties
Getter
Gets the properties of this BlockState.
script.zs
// BlockState.properties as string[string]
myBlockState.properties

Return Type: string[string]

properties() as string[string]
Gets the properties of this BlockState.

Returns: a Map of the properties on this BlockState.

script.zs
// BlockState.properties() as string[string];
myBlockState.properties();

Return Type: string[string]

propertyNames
Getter
Gets the names of the properties of this BlockState.
script.zs
// BlockState.propertyNames as List<string>
myBlockState.propertyNames

Return Type: List<string>

propertyNames() as List<string>
Gets the names of the properties of this BlockState.

Returns: the List of the names of the BlockStates's properties.

script.zs
// BlockState.propertyNames() as List<string>;
myBlockState.propertyNames();

Return Type: List<string>

rotate
rotate(rotation as Rotation) as BlockState
script.zs
// BlockState.rotate(rotation as Rotation) as BlockState;
myBlockState.rotate(myRotation);

Parameters:

rotation Type: Rotation

Return Type: BlockState

soundType
Getter
script.zs
// BlockState.soundType as SoundType
myBlockState.soundType

Return Type: SoundType

soundType() as SoundType
script.zs
// BlockState.soundType() as SoundType;
myBlockState.soundType();

Return Type: SoundType

withProperty
withProperty(name as string, value as string) as BlockState
Sets a block property based on it's name.

Returns: This BlockState with the new property value.

script.zs
// BlockState.withProperty(name as string, value as string) as BlockState;
myBlockState.withProperty("snowy", "true");

Parameters:

name Type: string - The name of the property to set.
value Type: string - The new value of the property.

Return Type: BlockState

Previous
BlockIngredient CommandStringDisplayable
Next