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

Block

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.Block;

Description

Extends

Block extends BlockBehaviour.

Implements

Block implements the following interfaces:

ItemLike

Undocumented Interfaces

IBlockExtension,FeatureElement

Operators

|
|(other as CTBlockIngredient) as CTBlockIngredient
script.zs
// (Block | (other as BlockIngredient)) as BlockIngredient
myBlock | myCTBlockIngredient

Parameters:

other Type: BlockIngredient

Return Type: BlockIngredient

==
==(other as Block) as bool
Checks whether this Block matches another Block.
script.zs
// (Block == (other as Block)) as bool
myBlock == myBlock

Parameters:

other Type: Block - The other Block to check if this Block matches.

Return Type: bool

Members

asBlockIngredient
implicit as CTBlockIngredient
script.zs
// Block as BlockIngredient
myBlock as CTBlockIngredient

Return Type: BlockIngredient

asItem
asItem() as Item
Gets the Item representation of this Block.
***NOTE:*** Not all Blocks have Items, for instance, a Lit Redstone Lamp does not have an Item.

Returns: The Item representation of this Block.

script.zs
// Block.asItem() as ItemDefinition;
myBlock.asItem();

Return Type: ItemDefinition

as Item
Gets the Item representation of this Block.
***NOTE:*** Not all Blocks have Items, for instance, a Lit Redstone Lamp does not have an Item.
script.zs
// Block as ItemDefinition
myBlock as Item

Return Type: ItemDefinition

commandString
Getter
Gets the block bracket handler syntax for this Block.
E.G. <block:minecraft:dirt>
script.zs
// Block.commandString as string
myBlock.commandString

Return Type: string

commandString() as string
Gets the block bracket handler syntax for this Block.
E.G. <block:minecraft:dirt>

Returns: The block bracket handler syntax for this Block.

script.zs
// Block.commandString() as string;
myBlock.commandString();

Return Type: string

as string
Gets the block bracket handler syntax for this Block.
E.G. <block:minecraft:dirt>
script.zs
// Block as string
myBlock as string

Return Type: string

defaultState
Getter
Gets the default BlockState of this Block.
script.zs
// Block.defaultState as BlockState
myBlock.defaultState

Return Type: BlockState

defaultState() as BlockState
Gets the default BlockState of this Block.

Returns: The default BlockState of this Block.

script.zs
// Block.defaultState() as BlockState;
myBlock.defaultState();

Return Type: BlockState

descriptionId
Getter
Gets the translation key that is used to localize this Block.
script.zs
// Block.descriptionId as string
myBlock.descriptionId

Return Type: string

descriptionId() as string
Gets the translation key that is used to localize this Block.

Returns: The unlocalized name of this block.

script.zs
// Block.descriptionId() as string;
myBlock.descriptionId();

Return Type: string

dynamicShape
Getter
Checks if the opacity of this block is different in different areas of the Block.
script.zs
// Block.dynamicShape as bool
myBlock.dynamicShape

Return Type: bool

dynamicShape() as bool
Checks if the opacity of this block is different in different areas of the Block.

Returns: True if this Block has variable opacity. False otherwise.

script.zs
// Block.dynamicShape() as bool;
myBlock.dynamicShape();

Return Type: bool

explosionResistance
Getter
Gets the blast resistance of this Block.
script.zs
// Block.explosionResistance as float
myBlock.explosionResistance

Return Type: float

Setter
Sets the blast resistance of this Block.
script.zs
// Block.explosionResistance = (resistance as float);
myBlock.explosionResistance = myFloat;

Parameters:

resistance Type: float - The new blast resistance of this Block.
explosionResistance() as float
Gets the blast resistance of this Block.

Returns: The blast resistance of this Block.

script.zs
// Block.explosionResistance() as float;
myBlock.explosionResistance();

Return Type: float

explosionResistance(resistance as float)
Sets the blast resistance of this Block.
script.zs
// Block.explosionResistance(resistance as float);
myBlock.explosionResistance(2);

Parameters:

resistance Type: float - The new blast resistance of this Block.
friction
Getter
Gets the friction of this Block.
script.zs
// Block.friction as float
myBlock.friction

Return Type: float

Setter
Sets the friction of this Block.
script.zs
// Block.friction = (friction as float);
myBlock.friction = myFloat;

Parameters:

friction Type: float - The new friction of this Block.
friction() as float
Gets the friction of this Block.

Returns: The friction of this Block.

script.zs
// Block.friction() as float;
myBlock.friction();

Return Type: float

friction(friction as float)
Sets the friction of this Block.
script.zs
// Block.friction(friction as float);
myBlock.friction(2);

Parameters:

friction Type: float - The new friction of this Block.
hasCollision
Getter
Checks if entities can collide with this Block.
script.zs
// Block.hasCollision as bool
myBlock.hasCollision

Return Type: bool

Setter
Sets whether entities can collide with this Block.
script.zs
// Block.hasCollision = (canCollide as bool);
myBlock.hasCollision = myBool;

Parameters:

canCollide Type: bool - Can entities collide with this Block.
hasCollision() as bool
Checks if entities can collide with this Block.

Returns: True if entities will collide with this Block. False otherwise.

script.zs
// Block.hasCollision() as bool;
myBlock.hasCollision();

Return Type: bool

hasCollision(canCollide as bool)
Sets whether entities can collide with this Block.
script.zs
// Block.hasCollision(canCollide as bool);
myBlock.hasCollision(true);

Parameters:

canCollide Type: bool - Can entities collide with this Block.
isPossibleToRespawnInThis
isPossibleToRespawnInThis(state as BlockState) as bool
Checks if an entity can be spawned inside this Block.
This is used to find valid spawn locations for players.

Returns: True if an entity can be spawned in this Block. False Otherwise.

script.zs
// Block.isPossibleToRespawnInThis(state as BlockState) as bool;
myBlock.isPossibleToRespawnInThis(myBlockState);

Parameters:

state Type: BlockState

Return Type: bool

jumpFactor
Getter
Gets the jump factor of this Block.
script.zs
// Block.jumpFactor as float
myBlock.jumpFactor

Return Type: float

Setter
Sets the jump factor of this Block.
script.zs
// Block.jumpFactor = (jumpFactor as float);
myBlock.jumpFactor = myFloat;

Parameters:

jumpFactor Type: float - The new jump factor of this Block.
jumpFactor() as float
Gets the jump factor of this Block.

Returns: The jump factor of this Block.

script.zs
// Block.jumpFactor() as float;
myBlock.jumpFactor();

Return Type: float

jumpFactor(jumpFactor as float)
Sets the jump factor of this Block.
script.zs
// Block.jumpFactor(jumpFactor as float);
myBlock.jumpFactor(2);

Parameters:

jumpFactor Type: float - The new jump factor of this Block.
lootTable
Getter
Gets the loot table id for this Block.
script.zs
// Block.lootTable as string
myBlock.lootTable

Return Type: string

lootTable() as string
Gets the loot table id for this Block.

Returns: The loot table id for this Block.

script.zs
// Block.lootTable() as string;
myBlock.lootTable();

Return Type: string

matches
matches(other as Block) as bool
Checks whether this Block matches another Block.

Returns: True if this Block matches the other Block. False otherwise.

script.zs
// Block.matches(other as Block) as bool;
myBlock.matches(myBlock);

Parameters:

other Type: Block - The other Block to check if this Block matches.

Return Type: bool

name
Getter
Gets the name of this Block
script.zs
// Block.name as MutableComponent
myBlock.name

Return Type: MutableComponent

name() as MutableComponent
Gets the name of this Block

Returns: The name of this block.

script.zs
// Block.name() as MutableComponent;
myBlock.name();

Return Type: MutableComponent

possibleStates
Getter
Gets a list of valid BlockStates for this Block.
script.zs
// Block.possibleStates as List<BlockState>
myBlock.possibleStates

Return Type: List<BlockState>

possibleStates() as List<BlockState>
Gets a list of valid BlockStates for this Block.

Returns: A list of valid BlockStates for this Block.

script.zs
// Block.possibleStates() as List<BlockState>;
myBlock.possibleStates();

Return Type: List<BlockState>

registryName
Getter
Gets the registry name of this block.
script.zs
// Block.registryName as ResourceLocation
myBlock.registryName

Return Type: ResourceLocation

registryName() as ResourceLocation
Gets the registry name of this block.

Returns: A ResourceLocation of the registry name of this block.

script.zs
// Block.registryName() as ResourceLocation;
myBlock.registryName();

Return Type: ResourceLocation

speedFactor
Getter
Gets the speed factor of this Block.
script.zs
// Block.speedFactor as float
myBlock.speedFactor

Return Type: float

Setter
Sets the speed factor of this Block.
script.zs
// Block.speedFactor = (speedFactor as float);
myBlock.speedFactor = myFloat;

Parameters:

speedFactor Type: float - The new speed factor of this Block.
speedFactor() as float
Gets the speed factor of this Block.

Returns: The speed factor of this Block.

script.zs
// Block.speedFactor() as float;
myBlock.speedFactor();

Return Type: float

speedFactor(speedFactor as float)
Sets the speed factor of this Block.
script.zs
// Block.speedFactor(speedFactor as float);
myBlock.speedFactor(2);

Parameters:

speedFactor Type: float - The new speed factor of this Block.
Previous
PistonStructureResolver BlockIngredient
Next