Handbook rewrite part 1: Formatting and JSON-ification!

- Everything is now defined in a JSON file - Formatting is now done dynamically and content wraps properly no matter what font is used - Added inline hyperlinks - Added a movable bookmark for quick access to a specific page - Added next section and previous section buttons to flip through entire sections at once - Added a contents button visible on every page, which navigates directly to the main contents
2019-01-05 22:38:06 +00:00
parent 78189ed862
commit 13569058ae
16 changed files with 2819 additions and 785 deletions
@@ -0,0 +1,119 @@
+package electroblob.wizardry.client.gui.handbook;
+
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonSyntaxException;
+import electroblob.wizardry.client.DrawingUtils;
+import net.minecraft.client.Minecraft;
+import net.minecraft.client.gui.FontRenderer;
+import net.minecraft.client.renderer.GlStateManager;
+import net.minecraft.util.JsonUtils;
+import net.minecraft.util.ResourceLocation;
+
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+class Image {
+
+	// Final fields are mandatory, the rest are optional
+	private final ResourceLocation location;
+	private final int width, height;
+	private int textureWidth, textureHeight;
+	private int u = 0, v = 0;
+	private String caption = "";
+	// Derived fields, not specifically defined in JSON
+	private final Set<int[]> instances = new HashSet<>();
+
+	private static final int CAPTION_OFFSET = 4;
+
+	private Image(ResourceLocation location, int width, int height){
+		this.location = location;
+		this.width = width;
+		this.height = height;
+	}
+
+	/** Returns the width of the image. */
+	int getWidth(){
+		return width;
+	}
+
+	/** Returns the total height of the image, including caption if it has one. */
+	int getHeight(FontRenderer font){
+		return caption.isEmpty() ? height : height + CAPTION_OFFSET + font.FONT_HEIGHT;
+	}
+
+	/**
+	 * Adds an instance of this image to the list.
+	 *
+	 * @param page The index of the <b>single</b> page this image is on.
+	 * @param x    The x-coordinate of the top-left corner of the image, <i>relative</i> to the top-left corner of the GUI.
+	 * @param y    The y-coordinate of the top-left corner of the image, <i>relative</i> to the top-left corner of the GUI.
+	 */
+	void addInstance(int page, int x, int y){
+		instances.add(new int[]{page, x, y});
+	}
+
+	/** Removes all instances of this image from the list. */
+	void clearInstances(){
+		instances.clear();
+	}
+
+	/**
+	 * Draws all instances of this image that are located on the given double-page spread.
+	 *
+	 * @param font       The font renderer object.
+	 * @param doublePage The double-page index of the page to be drawn.
+	 * @param left       The x coordinate of the left side of the GUI.
+	 * @param top        The y coordinate of the top of the GUI.
+	 */
+	void draw(FontRenderer font, int doublePage, int left, int top){
+		for(int[] instance : instances){
+			if(GuiWizardHandbook.singleToDoublePage(instance[0]) == doublePage){
+				Minecraft.getMinecraft().renderEngine.bindTexture(location);
+				GlStateManager.color(1, 1, 1, 1);
+				DrawingUtils.drawTexturedRect(left + instance[1], top + instance[2], u, v, width, height, textureWidth, textureHeight);
+				font.drawString("\u00A7o" + caption, left + instance[1] +  width/ 2 - font.getStringWidth(caption)/2,
+						top + instance[2] + height + CAPTION_OFFSET, GuiWizardHandbook.colours.get("caption"));
+			}
+		}
+	}
+
+	/**
+	 * Parses the given JSON object and constructs a new {@code Image} from it, setting all the relevant fields
+	 * and references.
+	 *
+	 * @param json A JSON object representing the image to be constructed. This must contain at least a "location"
+	 *             string.
+	 * @return The resulting {@code Image} object.
+	 * @throws JsonSyntaxException if at any point the JSON object is found to be invalid.
+	 */
+	static Image fromJson(JsonObject json){
+
+		Image image = new Image(new ResourceLocation(JsonUtils.getString(json, "location")),
+				JsonUtils.getInt(json, "width"), JsonUtils.getInt(json, "height"));
+
+		image.u = JsonUtils.getInt(json, "u", 0);
+		image.v = JsonUtils.getInt(json, "v", 0);
+		image.textureWidth = JsonUtils.getInt(json, "texture_width", image.width);
+		image.textureHeight = JsonUtils.getInt(json, "texture_height", image.height);
+		image.caption = JsonUtils.getString(json, "caption", "");
+
+
+		return image;
+	}
+
+	static void populate(Map<String, Image> map, JsonObject json){
+
+		JsonObject sectionsObject = JsonUtils.getJsonObject(json, "images");
+
+		// Need to iterate over these since we don't know what they're called or how many there are
+		for(Map.Entry<String, JsonElement> entry : sectionsObject.entrySet()){
+
+			String key = entry.getKey(); // Find out what each element is called, this will be the sections map key
+
+			Image image = fromJson(entry.getValue().getAsJsonObject());
+			map.put(key, image);
+		}
+	}
+}