LiteLoader 1.6.4_02 - experimental - commented horrible GUI code, fixed scrollbar visual bug

Mumfrey
1 parent 10a436e9
Showing 3 changed files with 118 additions and 43 deletions
java/com/mumfrey/liteloader/core/LiteLoader.java
java/com/mumfrey/liteloader/gui/GuiScreenModInfo.java
java/com/mumfrey/liteloader/gui/GuiSimpleScrollBar.java
@@ -587,7 +587,7 @@ public final class LiteLoader
 	/**
 	 * Get a reference to a loaded mod, if the mod exists
 	 * 
-	 * @param modName Mod's name or class name
+	 * @param modName Mod's name, meta name or class name
 	 * @return
 	 * @throws InvalidActivityException
 	 */
@@ -606,7 +606,9 @@ public final class LiteLoader
 		for (LiteMod mod : this.mods)
 		{
-			if (modName.equalsIgnoreCase(mod.getName()) || modName.equalsIgnoreCase(mod.getClass().getSimpleName()))
+			String metaName = this.getModMetaName(mod.getClass());
+			
+			if (modName.equalsIgnoreCase(mod.getName()) || modName.equalsIgnoreCase(metaName) || modName.equalsIgnoreCase(mod.getClass().getSimpleName()))
 				return (T)mod;
 		}
@@ -39,50 +39,101 @@ import net.minecraft.src.Tessellator;
  */
 public class GuiScreenModInfo extends GuiScreen
 {
-	private static final int LEFT_EDGE  = 80;
-	private static final int TAB_WIDTH  = 20;
-	private static final int TAB_HEIGHT = 40;
-	private static final int TAB_TOP    = 20;
+	private static final int LEFT_EDGE    = 80;
+	private static final int TAB_WIDTH    = 20;
+	private static final int TAB_HEIGHT   = 40;
+	private static final int TAB_TOP      = 20;
+	private static final int PANEL_TOP    = 83;
+	private static final int PANEL_BOTTOM = 26;
+	
+	private static final double TWEEN_RATE = 0.08;
 	/**
 	 * Used for clipping
 	 */
 	private static DoubleBuffer doubleBuffer = BufferUtils.createByteBuffer(64).asDoubleBuffer();
+	// Texture resources for the "about mods" screen, we load the texture directly anyway so it won't be from an RP
 	public static ResourceLocation aboutTextureResource;
 	private static DynamicTexture aboutTexture;
+	/**
+	 * Reference to the main menu which this screen is either overlaying or using as its background
+	 */
 	private GuiMainMenu mainMenu;
+	/**
+	 * Tick number (update counter) used for tweening
+	 */
 	private long tickNumber;
+	/**
+	 * Last tick number, for tweening
+	 */
 	private double lastTick;
-	private double tweenAmount = 0.0, tweenRate = 0.08;
+	/**
+	 * Current tween percentage (0.0 -> 1.0)
+	 */
+	private double tweenAmount = 0.0;
+	/**
+	 * Since we don't get real mouse events we have to simulate them by tracking the mouse state
+	 */
 	private boolean mouseDown, toggled;
+	/**
+	 * Hover opacity for the tab
+	 */
 	private float tabOpacity = 0.0F;
+	/**
+	 * List of enumerated mods
+	 */
 	private List<GuiModListEntry> mods = new ArrayList<GuiModListEntry>();
+	/**
+	 * Currently selected mod
+	 */
 	private GuiModListEntry selectedMod = null;
+	/**
+	 * Text to display under the header
+	 */
 	private String activeModText = "0 mod(s) loaded";
-	private int listHeight;
+	/**
+	 * Height of all the items in the list
+	 */
+	private int listHeight = 100;
+	/**
+	 * Scroll bar control for the mods list
+	 */
 	private GuiSimpleScrollBar scrollBar = new GuiSimpleScrollBar();
+	/**
+	 * Enable / disable button
+	 */
 	private GuiButton btnToggle;
+	/**
+	 * Enable the mod info tab checkbox
+	 */
 	private GuiCheckbox chkEnabled;
+	/**
+	 * @param minecraft
+	 * @param mainMenu
+	 * @param loader
+	 * @param enabledModsList
+	 */
 	public GuiScreenModInfo(Minecraft minecraft, GuiMainMenu mainMenu, LiteLoader loader, EnabledModsList enabledModsList)
 	{
 		this.mc = minecraft;
 		this.mainMenu = mainMenu;
+		// Spawn the texture resource if we haven't already
 		if (aboutTexture == null)
 		{
 			try
@@ -107,26 +158,29 @@ public class GuiScreenModInfo extends GuiScreen
 	{
 		this.activeModText = String.format("%d mod(s) loaded", loader.getLoadedMods().size());
+		// Add mods to this treeset first, in order to sort them
 		Map<String, GuiModListEntry> sortedMods = new TreeMap<String, GuiModListEntry>();
+		// Active mods
 		for (LiteMod mod : loader.getLoadedMods())
 		{
 			GuiModListEntry modListEntry = new GuiModListEntry(loader, enabledModsList, this.mc.fontRenderer, mod);
 			sortedMods.put(modListEntry.getKey(), modListEntry);
 		}
+		// Disabled mods
 		for (ModFile disabledMod : loader.getDisabledMods())
 		{
 			GuiModListEntry modListEntry = new GuiModListEntry(loader, enabledModsList, this.mc.fontRenderer, disabledMod);
 			sortedMods.put(modListEntry.getKey(), modListEntry);
 		}
-		
+
+		// Add the sorted mods to the mods list
 		this.mods.addAll(sortedMods.values());
+		// Select the first mod in the list
 		if (this.mods.size() > 0)
-		{
 			this.selectedMod = this.mods.get(0);
-		}
 	}
 	/**
@@ -155,8 +209,8 @@ public class GuiScreenModInfo extends GuiScreen
 		int left = LEFT_EDGE + 16 + (this.width - LEFT_EDGE - 28) / 2;
 		this.buttonList.clear();
-		this.buttonList.add(this.btnToggle = new GuiButton(0, left, this.height - 50, 100, 20, "Enable mod"));
-		this.buttonList.add(this.chkEnabled = new GuiCheckbox(1, LEFT_EDGE + 12, this.height - 17, "Show LiteLoader tab on main menu"));
+		this.buttonList.add(this.btnToggle = new GuiButton(0, left, this.height - PANEL_BOTTOM - 24, 100, 20, "Enable mod"));
+		this.buttonList.add(this.chkEnabled = new GuiCheckbox(1, LEFT_EDGE + 12, this.height - PANEL_BOTTOM + 9, "Show LiteLoader tab on main menu"));
 		this.selectMod(this.selectedMod);
 	}
@@ -204,23 +258,32 @@ public class GuiScreenModInfo extends GuiScreen
 	{
 		boolean active = this.mc.currentScreen == this;
-		this.width = this.mainMenu.width;
-		this.height = this.mainMenu.height;
-
 		if (active)
 		{
+			// Draw the parent screen as our background if we are the active screen
 			glClear(GL_DEPTH_BUFFER_BIT);
 			this.mainMenu.drawScreen(-10, -10, partialTicks);
 			glClear(GL_DEPTH_BUFFER_BIT);
 		}
-		
+		else
+		{
+			// If this is not the active screen, copy the width and height from the parent GUI
+			this.width = this.mainMenu.width;
+			this.height = this.mainMenu.height;
+		}
+
+		// Calculate the current tween position
 		float xOffset = (this.width - LEFT_EDGE) * this.calcTween(partialTicks, active) + 16.0F + (this.tabOpacity * -32.0F);
 		mouseX -= (int)xOffset;
+		// Handle mouse stuff here since we won't get mouse events when not the active GUI
 		boolean mouseOverTab = mouseX > LEFT_EDGE - TAB_WIDTH && mouseX < LEFT_EDGE && mouseY > TAB_TOP && mouseY < TAB_TOP + TAB_HEIGHT;
 		this.handleMouseClick(mouseX, mouseY, partialTicks, active, mouseOverTab);
+		// Calculate the tab opacity, not framerate adjusted because we don't really care
 		this.tabOpacity = mouseOverTab || this.tweenAmount > 0.0 ? 0.5F : Math.max(0.0F, this.tabOpacity - partialTicks * 0.1F);
+		
+		// Draw the panel contents
 		this.drawPanel(mouseX, mouseY, partialTicks, active, xOffset);
 	}
@@ -236,31 +299,38 @@ public class GuiScreenModInfo extends GuiScreen
 		glPushMatrix();
 		glTranslatef(xOffset, 0.0F, 0.0F);
+		// Draw the background and left edge
 		drawRect(LEFT_EDGE, 0, this.width, this.height, 0xB0000000);
 		drawRect(LEFT_EDGE, 0, LEFT_EDGE + 1, TAB_TOP, 0xFFFFFFFF);
 		drawRect(LEFT_EDGE, TAB_TOP + TAB_HEIGHT, LEFT_EDGE + 1, this.height, 0xFFFFFFFF);
+		// Draw the tab
 		this.mc.getTextureManager().bindTexture(aboutTextureResource);
 		glDrawTexturedRect(LEFT_EDGE - TAB_WIDTH, TAB_TOP, TAB_WIDTH + 1, TAB_HEIGHT, 80, 80, 122, 160, 0.5F + this.tabOpacity);
+		// Only draw the panel contents if we are actually open
 		if (this.tweenAmount > 0.0)
 		{
-			glDrawTexturedRect(LEFT_EDGE + 12, 12, 128, 40, 0, 0, 256, 80, 1.0F);
-			glDrawTexturedRect(this.width - 32 - 12, 12, 32, 45, 0, 80, 64, 170, 1.0F);
+			// Draw the header pieces
+			glDrawTexturedRect(LEFT_EDGE + 12, 12, 128, 40, 0, 0, 256, 80, 1.0F); // liteloader logo
+			glDrawTexturedRect(this.width - 32 - 12, 12, 32, 45, 0, 80, 64, 170, 1.0F); // chicken
+			// Draw header text
 			this.fontRenderer.drawString("Version " + LiteLoader.getVersion(), LEFT_EDGE + 12 + 38, 50, 0xFFFFFFFF);
 			this.fontRenderer.drawString(this.activeModText, LEFT_EDGE + 12 + 38, 60, 0xFFAAAAAA);
+			// Draw top and bottom horizontal rules
 			drawRect(LEFT_EDGE + 12, 80, this.width - 12, 81, 0xFF999999);
-			drawRect(LEFT_EDGE + 12, this.height - 24, this.width - 12, this.height - 23, 0xFF999999);
+			drawRect(LEFT_EDGE + 12, this.height - PANEL_BOTTOM + 2, this.width - 12, this.height - PANEL_BOTTOM + 3, 0xFF999999);
-			int panelTop = 83;
 			int innerWidth = this.width - LEFT_EDGE - 24 - 4;
-			int listWidth = innerWidth / 2;
+			int panelWidth = innerWidth / 2;
+			int panelHeight = this.height - PANEL_BOTTOM - PANEL_TOP;
-			this.drawModsList(mouseX, mouseY, partialTicks, panelTop, listWidth);
-			this.drawSelectedMod(mouseX, mouseY, partialTicks, panelTop, listWidth);
+			this.drawModsList(mouseX, mouseY, partialTicks, panelWidth, panelHeight);
+			this.drawSelectedMod(mouseX, mouseY, partialTicks, panelWidth, panelHeight);
+			// Draw other controls inside the transform so that they slide properly
 			super.drawScreen(mouseX, mouseY, partialTicks);
 		}
@@ -271,49 +341,52 @@ public class GuiScreenModInfo extends GuiScreen
 	 * @param mouseX
 	 * @param mouseY
 	 * @param partialTicks
-	 * @param panelWidth
+	 * @param width
+	 * @param height
 	 */
-	public void drawModsList(int mouseX, int mouseY, float partialTicks, int panelTop, int panelWidth)
+	public void drawModsList(int mouseX, int mouseY, float partialTicks, int width, int height)
 	{
-		int panelHeight = this.height - 26 - panelTop;
-		this.scrollBar.drawScrollBar(mouseX, mouseY, partialTicks, LEFT_EDGE + 12 + panelWidth - 5, panelTop, 5, panelHeight, this.listHeight);
+		this.scrollBar.drawScrollBar(mouseX, mouseY, partialTicks, LEFT_EDGE + 12 + width - 5, PANEL_TOP, 5, height, this.listHeight);
-		glEnableClipping(LEFT_EDGE + 12, LEFT_EDGE + 12 + panelWidth - 6, panelTop, this.height - 26);
+		// clip outside of scroll area
+		glEnableClipping(LEFT_EDGE + 12, LEFT_EDGE + 12 + width - 6, PANEL_TOP, this.height - PANEL_BOTTOM);
+		// handle scrolling
 		glPushMatrix();
-		glTranslatef(0.0F, panelTop - this.scrollBar.getValue(), 0.0F);
+		glTranslatef(0.0F, PANEL_TOP - this.scrollBar.getValue(), 0.0F);
-		mouseY -= (panelTop - this.scrollBar.getValue());
+		mouseY -= (PANEL_TOP - this.scrollBar.getValue());
 		int yPos = 0;
 		for (GuiModListEntry mod : this.mods)
 		{
-			yPos += mod.drawListEntry(mouseX, mouseY, partialTicks, LEFT_EDGE + 12, yPos, panelWidth - 6, mod == this.selectedMod);
+			// drawListEntry returns a value indicating the height of the item drawn
+			yPos += mod.drawListEntry(mouseX, mouseY, partialTicks, LEFT_EDGE + 12, yPos, width - 6, mod == this.selectedMod);
 		}
 		glPopMatrix();
 		glDisableClipping();
 		this.listHeight = yPos;
-		this.scrollBar.setMaxValue(this.listHeight - panelHeight);
+		this.scrollBar.setMaxValue(this.listHeight - height);
 	}
 	/**
 	 * @param mouseX
 	 * @param mouseY
 	 * @param partialTicks
-	 * @param panelTop
-	 * @param listWidth
+	 * @param width
+	 * @param height
 	 */
-	public void drawSelectedMod(int mouseX, int mouseY, float partialTicks, int panelTop, int listWidth)
+	public void drawSelectedMod(int mouseX, int mouseY, float partialTicks, int width, int height)
 	{
 		if (this.selectedMod != null)
 		{
-			int left = LEFT_EDGE + 12 + listWidth;
+			int left = LEFT_EDGE + 12 + width;
 			int right = this.width - 12;
-			glEnableClipping(left, right, panelTop, this.height - 54);
-			this.selectedMod.drawInfo(mouseX, mouseY, partialTicks, left, panelTop, right - left);
+			glEnableClipping(left, right, PANEL_TOP, this.height - PANEL_BOTTOM - 28);
+			this.selectedMod.drawInfo(mouseX, mouseY, partialTicks, left, PANEL_TOP, right - left);
 			glDisableClipping();
 		}
 	}
@@ -384,7 +457,7 @@ public class GuiScreenModInfo extends GuiScreen
 				this.scrollBar.setDragging(true);
 			}
-			if (mouseY > 83 && mouseY < this.height - 26)
+			if (mouseY > PANEL_TOP && mouseY < this.height - PANEL_BOTTOM)
 			{
 				for (GuiModListEntry mod : this.mods)
 				{
@@ -456,11 +529,11 @@ public class GuiScreenModInfo extends GuiScreen
 		if (active && this.tweenAmount < 1.0)
 		{
-			this.tweenAmount = Math.min(1.0, this.tweenAmount + ((tickValue - this.lastTick) * this.tweenRate));
+			this.tweenAmount = Math.min(1.0, this.tweenAmount + ((tickValue - this.lastTick) * TWEEN_RATE));
 		}
 		else if (!active && this.tweenAmount > 0.0)
 		{
-			this.tweenAmount = Math.max(0.0, this.tweenAmount - ((tickValue - this.lastTick) * this.tweenRate));
+			this.tweenAmount = Math.max(0.0, this.tweenAmount - ((tickValue - this.lastTick) * TWEEN_RATE));
 		}
 		this.lastTick = tickValue;
@@ -121,7 +121,7 @@ public class GuiSimpleScrollBar extends Gui
 			float pct = Math.min(1.0F, (float)slideHeight / (float)totalHeight);
 			int barHeight = (int)(pct * slideHeight);
 			int barTravel = slideHeight - barHeight;
-			int barPosition = this.maxValue > 0 ? yPosition + 1 + (int)((this.value / (float)this.maxValue) * barTravel) : 0;
+			int barPosition = yPosition + 1 + (this.maxValue > 0 ? (int)((this.value / (float)this.maxValue) * barTravel) : 0);
 			drawRect(xPosition + 1, barPosition, xPosition + width - 1, barPosition + barHeight, this.foreColour);