Importing the class

Link to 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.blocks.MCBlockState;
Result typeIs Implicit
Result type
MCBlock
Is Implicit
true
Result type
string
Is Implicit
false

Link to g-

Name: canBeReplacedByLeaves

Checks if this BlockState can be replaced by leaves in tree growth.

Return Type: boolean

ZenScript
Copy
// MCBlockState.canBeReplacedByLeaves(world as MCWorld, pos as BlockPos) as boolean

<blockstate:minecraft:grass>.canBeReplacedByLeaves(world, new BlockPos(1, 2, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState

Link to g--1

Name: canBeReplacedByLogs

Checks if this BlockState can be replaced by logs in tree growth.

Return Type: boolean

ZenScript
Copy
// MCBlockState.canBeReplacedByLogs(world as MCWorld, pos as BlockPos) as boolean

<blockstate:minecraft:grass>.canBeReplacedByLogs(world, new BlockPos(1, 2, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState

Link to g--2

Name: canConnectRedstone

Determines if Redstone can connect to this BlockState at the given position and (optional) side.

Returns: True if Redstone can connect to this BlockState. False otherwise.
Return Type: boolean

ZenScript
Copy
MCBlockState.canConnectRedstone(world as MCWorld, pos as BlockPos, side as Direction) as boolean
ParameterTypeDescriptionOptionalDefaultValue
Parameter
world
Type
MCWorld
Description
A world object.
Optional
false
DefaultValue
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Optional
false
DefaultValue
Parameter
side
Type
Direction
Description
The side to check for.
Optional
true
DefaultValue

Link to g--3

Name: canCreatureSpawn

Checks if a specific entity type can spawn on this BlockState at the position in the world.

Returns: True if the entity type can spawn. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.canCreatureSpawn(world as MCWorld, pos as BlockPos, type as PlacementType, entityType as MCEntityType) as boolean

<blockstate:minecraft:grass>.canCreatureSpawn(world, new BlockPos(1, 2, 3), PlacementType.IN_WATER, <entitytype:minecraft:pig>);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position in the world.
Parameter
type
Type
PlacementType
Description
The PlaceMentType to check for.
Parameter
entityType
Type
MCEntityType
Description
The EntityType to check for.

Link to g--4

Name: canDropFromExplosion

Checks if the BlockState will drop from the given explosion at the given position.

Returns: True if this BlockState will drop. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.canDropFromExplosion(world as MCWorld, pos as BlockPos, explosion as Explosion) as boolean

<blockstate:minecraft:grass>.canDropFromExplosion(world, new BlockPos(1, 2, 3), Explosiotn.create(world, 1, 2, 3, 5, true, ExplosionMode.BREAK));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
explosion
Type
Explosion
Description
The Explosion to check against.

Link to g--5

Name: canEntityDestroy

Determines if this BlockState can be destroyed by the Entity at the specific position.

Returns: True if the entity can destroy the BlockState. False otherwise.
Return Type: boolean

ZenScript
Copy
MCBlockState.canEntityDestroy(world as MCWorld, pos as BlockPos, entity as MCEntity) as boolean
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
entity
Type
MCEntity
Description
The Entity that is trying to destroy the BlockState.

Link to g--6

Name: canHarvestBlock

Checks whether the player can harvest the BlockState.

Returns: True if the player can harvest the block. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.canHarvestBlock(world as MCWorld, pos as BlockPos, player as MCPlayerEntity) as boolean

<blockstate:minecraft:grass>.canHarvestBlock(world, new BlockPos(1, 2, 3), player);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position to check at.
Parameter
player
Type
MCPlayerEntity
Description
The player that is trying to harvest the block.

Link to g--7

Name: canProvidePower

Checks whether this BlockState can provide Redstone Power

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

ZenScript
Copy
// MCBlockState.canProvidePower() as boolean

<blockstate:minecraft:grass>.canProvidePower();

Link to g--8

Name: canStickTo

Checks if this BlockState can stick to the other BlockState when pushed by a piston.

Returns: True if the BlockStatess stick when pushed by a piston. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.canStickTo(other as MCBlockState) as boolean

<blockstate:minecraft:grass>.canStickTo(<blockstate:minecraft:grass>);
ParameterTypeDescription
Parameter
other
Type
MCBlockState
Description
The BlockState check if it will stick against.

Link to g--9

Name: getAllowedValuesForProperty

Gets a list of allowed values for a given property.

Returns: a List of allowed values.
Return Type: stdlib.List<string>

ZenScript
Copy
// MCBlockState.getAllowedValuesForProperty(name as string) as stdlib.List<string>

<blockstate:minecraft:grass>.getAllowedValuesForProperty("snowy");
ParameterTypeDescription
Parameter
name
Type
string
Description
The name of the property to find the allowed values for.

Link to g--10

Name: getBedDirection

Gets the direction of the bed. This can be called on any BlockState that has the HORIZONTAL_FACING property, not just beds.

The game WILL crash if you call this on a blockstate that doesn't have the property, so make sure you check it before calling it!

Return Type: void

ZenScript
Copy
// MCBlockState.getBedDirection(world as MCWorld, pos as BlockPos) as void

<blockstate:minecraft:grass>.getBedDirection(world, new BlockPos(1, 2, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState

Link to g--11

Name: getCommandString

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.
Return Type: string

ZenScript
Copy
// MCBlockState.getCommandString() as string

<blockstate:minecraft:grass>.getCommandString();

Link to g--12

Name: getExpDrop

Returns how much Experience this BlockState will drop when broken.

Returns: The amount of Experience that will drop when this BlockState is broken.
Return Type: int

ZenScript
Copy
// MCBlockState.getExpDrop(world as MCWorld, pos as BlockPos, fortune as int, silktouch as int) as int

<blockstate:minecraft:grass>.getExpDrop(world, new BlockPos(1, 2, 3), 1, 0);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
fortune
Type
int
Description
The fortune level of the tool being used to break the block.
Parameter
silktouch
Type
int
Description
The silktouch level of the tool being used to break the block. This will most likely either be 0 or 1.

Link to g--13

Name: getExplosionResistance

Gets the explosion resistance of the BlockState in the world for the given Explosion

Returns: The amount of the explosion that is absorbed.
Return Type: float

ZenScript
Copy
// MCBlockState.getExplosionResistance(world as MCWorld, pos as BlockPos, explosion as Explosion) as float

<blockstate:minecraft:grass>.getExplosionResistance(world, new BlockPos(1, 2, 3), Explosiotn.create(world, 1, 2, 3, 5, true, ExplosionMode.BREAK));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState
Parameter
explosion
Type
Explosion
Description
The explosion object to check against.

Link to g--14

Name: getFireSpreadSpeed

Determines how fast fire spreads from this block. The higher the number the faster that fire will spread around the BlockState.

Returns: The spread speed of the BlockState.
Return Type: int

ZenScript
Copy
MCBlockState.getFireSpreadSpeed(world as MCWorld, pos as BlockPos, face as Direction) as int
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
face
Type
Direction
Description
The face that the fire is coming from.

Link to g--15

Name: getFlammability

Gets the chance that fire will spread and consume this BlockState.

Values range from 0 - 300.

A value of 300 is a 100% chance, and 0 is a 0% chance.

Returns: A number between 0 and 300 dictating how flammable this BlockState is.
Return Type: int

ZenScript
Copy
// MCBlockState.getFlammability(world as MCWorld, pos as BlockPos, face as Direction) as int

<blockstate:minecraft:grass>.getFlammability(world, new BlockPos(1, 2, 3), Direction.south);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
face
Type
Direction
Description
The face that the fire is coming from.

Link to g--16

Name: getHardness

Gets the hardness of this BlockState.

Returns: The hardness of this BlockState.
Return Type: float

ZenScript
Copy
// MCBlockState.getHardness() as float

<blockstate:minecraft:grass>.getHardness();

Link to g--17

Name: getHarvestLevel

Gets the harvest level of this BlockState.

Returns: The harvest level of this BlockState.
Return Type: int

ZenScript
Copy
// MCBlockState.getHarvestLevel() as int

<blockstate:minecraft:grass>.getHarvestLevel();

Link to g--18

Name: getHarvestTool

Gets the ToolType of this BlockState.

Returns: The ToolType of this BlockState.
Return Type: ToolType?

ZenScript
Copy
// MCBlockState.getHarvestTool() as ToolType?

<blockstate:minecraft:grass>.getHarvestTool();

Link to g--19

Name: getLightLevel

Gets the light level of this BlockState

Returns: The light level of this BlockState.
Return Type: int

ZenScript
Copy
// MCBlockState.getLightLevel() as int

<blockstate:minecraft:grass>.getLightLevel();

Link to g--20

Name: getLightValue

Gets the light value of the BlockState at the given position.

Returns: The light value of the BlockState at the position.
Return Type: int

ZenScript
Copy
// MCBlockState.getLightValue(world as MCWorld, pos as BlockPos) as int

<blockstate:minecraft:grass>.getLightValue(world, new BlockPos(1, 2, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world Object.
Parameter
pos
Type
BlockPos
Description
The position to check the light value of.

Link to g--21

Name: getProperties

Gets the properties of this BlockState.

Returns: a Map of the properties on this BlockState.
Return Type: string[string]

ZenScript
Copy
// MCBlockState.getProperties() as string[string]

<blockstate:minecraft:grass>.getProperties();

Link to g--22

Name: getPropertyNames

Gets the names of the properties of this BlockState.

Returns: the List of the names of the BlockStates's properties.
Return Type: stdlib.List<string>

ZenScript
Copy
// MCBlockState.getPropertyNames() as stdlib.List<string>

<blockstate:minecraft:grass>.getPropertyNames();

Link to g--23

Name: getPropertyValue

Gets the value of the given property.

Returns: The value of the property on this BlockState.
Return Type: string

ZenScript
Copy
MCBlockState.getPropertyValue(name as string) as string
ParameterTypeDescription
Parameter
name
Type
string
Description
"snowy"

Link to g--24

Name: getSlipperiness

Gets the slipperiness of the BlockState at the given location for the given entity (if one is given)

Returns: The slipperiness of the BlockState at the given BlockPos for the Entity.
Return Type: float

ZenScript
Copy
// MCBlockState.getSlipperiness(world as MCWorld, pos as BlockPos, entity as MCEntity) as float

<blockstate:minecraft:grass>.getSlipperiness(world, new Blockpos(0,0,0);, entity);
ParameterTypeDescriptionOptionalDefaultValue
Parameter
world
Type
MCWorld
Description
A world object.
Optional
false
DefaultValue
Parameter
pos
Type
BlockPos
Description
The position to check at.
Optional
false
DefaultValue
Parameter
entity
Type
MCEntity
Description
The entity to work with.
Optional
true
DefaultValue

Link to g--25

Name: hasProperty

Checks whether this BlockState has the given property.

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

ZenScript
Copy
// MCBlockState.hasProperty(name as string) as boolean

<blockstate:minecraft:grass>.hasProperty("snowy");
ParameterTypeDescription
Parameter
name
Type
string
Description
the name of the property to check.

Link to g--26

Name: hasTileEntity

Checks whether this BlockState has a MCTileEntity.

Returns: True if this BlockState has a MCTileEntity. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.hasTileEntity() as boolean

<blockstate:minecraft:grass>.hasTileEntity();

Name: isBed

Determines if the block can be used to sleep.

Returns: True if the block allows sleeping.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isBed(world as MCWorld, pos as BlockPos, sleeper as MCLivingEntity) as boolean

<blockstate:minecraft:grass>.isBed(world, new BlockPos(1, 2, 3), entity);
ParameterTypeDescriptionOptionalDefaultValue
Parameter
world
Type
MCWorld
Description
A world object.
Optional
false
DefaultValue
Parameter
pos
Type
BlockPos
Description
The position to check at.
Optional
false
DefaultValue
Parameter
sleeper
Type
MCLivingEntity
Description
The Living Entity that is trying to sleep.
Optional
true
DefaultValue

Link to g--28

Name: isBurning

Checks if the BlockState is burning at the given position.

Returns: True if the BlockState is burning a the given position.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isBurning(world as MCWorld, pos as BlockPos) as boolean

<blockstate:minecraft:grass>.isBurning(world, new BlockPos(1, 2, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.

Link to g--29

Name: isConduitFrame

Determines if this BlockState can be used as the frame of a Conduit.

Returns: True if this BlockState can be used as a Conduit frame.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isConduitFrame(world as MCWorld, pos as BlockPos, conduitPosition as BlockPos) as boolean

<blockstate:minecraft:grass>.isConduitFrame(world, new BlockPos(1, 2, 3), new BlockPos(1, 5, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
conduitPosition
Type
BlockPos
Description
The Position of the Conduit.

Link to g--30

Name: isFertile

Checks if the BlockState is "fertile" at the given position.

This will only ever return true if the BlockState is in the <tag:blocks:minecraft:farmland> tag and if it has the moisture state.

The game WILL crash if you call this on a blockstate that doesn't have the property, so make sure you check it before calling it!

Returns: True if the BlockState is Fertile. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isFertile(world as MCWorld, pos as BlockPos) as boolean

<blockstate:minecraft:grass>.isFertile(world, new BlockPos(1, 2, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState

Link to g--31

Name: isFireSource

Checks if this BlockState is a fire source at the given position with the fire coming from the given direciton.

Returns: True if this BlockState is a fire source. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isFireSource(world as MCWorld, pos as BlockPos, side as Direction) as boolean

<blockstate:minecraft:grass>.isFireSource(world, new BlockPos(1, 2, 3), Direction.east);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
side
Type
Direction
Description
The face that the fire is coming form.

Link to g--32

Name: isFlammable

Checks if this BlockState is flammable at the given position with the fire coming from the given direciton.

Returns: True if the BlockState if flammable. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isFlammable(world as MCWorld, pos as BlockPos, face as Direction) as boolean

<blockstate:minecraft:grass>.isFlammable(world, new BlockPos(1, 2, 3), Direction.east);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
face
Type
Direction
Description
The face that the fire is coming from.

Name: isLadder

Checks if a Living Entity can use this block to climb like a ladder.

Returns: True if the entity can climb the block. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isLadder(world as MCWorld, pos as BlockPos, entity as MCLivingEntity) as boolean

<blockstate:minecraft:grass>.isLadder(world, new BlockPos(1, 2, 3), entity);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position to check at.
Parameter
entity
Type
MCLivingEntity
Description
The entity that wants to climb the block.

Link to g--34

Name: isPortalFrame

Determins if this BlockState can be used as the frame of a Nether portal.

Returns: True if this BlockState can be used as a Nether portal frame. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isPortalFrame(world as MCWorld, pos as BlockPos) as boolean

<blockstate:minecraft:grass>.isPortalFrame(world, new BlockPos(1, 2, 3));
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the Blockstate.

Link to g--35

Name: isScaffolding

Checks if the entity should handle movement on this BlockState like it handles movement on scaffolding.

Returns: True if this BlockState should act like scaffolding. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isScaffolding(entity as MCLivingEntity) as boolean

<blockstate:minecraft:grass>.isScaffolding(entity);
ParameterTypeDescription
Parameter
entity
Type
MCLivingEntity
Description
The entity that is being checked against.

Name: isSlime

Checks if this BlockState is a Slime Block.

Returns: True if this BlockState is Slime. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isSlime() as boolean

<blockstate:minecraft:grass>.isSlime();

Name: isSolid

Checks whether this BlockState is solid.

Returns: True if this BlockState is solid. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isSolid() as boolean

<blockstate:minecraft:grass>.isSolid();

Name: isSticky

Checks if this BlockState is sticky.

This is used to determine if the block should pull or push adjacent blocks when pushed / pulled by a piston. For example, Slime Blocks are sticky blocks.

Returns: True if this BlockState is Sticky. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.isSticky() as boolean

<blockstate:minecraft:grass>.isSticky();

Link to g--39

Name: isToolEffective

Checks if the given ToolType is effective against this BlockState.

Returns: True if the ToolType is effective. False otherwise.
Return Type: boolean

ZenScript
Copy
MCBlockState.isToolEffective(tool as ToolType) as boolean
ParameterTypeDescription
Parameter
tool
Type
ToolType
Description
The ToolType to check for.

Link to g--40

Name: setBedOccupied

Marks the block as "occupied", this is only supported on blocks that have the "occupied" BlockState property.

The game WILL crash if you call this on a blockstate that doesn't have the property, so make sure you check it before calling it!

Return Type: void

ZenScript
Copy
// MCBlockState.setBedOccupied(world as MCWorld, pos as BlockPos, sleeper as MCLivingEntity, occupied as boolean) as void

<blockstate:minecraft:grass>.setBedOccupied(world, new BlockPos(1, 2, 3), livingEntity, true);
ParameterTypeDescription
Parameter
world
Type
MCWorld
Description
A world object.
Parameter
pos
Type
BlockPos
Description
The position of the BlockState.
Parameter
sleeper
Type
MCLivingEntity
Description
The LivingEntity that is occupying the bed.
Parameter
occupied
Type
boolean
Description
If the bed is occupied or not.

Link to g--41

Name: setHardness

Sets the hardness of this BlockState.

Return Type: void

ZenScript
Copy
// MCBlockState.setHardness(hardness as float) as void

<blockstate:minecraft:grass>.setHardness(2.4f);
ParameterTypeDescription
Parameter
hardness
Type
float
Description
the new hardness of this BlockState

Link to g--42

Name: ticksRandomly

Checks whether this BlockState ticks randomly.

Returns: True if this BlockState ticks randomly. False otherwise.
Return Type: boolean

ZenScript
Copy
// MCBlockState.ticksRandomly() as boolean

<blockstate:minecraft:grass>.ticksRandomly();

Link to g--43

Name: withProperty

Sets a block property based on it's name.

Returns: This BlockState with the new property value.
Return Type: MCBlockState

ZenScript
Copy
// MCBlockState.withProperty(name as string, value as string) as MCBlockState

<blockstate:minecraft:grass>.withProperty("snowy", "true");
ParameterTypeDescription
Parameter
name
Type
string
Description
The name of the property to set.
Parameter
value
Type
string
Description
The new value of the property.
NombreTypeHas GetterHas SetterDescription
Nombre
block
Type
MCBlock
Has Getter
true
Has Setter
false
Description
Gets the base MCBlock of this BlockState.

The MCBlock will not contain any of the properties of this BlockState.
Nombre
canProvidePower
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks whether this BlockState can provide Redstone Power
Nombre
commandString
Type
string
Has Getter
true
Has Setter
false
Description
Gets the blockstate bracket handler syntax for this BlockState.

E.G.

blockstate:minecraft:grass:snowy=true
Nombre
hardness
Type
float
Has Getter
true
Has Setter
true
Description
Gets the hardness of this BlockState.
Nombre
harvestLevel
Type
int
Has Getter
true
Has Setter
false
Description
Gets the harvest level of this BlockState.
Nombre
harvestTool
Type
ToolType?
Has Getter
true
Has Setter
false
Description
Gets the ToolType of this BlockState.
Nombre
hasTileEntity
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks whether this BlockState has a MCTileEntity.
Nombre
isSlime
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks if this BlockState is a Slime Block.
Nombre
isSolid
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks whether this BlockState is solid.
Nombre
isSticky
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks if this BlockState is sticky.

This is used to determine if the block should pull or push adjacent blocks when pushed / pulled by a piston.
For example, Slime Blocks are sticky blocks.
Nombre
lightLevel
Type
int
Has Getter
true
Has Setter
false
Description
Gets the light level of this BlockState
Nombre
propertyNames
Type
stdlib.List<string>
Has Getter
true
Has Setter
false
Description
Gets the names of the properties of this BlockState.
Nombre
ticksRandomly
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks whether this BlockState ticks randomly.