Skip to content

Commit

Permalink
Add Javadoc descriptions to the fields of AbstractBlock (#3796)
Browse files Browse the repository at this point in the history
* document field AbstractBlock.jumpVelocityMultiplier

* fix address of `@see` notes in jumpVelocityMultiplier

* document the rest of the fields for AbstractBlock (except for DIRECTIONS)
  • Loading branch information
AdamRaichu authored Feb 22, 2024
1 parent 75e590d commit 91f4271
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions mappings/net/minecraft/block/AbstractBlock.mapping
Original file line number Diff line number Diff line change
Expand Up @@ -220,17 +220,53 @@ CLASS net/minecraft/class_4970 net/minecraft/block/AbstractBlock
COMMENT <li>Called before {@link #getDroppedStacks getDroppedStacks} in this case.</li>
COMMENT </ol>
FIELD field_23154 dynamicBounds Z
COMMENT Whether this block's collision shape can change.
COMMENT
COMMENT @see #hasDynamicBounds
FIELD field_23155 settings Lnet/minecraft/class_4970$class_2251;
COMMENT The {@link AbstractBlock.Settings} to apply to this block.
FIELD field_23156 lootTableId Lnet/minecraft/class_2960;
COMMENT The {@link net.minecraft.util.Identifier} of the loot table that determines what this block drops.
COMMENT
COMMENT @see #getLootTableId
COMMENT @see #getDroppedStacks
FIELD field_23157 DIRECTIONS [Lnet/minecraft/class_2350;
FIELD field_23159 collidable Z
COMMENT Whether this block can be walked on or through.
COMMENT
COMMENT @see #getCollisionShape
FIELD field_23160 resistance F
COMMENT The blast resistance of the block.
COMMENT
COMMENT @see Block#getBlastResistance
FIELD field_23161 randomTicks Z
COMMENT Whether this block should tick when randomly selected when ticking the world. An example of this ticking is crop growth.
COMMENT
COMMENT @see Block#hasRandomTicks
COMMENT @see net.minecraft.server.world.ServerWorld#tickChunk
FIELD field_23162 soundGroup Lnet/minecraft/class_2498;
COMMENT The collection of sounds played when breaking, stepping on, placing, hitting (with a projectile), or falling on this block.
COMMENT
COMMENT @see #getSoundGroup
FIELD field_23163 slipperiness F
COMMENT A speed reduction applied to a {@link net.minecraft.entity.LivingEntity} that tries to move across this block.
COMMENT
COMMENT @see Block#getSlipperiness
COMMENT @see net.minecraft.entity.LivingEntity#travel
FIELD field_23164 velocityMultiplier F
COMMENT The multiplier applied to the velocity of an {@link net.minecraft.entity.Entity} when it walks on this block.
COMMENT
COMMENT @see Block#getVelocityMultiplier
COMMENT @see net.minecraft.entity.Entity#getVelocityMultiplier
FIELD field_23165 jumpVelocityMultiplier F
COMMENT The multiplier applied to the velocity of a {@link net.minecraft.entity.LivingEntity} when it jumps off this block.
COMMENT
COMMENT @see Block#getJumpVelocityMultiplier
COMMENT @see net.minecraft.entity.Entity#getJumpVelocityMultiplier
FIELD field_40337 requiredFeatures Lnet/minecraft/class_7699;
COMMENT The set of {@link net.minecraft.resource.featuretoggle.FeatureFlag FeatureFlags} that are required for this block to work correctly.
COMMENT
COMMENT @see net.minecraft.resource.featuretoggle.FeatureFlags
METHOD <init> (Lnet/minecraft/class_4970$class_2251;)V
ARG 1 settings
METHOD method_17454 createScreenHandlerFactory (Lnet/minecraft/class_2680;Lnet/minecraft/class_1937;Lnet/minecraft/class_2338;)Lnet/minecraft/class_3908;
Expand Down

0 comments on commit 91f4271

Please sign in to comment.