Add an example config panel

Mumfrey
1 parent 509a79d5
Showing 3 changed files with 77 additions and 2 deletions
src/main/java/com/examplemod/ExampleModConfigPanel.java
src/main/java/com/examplemod/LiteModExample.java
src/main/resources/assets/example/lang/en_us.lang
+package com.examplemod;
+
+import com.mumfrey.liteloader.Configurable;
+import com.mumfrey.liteloader.client.gui.GuiCheckbox;
+import com.mumfrey.liteloader.modconfig.AbstractConfigPanel;
+import com.mumfrey.liteloader.modconfig.ConfigPanelHost;
+import net.minecraft.client.resources.I18n;
+
+/**
+ * This is a simple example of adding a config panel to a mod. Your LiteMod class should implement
+ * {@link Configurable} and return this class in order to support the settings functionality of the
+ * mod panel.
+ * 
+ * @author Adam Mummery-Smith
+ */
+public class ExampleModConfigPanel extends AbstractConfigPanel
+{
+    /* (non-Javadoc)
+     * @see com.mumfrey.liteloader.modconfig.ConfigPanel#getPanelTitle()
+     */
+    @Override
+    public String getPanelTitle()
+    {
+        return I18n.format("examplemod.config.title");
+    }
+    
+    /* (non-Javadoc)
+     * @see com.mumfrey.liteloader.modconfig.AbstractConfigPanel#addOptions(com.mumfrey.liteloader.modconfig.ConfigPanelHost)
+     */
+    @Override
+    protected void addOptions(ConfigPanelHost host)
+    {
+        final LiteModExample mod = host.<LiteModExample>getMod();
+        
+        this.addLabel(1, 0, 0, 200, 32, 0xFFFF55, I18n.format("examplemod.config.help.1"), I18n.format("examplemod.config.help.2"));
+        this.addControl(new GuiCheckbox(0, 0, 32, I18n.format("examplemod.config.option.enabled")), new ConfigOptionListener<GuiCheckbox>()
+        {
+            @Override
+            public void actionPerformed(GuiCheckbox control)
+            {
+                mod.setClockVisibility(control.checked = !control.checked);
+            }
+        }).checked = mod.getClockVisibility();
+    }
+
+    @Override
+    public void onPanelHidden()
+    {
+        // This example applies the changes immediately, however you may wish to only save changes
+        // when the user clicks "save and close". In which case you should apply your changes here
+    }
+}
@@ -2,9 +2,11 @@ package com.examplemod;
  
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
+import com.mumfrey.liteloader.Configurable;
 import com.mumfrey.liteloader.PreRenderListener;
 import com.mumfrey.liteloader.Tickable;
 import com.mumfrey.liteloader.core.LiteLoader;
+import com.mumfrey.liteloader.modconfig.ConfigPanel;
 import com.mumfrey.liteloader.modconfig.ConfigStrategy;
 import com.mumfrey.liteloader.modconfig.ExposableOptions;
 import net.minecraft.client.Minecraft;
@@ -21,7 +23,7 @@ import java.io.File;
  * @author Adam Mummery-Smith
  */
 @ExposableOptions(strategy = ConfigStrategy.Versioned, filename="examplemod.json")
-public class LiteModExample implements Tickable, PreRenderListener
+public class LiteModExample implements Tickable, PreRenderListener, Configurable
 {
 	/**
 	 * This is our instance of Clock which we will draw every tick
@@ -75,6 +77,12 @@ public class LiteModExample implements Tickable, PreRenderListener
 		return "0.0.0";
 	}
  
+	@Override
+	public Class<? extends ConfigPanel> getConfigPanelClass()
+	{
+	    return ExampleModConfigPanel.class;
+	}
+	
 	/**
 	 * init() is called very early in the initialisation cycle, before the game is fully initialised, this
 	 * means that it is important that your mod does not interact with the game in any way at this point.
@@ -132,6 +140,16 @@ public class LiteModExample implements Tickable, PreRenderListener
 			this.clock.render(minecraft);
 		}
 	}
+	
+	boolean getClockVisibility()
+	{
+	    return this.clock.isVisible();
+	}
+	
+	void setClockVisibility(boolean visible)
+    {
+        this.clock.setVisible(this.clockVisible = visible);
+    }
  
 	@Override
 	public void onRenderWorld(float partialTicks)
  
-key.clock.toggle=Toggle Clock
 \ No newline at end of file
+key.clock.toggle=Toggle Clock
+
+examplemod.config.title=Example Mod Configuration
+examplemod.config.help.1=This is a simple option which demonstrates how to
+examplemod.config.help.2=add a checkbox option
+examplemod.config.option.enabled=Enable clock
 \ No newline at end of file