Add documentation

Author: Mrbysco

common/src/main/java/com/mrbysco/armorposer/animation/AnimationHandler.java

@@ -20,33 +20,45 @@
 import java.util.Set;
 
 public class AnimationHandler {
+	// Cache of item frames positions that are currently being animated
 	private static final Set<BlockPos> cachedFrames = new HashSet<>();
 
+	/**
+	 * Handles the animation for the armor stand when an item frame is powered while holding a compatible armor poser book
+	 *
+	 * @param frame The item frame that is being checked
+	 */
 	public static void onFrameUpdate(ItemFrame frame) {
 		if (frame.level() instanceof ServerLevel serverLevel && frame.getDirection() == Direction.UP) {
 			BlockPos pos = frame.blockPosition();
 			ItemStack frameStack = frame.getItem();
+			// Check if the item frame is holding a valid armor poser book
 			if (isValidArmorPoserBook(frameStack)) {
+				// Check if the item frame is powered
 				if (serverLevel.getSignal(pos, Direction.UP) >= 1) {
 					if (!cachedFrames.contains(pos)) {
 						cachedFrames.add(pos);
 						WrittenBookContent bookContent = frameStack.getOrDefault(DataComponents.WRITTEN_BOOK_CONTENT, WrittenBookContent.EMPTY);
+						// The name to match the armor stand with (empty string if no match required)
 						String match = "";
 						if (!bookContent.pages().isEmpty()) {
 							var firstPage = bookContent.pages().getFirst();
 							if (!firstPage.raw().getString().isEmpty())
 								match = firstPage.raw().getString();
 						}
+						// Targeting conditions for the armor stand
 						TargetingConditions conditions = TargetingConditions.forNonCombat();
 						if (!match.isEmpty()) {
 							String finalMatch = match;
 							conditions.selector((livingEntity, level) ->
 									livingEntity.getName().getString().equals(finalMatch));
 						}
+						// Search for the nearest armor stand within the search radius
 						var nearestStand = serverLevel.getNearestEntity(ArmorStand.class, conditions, null, pos.getX(), pos.getY(), pos.getZ(),
 								AABB.ofSize(frame.position(), Reference.ANIMATION_SEARCH_RADIUS, Reference.ANIMATION_SEARCH_RADIUS, Reference.ANIMATION_SEARCH_RADIUS));
 						if (nearestStand != null) {
 							CompoundTag customTag = frameStack.getOrDefault(DataComponents.CUSTOM_DATA, CustomData.EMPTY).copyTag();
+							// Check if the book contains a saved pose
 							if (customTag.contains("SavedPose")) {
 								CompoundTag poseTag = customTag.getCompound("SavedPose");
 								BookCopyData bookCopyData = new BookCopyData(nearestStand.getUUID(), poseTag);
@@ -61,6 +73,12 @@ public static void onFrameUpdate(ItemFrame frame) {
 		}
 	}
 
+	/**
+	 * Checks if the item frame is holding a valid armor poser book
+	 *
+	 * @param stack The item stack that is being checked
+	 * @return True if the item stack is a valid armor poser book
+	 */
 	private static boolean isValidArmorPoserBook(ItemStack stack) {
 		return stack.is(Items.WRITTEN_BOOK)
 				&& stack.getCustomName() != null

common/src/main/java/com/mrbysco/armorposer/data/BookCopyData.java

@@ -26,19 +26,32 @@ public record BookCopyData(UUID entityUUID, CompoundTag tag) {
 			BookCopyData::tag,
 			BookCopyData::new);
 
+	/**
+	 * Handles applying the pose data to the player's offhand book if it's an armor poser book
+	 *
+	 * @param player The player to apply the data to
+	 */
 	public void handleData(Player player) {
 		if (!tag.isEmpty()) {
 			ItemStack offStack = player.getOffhandItem();
+			// Check if the player is holding an armor poser book
 			if (offStack.is(Items.WRITTEN_BOOK) && offStack.getCustomName() != null && offStack.getCustomName().getString().equals("Armor Poser")) {
 				CustomData data = offStack.getOrDefault(DataComponents.CUSTOM_DATA, CustomData.EMPTY);
 				CompoundTag tagCopy = data.copyTag();
+				// Set the datapack to ArmorStatuesV2 to make it compatible with the Armor Statues Datapack
 				tagCopy.putString("datapack", "ArmorStatuesV2");
+				// Set the pose data to the book
 				tagCopy.put("SavedPose", tag);
 				offStack.set(DataComponents.CUSTOM_DATA, CustomData.of(tagCopy));
 			}
 		}
 	}
 
+	/**
+	 * Handles the pose data for the armor stand
+	 *
+	 * @param armorStand The armor stand to apply the pose to
+	 */
 	public void handleFrame(ArmorStand armorStand) {
 		CompoundTag entityTag = armorStand.saveWithoutId(new CompoundTag());
 		CompoundTag entityTagCopy = entityTag.copy();