Skip to content

Commit 42465c3

Browse files
Added documentation to most of the code.
1 parent 090b3c0 commit 42465c3

29 files changed

+531
-244
lines changed

build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ apply plugin: 'net.minecraftforge.gradle'
1313
apply plugin: 'eclipse'
1414
apply plugin: 'maven-publish'
1515

16-
version = '1.0.1'
17-
group = 'com.codingpupper3033.btekml' // http://maven.apache.org/guides/mini/guide-naming-conventions.html
18-
archivesBaseName = 'btekml'
16+
version = '1.0.2'
17+
group = 'com.codingpupper3033.codebtekml' // http://maven.apache.org/guides/mini/guide-naming-conventions.html
18+
archivesBaseName = 'codebtekml'
1919

2020
sourceCompatibility = targetCompatibility = compileJava.sourceCompatibility = compileJava.targetCompatibility = '1.8' // Need this here so eclipse task generates correctly.
2121

src/main/java/com/codingpupper3033/btekml/events/KeyPressed.java

Lines changed: 0 additions & 18 deletions
This file was deleted.

src/main/java/com/codingpupper3033/btekml/maphelpers/Placemark.java

Lines changed: 0 additions & 11 deletions
This file was deleted.

src/main/java/com/codingpupper3033/btekml/maphelpers/altitude/AltitudeProcessor.java

Lines changed: 0 additions & 20 deletions
This file was deleted.

src/main/java/com/codingpupper3033/btekml/maphelpers/altitude/NoAltitudeException.java

Lines changed: 0 additions & 4 deletions
This file was deleted.

src/main/java/com/codingpupper3033/btekml/maphelpers/placemark/LineString.java

Lines changed: 0 additions & 31 deletions
This file was deleted.

src/main/java/com/codingpupper3033/btekml/maphelpers/placemark/Point.java

Lines changed: 0 additions & 27 deletions
This file was deleted.

src/main/java/com/codingpupper3033/btekml/BTEKMLMod.java renamed to src/main/java/com/codingpupper3033/codebtekml/CodeBTEKMLMod.java

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1-
package com.codingpupper3033.btekml;
1+
package com.codingpupper3033.codebtekml;
22

3-
import com.codingpupper3033.btekml.events.KeyPressed;
3+
import com.codingpupper3033.codebtekml.events.KeyPressed;
44
import net.minecraftforge.common.MinecraftForge;
55
import net.minecraftforge.fml.common.Mod;
66
import net.minecraftforge.fml.common.Mod.EventHandler;
77
import net.minecraftforge.fml.common.event.FMLInitializationEvent;
88
import net.minecraftforge.fml.common.event.FMLPreInitializationEvent;
99
import org.apache.logging.log4j.Logger;
1010

11-
@Mod(modid = BTEKMLMod.MODID, name = BTEKMLMod.NAME, version = BTEKMLMod.VERSION)
12-
public class BTEKMLMod
11+
/**
12+
* The mod itself
13+
* @author Joshua Miller
14+
*/
15+
@Mod(modid = CodeBTEKMLMod.MODID, name = CodeBTEKMLMod.NAME, version = CodeBTEKMLMod.VERSION)
16+
public class CodeBTEKMLMod
1317
{
14-
public static final String MODID = "btekml";
18+
public static final String MODID = "codebtekml";
1519
public static final String NAME = "BTE KML Importer";
16-
public static final String VERSION = "1.0.1";
20+
public static final String VERSION = "1.0.2";
1721

1822
private static Logger logger;
1923

src/main/java/com/codingpupper3033/btekml/KeyInit.java renamed to src/main/java/com/codingpupper3033/codebtekml/KeyInit.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
package com.codingpupper3033.btekml;
1+
package com.codingpupper3033.codebtekml;
22

33
import net.minecraft.client.settings.KeyBinding;
44
import net.minecraftforge.fml.client.registry.ClientRegistry;
55
import org.lwjgl.input.Keyboard;
66

7+
/**
8+
* Binds the key binds of the mod
9+
*/
710
public final class KeyInit {
8-
public static KeyBinding openKMLMenuKeybind;
11+
public static KeyBinding openKMLMenuKeyBind;
912

1013
public static void init() {
11-
openKMLMenuKeybind = registerKey("Open KMZ Menu", "BTE KML", Keyboard.KEY_PERIOD);
14+
openKMLMenuKeyBind = registerKey("Open KMZ Menu", "BTE KML", Keyboard.KEY_PERIOD);
1215
}
1316

1417
public static KeyBinding registerKey(String name, String category, int keycode) {
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
package com.codingpupper3033.codebtekml.events;
2+
3+
import com.codingpupper3033.codebtekml.KeyInit;
4+
import com.codingpupper3033.codebtekml.gui.screens.GuiDrawKML;
5+
import net.minecraft.client.Minecraft;
6+
import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
7+
import net.minecraftforge.fml.common.gameevent.TickEvent.ClientTickEvent;
8+
9+
/**
10+
* Will Respond to players pressing a key
11+
* @author Joshua Miller
12+
*/
13+
public class KeyPressed {
14+
@SubscribeEvent
15+
public void clientTick(ClientTickEvent event) {
16+
if (Minecraft.getMinecraft().currentScreen == null) { // Keystrokes that only work on the default game menu
17+
// Open KML Menu
18+
if (KeyInit.openKMLMenuKeyBind.isPressed()) Minecraft.getMinecraft().displayGuiScreen(new GuiDrawKML(null));
19+
}
20+
}
21+
}

0 commit comments

Comments
 (0)