Package net.minecraft.block

Class SugarCaneBlock

java.lang.Object

net.minecraft.block.AbstractBlock

net.minecraft.block.Block

net.minecraft.block.SugarCaneBlock

All Implemented Interfaces:

ItemConvertible, ToggleableFeature

public class SugarCaneBlock
extends Block

Mappings:

Namespace	Name
official	cun
intermediary	net/minecraft/class_2523
named	net/minecraft/block/SugarCaneBlock

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.block.Block

Block.NeighborGroup

Nested classes/interfaces inherited from class net.minecraft.block.AbstractBlock

AbstractBlock.AbstractBlockState, AbstractBlock.ContextPredicate, AbstractBlock.OffsetType, AbstractBlock.Settings, AbstractBlock.TypedContextPredicate<A>

Field Summary

Fields

Modifier and Type	Field	Description
static final IntProperty	AGE
protected static final float	field_31258
protected static final VoxelShape	SHAPE

Fields inherited from class net.minecraft.block.Block

field_31022, field_31023, field_31024, field_31025, field_31035, FORCE_STATE, MOVED, NO_REDRAW, NOTIFY_ALL, NOTIFY_LISTENERS, NOTIFY_NEIGHBORS, REDRAW_ON_MAIN_THREAD, SKIP_DROPS, SKIP_LIGHTING_UPDATES, STATE_IDS, stateManager

Fields inherited from class net.minecraft.block.AbstractBlock

collidable, DIRECTIONS, dynamicBounds, jumpVelocityMultiplier, lootTableId, material, randomTicks, requiredFeatures, resistance, settings, slipperiness, soundGroup, velocityMultiplier

Fields inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

FEATURE_ENABLED_REGISTRY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SugarCaneBlock(AbstractBlock.Settings settings)

Method Summary

Modifier and Type	Method	Description
protected void	appendProperties(StateManager.Builder<Block,BlockState> builder)	Appends block state properties to this block.
boolean	canPlaceAt(BlockState state, WorldView world, BlockPos pos)	Returns whether the block can be placed at pos.
VoxelShape	getOutlineShape(BlockState state, BlockView world, BlockPos pos, ShapeContext context)
BlockState	getStateForNeighborUpdate(BlockState state, Direction direction, BlockState neighborState, WorldAccess world, BlockPos pos, BlockPos neighborPos)	Returns the state of the block after a neighboring block's state change.
void	randomTick(BlockState state, ServerWorld world, BlockPos pos, Random random)	Called server-side when a block gets ticked randomly.
void	scheduledTick(BlockState state, ServerWorld world, BlockPos pos, Random random)	Called server-side when a block receives a scheduled tick.

Methods inherited from class net.minecraft.block.Block

afterBreak, appendTooltip, asBlock, asItem, canMobSpawnInside, cannotConnect, createCuboidShape, dropExperience, dropExperienceWhenMined, dropStack, dropStack, dropStacks, dropStacks, dropStacks, dropStacks, getBlastResistance, getBlockFromItem, getDefaultState, getDroppedStacks, getDroppedStacks, getJumpVelocityMultiplier, getName, getPickStack, getPlacementState, getRawIdFromState, getRegistryEntry, getShapesForStates, getSlipperiness, getSoundGroup, getStateFromRawId, getStateManager, getStateWithProperties, getTranslationKey, getVelocityMultiplier, hasDynamicBounds, hasRandomTicks, hasTopRim, isFaceFullSquare, isShapeFullCube, isTranslucent, onBreak, onBroken, onDestroyedByExplosion, onEntityLand, onLandedUpon, onPlaced, onSteppedOn, postProcessState, precipitationTick, pushEntitiesUpBeforeBlockChange, randomDisplayTick, replace, replace, setDefaultState, shouldDrawSide, shouldDropItemsOnExplosion, sideCoversSmallSquare, spawnBreakParticles, toString

Methods inherited from class net.minecraft.block.AbstractBlock

calcBlockBreakingDelta, canBucketPlace, canPathfindThrough, canReplace, createScreenHandlerFactory, emitsRedstonePower, getAmbientOcclusionLightLevel, getCameraCollisionShape, getCollisionShape, getComparatorOutput, getCullingShape, getDefaultMapColor, getDroppedStacks, getFluidState, getHardness, getLootTableId, getMaxHorizontalModelOffset, getOpacity, getPistonBehavior, getRaycastShape, getRenderingSeed, getRenderType, getRequiredFeatures, getSidesShape, getStrongRedstonePower, getVerticalModelOffsetMultiplier, getWeakRedstonePower, hasComparatorOutput, hasSidedTransparency, isCullingShapeFullCube, isShapeFullCube, isSideInvisible, mirror, neighborUpdate, onBlockAdded, onBlockBreakStart, onEntityCollision, onProjectileHit, onStacksDropped, onStateReplaced, onSyncedBlockEvent, onUse, prepare, rotate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

isEnabled

Field Details

AGE

public static final IntProperty AGE

Mappings:

Namespace	Name	Mixin selector
official	a	Lcun;a:Lczt;
intermediary	field_11610	Lnet/minecraft/class_2523;field_11610:Lnet/minecraft/class_2758;
named	AGE	Lnet/minecraft/block/SugarCaneBlock;AGE:Lnet/minecraft/state/property/IntProperty;

field_31258

protected static final float field_31258

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	b	Lcun;b:F
intermediary	field_31258	Lnet/minecraft/class_2523;field_31258:F
named	field_31258	Lnet/minecraft/block/SugarCaneBlock;field_31258:F

SHAPE

protected static final VoxelShape SHAPE

Mappings:

Namespace	Name	Mixin selector
official	c	Lcun;c:Leax;
intermediary	field_11611	Lnet/minecraft/class_2523;field_11611:Lnet/minecraft/class_265;
named	SHAPE	Lnet/minecraft/block/SugarCaneBlock;SHAPE:Lnet/minecraft/util/shape/VoxelShape;

Constructor Details

SugarCaneBlock

protected SugarCaneBlock(AbstractBlock.Settings settings)

Mappings:

Namespace	Name	Mixin selector
official	<init>	Lcys;<init>(Lcys$c;)V
intermediary	<init>	Lnet/minecraft/class_4970;<init>(Lnet/minecraft/class_4970$class_2251;)V
named	<init>	Lnet/minecraft/block/AbstractBlock;<init>(Lnet/minecraft/block/AbstractBlock$Settings;)V

Method Details

getOutlineShape

public VoxelShape getOutlineShape(BlockState state,
 BlockView world,
 BlockPos pos,
 ShapeContext context)

Overrides:

getOutlineShape in class AbstractBlock

Mappings:

Namespace	Name	Mixin selector
official	a	Lcys;a(Lcyt;Lcjc;Lgp;Leaj;)Leax;
intermediary	method_9530	Lnet/minecraft/class_4970;method_9530(Lnet/minecraft/class_2680;Lnet/minecraft/class_1922;Lnet/minecraft/class_2338;Lnet/minecraft/class_3726;)Lnet/minecraft/class_265;
named	getOutlineShape	Lnet/minecraft/block/AbstractBlock;getOutlineShape(Lnet/minecraft/block/BlockState;Lnet/minecraft/world/BlockView;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/ShapeContext;)Lnet/minecraft/util/shape/VoxelShape;

scheduledTick

public void scheduledTick(BlockState state,
 ServerWorld world,
 BlockPos pos,
 Random random)

Called server-side when a block receives a scheduled tick. This can be used like a timer. Scheduled ticks are added using WorldAccess.scheduleBlockTick(BlockPos, Block, int). Additionally, AbstractBlock.randomTick(net.minecraft.block.BlockState, net.minecraft.server.world.ServerWorld, net.minecraft.util.math.BlockPos, net.minecraft.util.math.random.Random) by default calls this method; override AbstractBlock.randomTick(net.minecraft.block.BlockState, net.minecraft.server.world.ServerWorld, net.minecraft.util.math.BlockPos, net.minecraft.util.math.random.Random) to disable this behavior.

Scheduled ticks are often used inside AbstractBlock.getStateForNeighborUpdate(net.minecraft.block.BlockState, net.minecraft.util.math.Direction, net.minecraft.block.BlockState, net.minecraft.world.WorldAccess, net.minecraft.util.math.BlockPos, net.minecraft.util.math.BlockPos).

Here are some examples:

• SugarCaneBlock checks the placement requirement.
• DispenserBlock dispenses its content.
• CommandBlock executes its command.
• FrogspawnBlock spawns a tadpole.
• SoulSandBlock updates a bubble column.
• FallingBlock tries to fall.

Overrides:

scheduledTick in class AbstractBlock

See Also:

• WorldAccess.scheduleBlockTick(BlockPos, Block, int)
• AbstractBlock.getStateForNeighborUpdate(net.minecraft.block.BlockState, net.minecraft.util.math.Direction, net.minecraft.block.BlockState, net.minecraft.world.WorldAccess, net.minecraft.util.math.BlockPos, net.minecraft.util.math.BlockPos)
• AbstractBlock.randomTick(net.minecraft.block.BlockState, net.minecraft.server.world.ServerWorld, net.minecraft.util.math.BlockPos, net.minecraft.util.math.random.Random)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcys;a(Lcyt;Lahm;Lgp;Laoh;)V
intermediary	method_9588	Lnet/minecraft/class_4970;method_9588(Lnet/minecraft/class_2680;Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;Lnet/minecraft/class_5819;)V
named	scheduledTick	Lnet/minecraft/block/AbstractBlock;scheduledTick(Lnet/minecraft/block/BlockState;Lnet/minecraft/server/world/ServerWorld;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/util/math/random/Random;)V

randomTick

public void randomTick(BlockState state,
 ServerWorld world,
 BlockPos pos,
 Random random)

Called server-side when a block gets ticked randomly. This can be overridden to implement various logics, most commonly plant growth. Default implementation calls AbstractBlock.scheduledTick(net.minecraft.block.BlockState, net.minecraft.server.world.ServerWorld, net.minecraft.util.math.BlockPos, net.minecraft.util.math.random.Random). To control the rate of the action, use random.

Random tick speed is controlled by the game rule randomTickSpeed and can be disabled. Only blocks within 128-block cylinder (i.e. ignoring Y coordinates) around players receive random ticks.

Blocks overriding this must use AbstractBlock.Settings.ticksRandomly() block settings.

Here are some examples:

• SugarCaneBlock uses this to grow sugar cane.
• OxidizableBlock uses this to oxidize.
• NetherPortalBlock uses this to spawn zombified piglins.
• LeavesBlock uses this to decay when far from logs.

Overrides:

randomTick in class AbstractBlock

See Also:

• CropBlock
• AbstractBlock.scheduledTick(net.minecraft.block.BlockState, net.minecraft.server.world.ServerWorld, net.minecraft.util.math.BlockPos, net.minecraft.util.math.random.Random)

Mappings:

Namespace	Name	Mixin selector
official	b	Lcys;b(Lcyt;Lahm;Lgp;Laoh;)V
intermediary	method_9514	Lnet/minecraft/class_4970;method_9514(Lnet/minecraft/class_2680;Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;Lnet/minecraft/class_5819;)V
named	randomTick	Lnet/minecraft/block/AbstractBlock;randomTick(Lnet/minecraft/block/BlockState;Lnet/minecraft/server/world/ServerWorld;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/util/math/random/Random;)V

getStateForNeighborUpdate

public BlockState getStateForNeighborUpdate(BlockState state,
 Direction direction,
 BlockState neighborState,
 WorldAccess world,
 BlockPos pos,
 BlockPos neighborPos)

Returns the state of the block after a neighboring block's state change.

Returning Blocks.AIR breaks the block. This is useful to implement supporting block requirement for blocks (if used along with AbstractBlock.canPlaceAt(net.minecraft.block.BlockState, net.minecraft.world.WorldView, net.minecraft.util.math.BlockPos)).

Side effects like activating a redstone component (but not scheduling a tick) should be performed in AbstractBlock.neighborUpdate(net.minecraft.block.BlockState, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.block.Block, net.minecraft.util.math.BlockPos, boolean) instead. If the block supports waterlogging and currently has water, this method should be overridden to tick the fluid at the block's position.

This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using World.isClient. This is not called if Block.FORCE_STATE flag is set in the setBlockState call.

This method can be used for multiple purposes. Here are some examples:

• FenceBlock uses it to update the fence's connection when a horizontally neighboring block's state is changed.
• PlantBlock uses it to break the plant if the state change causes it to lose its supporting block.
• DoorBlock uses it to copy the state of the other half of the door.
• SlabBlock uses it to schedule the fluid to tick if waterlogged.
• SoulSandBlock uses it to schedule the water block above to tick so that it becomes a bubble column.
• FallingBlock uses it to schedule the block to tick so that it can fall if needed.

Overrides:

getStateForNeighborUpdate in class AbstractBlock

Parameters:

state - the state of this block

direction - the direction from this block to the neighbor

neighborState - the state of the updated neighbor block

world - the world

pos - the position of this block

neighborPos - the position of the neighbor block

Returns:

the state of the block after a neighboring block's state change

See Also:

• AbstractBlock.neighborUpdate(net.minecraft.block.BlockState, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.block.Block, net.minecraft.util.math.BlockPos, boolean)
• AbstractBlock.prepare(net.minecraft.block.BlockState, net.minecraft.world.WorldAccess, net.minecraft.util.math.BlockPos, int, int)
• AbstractBlock.canPlaceAt(net.minecraft.block.BlockState, net.minecraft.world.WorldView, net.minecraft.util.math.BlockPos)
• Block.FORCE_STATE

Mappings:

Namespace	Name	Mixin selector
official	a	Lcys;a(Lcyt;Lgv;Lcyt;Lcjx;Lgp;Lgp;)Lcyt;
intermediary	method_9559	Lnet/minecraft/class_4970;method_9559(Lnet/minecraft/class_2680;Lnet/minecraft/class_2350;Lnet/minecraft/class_2680;Lnet/minecraft/class_1936;Lnet/minecraft/class_2338;Lnet/minecraft/class_2338;)Lnet/minecraft/class_2680;
named	getStateForNeighborUpdate	Lnet/minecraft/block/AbstractBlock;getStateForNeighborUpdate(Lnet/minecraft/block/BlockState;Lnet/minecraft/util/math/Direction;Lnet/minecraft/block/BlockState;Lnet/minecraft/world/WorldAccess;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/util/math/BlockPos;)Lnet/minecraft/block/BlockState;

canPlaceAt

public boolean canPlaceAt(BlockState state,
 WorldView world,
 BlockPos pos)

Returns whether the block can be placed at pos.

Blocks with supporting block requirements should override this method. Note that this should also be checked manually during AbstractBlock.getStateForNeighborUpdate(net.minecraft.block.BlockState, net.minecraft.util.math.Direction, net.minecraft.block.BlockState, net.minecraft.world.WorldAccess, net.minecraft.util.math.BlockPos, net.minecraft.util.math.BlockPos) in order to break the block that lost its supporting block.

This is only checked during the use of block items or by endermen, falling blocks, etc that can place blocks. This does not affect block state changes performed through World.setBlockState(BlockPos, BlockState) call.

This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using World.isClient.

Overrides:

canPlaceAt in class AbstractBlock

Returns:

whether the block can be placed at pos

See Also:

• AbstractBlock.getStateForNeighborUpdate(net.minecraft.block.BlockState, net.minecraft.util.math.Direction, net.minecraft.block.BlockState, net.minecraft.world.WorldAccess, net.minecraft.util.math.BlockPos, net.minecraft.util.math.BlockPos)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcys;a(Lcyt;Lcjz;Lgp;)Z
intermediary	method_9558	Lnet/minecraft/class_4970;method_9558(Lnet/minecraft/class_2680;Lnet/minecraft/class_4538;Lnet/minecraft/class_2338;)Z
named	canPlaceAt	Lnet/minecraft/block/AbstractBlock;canPlaceAt(Lnet/minecraft/block/BlockState;Lnet/minecraft/world/WorldView;Lnet/minecraft/util/math/BlockPos;)Z

appendProperties

protected void appendProperties(StateManager.Builder<Block,BlockState> builder)

Appends block state properties to this block. To use this, override and call StateManager.Builder.add(net.minecraft.state.property.Property<?>[]) inside the method. See Properties for the list of pre-defined properties.

Overrides:

appendProperties in class Block

Mappings:

Namespace	Name	Mixin selector
official	a	Lcmt;a(Lcyu$a;)V
intermediary	method_9515	Lnet/minecraft/class_2248;method_9515(Lnet/minecraft/class_2689$class_2690;)V
named	appendProperties	Lnet/minecraft/block/Block;appendProperties(Lnet/minecraft/state/StateManager$Builder;)V