Skip to content
This repository was archived by the owner on Jun 3, 2024. It is now read-only.

Commit 9ca9061

Browse files
NuclearfartsNuclearfarts
authored andcommitted
more javadoc cleanup
1 parent 37775b4 commit 9ca9061

2 files changed

Lines changed: 86 additions & 88 deletions

File tree

patchwork-extensions-block/src/main/java/net/minecraftforge/common/extensions/IForgeBlock.java

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@
5353
import net.minecraft.entity.player.PlayerEntity;
5454
import net.minecraft.entity.projectile.WitherSkullEntity;
5555
import net.minecraft.fluid.FluidState;
56-
import net.minecraft.item.Item;
5756
import net.minecraft.item.ItemStack;
5857
import net.minecraft.server.world.ServerWorld;
5958
import net.minecraft.sound.BlockSoundGroup;
@@ -263,6 +262,7 @@ default boolean isBed(BlockState state, BlockView world, BlockPos pos, @Nullable
263262
* @param world The current world
264263
* @param pos Block position in world
265264
* @param restriction The location spawn restriction
265+
* @param entityType The type of entity attempting to spawn
266266
* @return True to allow a mob of the specified category to spawn, false to prevent it.
267267
*/
268268
default boolean canCreatureSpawn(BlockState state, BlockView world, BlockPos pos, SpawnRestriction.Location restriction, @Nullable EntityType<?> entityType) {
@@ -457,7 +457,7 @@ default boolean isFoliage(BlockState state, CollisionView world, BlockPos pos) {
457457
// TODO Call locations: Patches: LivingEntity*
458458
/**
459459
* Allows a block to override the standard {@link LivingEntity#fall} particles.
460-
* particles, this is a server side method that spawns particles with
460+
* This is a server side method that spawns particles with
461461
* {@link ServerWorld#spawnParticles}
462462
*
463463
* @param state1 This block's state.
@@ -685,6 +685,7 @@ default boolean recolorBlock(BlockState state, IWorld world, BlockPos pos, Direc
685685
/**
686686
* Called when a block entity on a side of this block changes is created or is destroyed.
687687
*
688+
* @param state The state of this block
688689
* @param world The world
689690
* @param pos Block position in world
690691
* @param neighbor Block position of neighbor
@@ -709,6 +710,7 @@ default void observedNeighborChange(BlockState observerState, World world, Block
709710
/**
710711
* Called to determine whether to allow the a block to handle its own indirect power rather than using the default rules.
711712
*
713+
* @param state This block's state
712714
* @param world The world
713715
* @param pos Block position in world
714716
* @param side The INPUT side of the block to be powered - ie the opposite of this block's output side
@@ -862,15 +864,13 @@ default BlockState getStateAtViewpoint(BlockState state, BlockView world, BlockP
862864
/**
863865
* Gets the {@link BlockState} to place.
864866
*
865-
* @param world The world the block is being placed in
866-
* @param pos The position the block is being placed at
867+
* @param state ??? (presumably this block's state, but it has not yet been placed?)
867868
* @param facing The side the block is being placed on
868-
* @param hitX The X coordinate of the hit vector
869-
* @param hitY The Y coordinate of the hit vector
870-
* @param hitZ The Z coordinate of the hit vector
871-
* @param meta The metadata of {@link ItemStack} as processed by {@link Item#getMetadata(int)}
872-
* @param placer The entity placing the block
873-
* @param hand The player hand used to place this block
869+
* @param state2 ???
870+
* @param world The world the block is being placed in
871+
* @param pos1 ??? (presumably where it's being placed)
872+
* @param pos2 ???
873+
* @param hand The hand the block is being placed from
874874
* @return The state to be placed in the world
875875
*/
876876
default BlockState getStateForPlacement(BlockState state, Direction facing, BlockState state2, IWorld world, BlockPos pos1, BlockPos pos2, Hand hand) {
@@ -881,6 +881,7 @@ default BlockState getStateForPlacement(BlockState state, Direction facing, Bloc
881881
/**
882882
* Determines if another block can connect to this block.
883883
*
884+
* @param state This block's state
884885
* @param world The current world
885886
* @param pos The position of this block
886887
* @param facing The side the connecting block is on

0 commit comments

Comments
 (0)