Javadocs for Entity, LivingEntity, and Player (#304)

ParchmentMC · Nov 10, 2024 · 26483e7 · 26483e7
1 parent de521f8
commit 26483e7
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/data/net/minecraft/world/entity/Entity.mapping b/data/net/minecraft/world/entity/Entity.mapping
@@ -252,8 +252,12 @@ CLASS net/minecraft/world/entity/Entity
 		ARG 1 partialTick
 	METHOD getX (D)D
 		ARG 1 scale
+	METHOD getXRot ()F
+		COMMENT Gets the rotation of this entity around the x-axis (the pitch) in degrees.
 	METHOD getY (D)D
 		ARG 1 scale
+	METHOD getYRot ()F
+		COMMENT Gets the rotation of this entity around the y-axis (the yaw) in degrees.
 	METHOD getZ (D)D
 		ARG 1 scale
 	METHOD handleDamageEvent (Lnet/minecraft/world/damagesource/DamageSource;)V
@@ -627,6 +631,7 @@ CLASS net/minecraft/world/entity/Entity
 	METHOD setViewScale (D)V
 		ARG 0 renderDistWeight
 	METHOD setXRot (F)V
+		COMMENT Sets the rotation of this entity around the x-axis (the pitch) in degrees.
 		ARG 1 xRot
 	METHOD setYBodyRot (F)V
 		COMMENT Set the body Y rotation of the entity.
@@ -635,6 +640,7 @@ CLASS net/minecraft/world/entity/Entity
 		COMMENT Sets the head's Y rotation of the entity.
 		ARG 1 yHeadRot
 	METHOD setYRot (F)V
+		COMMENT Sets the rotation of this entity around the y-axis (the yaw) in degrees.
 		ARG 1 yRot
 	METHOD shouldBlockExplode (Lnet/minecraft/world/level/Explosion;Lnet/minecraft/world/level/BlockGetter;Lnet/minecraft/core/BlockPos;Lnet/minecraft/world/level/block/state/BlockState;F)Z
 		ARG 1 explosion

diff --git a/data/net/minecraft/world/entity/LivingEntity.mapping b/data/net/minecraft/world/entity/LivingEntity.mapping
@@ -193,6 +193,7 @@ CLASS net/minecraft/world/entity/LivingEntity
 	METHOD getMaxHealth ()F
 		COMMENT Returns the maximum health of the entity (what it is able to regenerate up to, what it spawned with, etc.)
 	METHOD getProjectile (Lnet/minecraft/world/item/ItemStack;)Lnet/minecraft/world/item/ItemStack;
+		COMMENT Gets an item stack available to this entity to be loaded into the provided weapon, or an empty item stack if no such item stack is available.
 		ARG 1 weaponStack
 	METHOD getRiddenInput (Lnet/minecraft/world/entity/player/Player;Lnet/minecraft/world/phys/Vec3;)Lnet/minecraft/world/phys/Vec3;
 		ARG 1 player

diff --git a/data/net/minecraft/world/entity/player/Player.mapping b/data/net/minecraft/world/entity/player/Player.mapping
@@ -172,6 +172,7 @@ CLASS net/minecraft/world/entity/player/Player
 	METHOD lambda$readAdditionalSaveData$2 (Lnet/minecraft/world/phys/Vec3;)V
 		ARG 1 currentImpulseImpactPos
 	METHOD magicCrit (Lnet/minecraft/world/entity/Entity;)V
+		COMMENT Called when the entity hit is dealt extra melee damage due to an enchantment.
 		ARG 1 entityHit
 	METHOD makeStuckInBlock (Lnet/minecraft/world/level/block/state/BlockState;Lnet/minecraft/world/phys/Vec3;)V
 		ARG 1 state
@@ -267,6 +268,7 @@ CLASS net/minecraft/world/entity/player/Player
 	METHOD setShoulderEntityRight (Lnet/minecraft/nbt/CompoundTag;)V
 		ARG 1 entityCompound
 	METHOD startAutoSpinAttack (IFLnet/minecraft/world/item/ItemStack;)V
+		COMMENT Starts the attack used by the Riptide enchantment.
 		ARG 1 ticks
 		ARG 2 damage
 		ARG 3 itemStack