Clip to Magazine, to be more accurate.

Author: ProgrammerDan

README.md

@@ -10,20 +10,20 @@ If you enable them in config, players can get guns using the following simple co
 
 **/gun** -- presents a menu with all configured guns
 
-**/clip** -- some guns aren't loaded directly, but via "clips" or magazines of bullets, this command brings up a menu to pick 'em
+**/magazine** -- some guns aren't loaded directly, but via "magazines" of bullets, this command brings up a menu to pick 'em
 
 **/bullet** -- guns need bullets to fire, brings up a menu showing all configured bullets.
 
 ### Loading
 -----------
 
-To load bullets into guns or clips, pick up the bullets. While holding them, right click the clip, or gun, as indicated.
+To load bullets into guns or magazines, pick up the bullets. While holding them, right click the magazine, or gun, as indicated.
 
-Pay attention to the lore on the gun / clip -- it'll tell you if it can hold the bullets you've picked up or not.
+Pay attention to the lore on the gun / magazine -- it'll tell you if it can hold the bullets you've picked up or not.
 
-To load clips into guns, pick up the clip, and right click the gun. If a clip is already loaded, it will be swapped out with the one you are holding.
+To load magazines into guns, pick up the magazine, and right click the gun. If a magazine is already loaded, it will be swapped out with the one you are holding.
 
-If you've "locked" a clip to a particular bullet type, but the clip is now empty, right click the clip with nothing in your hand, to "free it" for other
+If you've "locked" a magazine to a particular bullet type, but the magazine is now empty, right click the magazine with nothing in your hand, to "free it" for other
 kinds of bullets.
 
 ### Repair

pom.xml

@@ -5,7 +5,7 @@
 	<groupId>com.programmerdan.minecraft</groupId>
 	<artifactId>addgun</artifactId>
 	<packaging>jar</packaging>
-	<version>0.1.0</version>
+	<version>0.2.0</version>
 	<name>AddGun</name>
 	<url>https://github.com/ProgrammerDan/AddGun</url>
 
@@ -98,7 +98,7 @@
 		<dependency>
 			<groupId>org.spigotmc</groupId>
 			<artifactId>spigot</artifactId>
-			<version>1.12-R0.1-SNAPSHOT</version>
+			<version>1.12.2-R0.1-SNAPSHOT</version>
 			<scope>provided</scope>
 		</dependency>
 		<dependency>

src/main/java/com/programmerdan/minecraft/addgun/AddGun.java

@@ -21,7 +21,7 @@
 import com.google.common.reflect.ClassPath;
 import com.programmerdan.minecraft.addgun.ammo.Bullet;
 import com.programmerdan.minecraft.addgun.ammo.Bullets;
-import com.programmerdan.minecraft.addgun.ammo.Clip;
+import com.programmerdan.minecraft.addgun.ammo.Magazine;
 import com.programmerdan.minecraft.addgun.commands.CommandHandler;
 import com.programmerdan.minecraft.addgun.guns.BasicGun;
 import com.programmerdan.minecraft.addgun.guns.Guns;
@@ -186,22 +186,22 @@ private void addBullets(FileConfiguration config) {
 			}
 		}
 
-		ConfigurationSection clips = config.getConfigurationSection("clips");
-		if (clips == null || clips.getKeys(false) == null) {
-			this.warning("No clips enabled.");
+		ConfigurationSection magazines = config.getConfigurationSection("magazines");
+		if (magazines == null || magazines.getKeys(false) == null) {
+			this.warning("No magazines enabled.");
 		}
 
-		for (String clipName : clips.getKeys(false)) {
+		for (String magName : magazines.getKeys(false)) {
 			try {
-				Clip clip = new Clip(clips.getConfigurationSection(clipName));
+				Magazine magazine = new Magazine(magazines.getConfigurationSection(magName));
 
-				this.ammo.registerClip(clip);
+				this.ammo.registerMagazine(magazine);
 			} catch (Exception e) {
-				warning("Failed to register clip {0} due to error {1}", clipName, e);
+				warning("Failed to register magazine {0} due to error {1}", magName, e);
 			}
 		}
 
-		if (this.ammo.hasClips()) {
+		if (this.ammo.hasMagazines()) {
 			this.getServer().getPluginManager().registerEvents(this.ammo, this);
 		}
 	}

src/main/java/com/programmerdan/minecraft/addgun/ammo/AmmoType.java

@@ -1,7 +1,7 @@
 package com.programmerdan.minecraft.addgun.ammo;
 
 public enum AmmoType {
-	CLIP,
+	MAGAZINE,
 	BULLET,
 	INVENTORY
 }

src/main/java/com/programmerdan/minecraft/addgun/ammo/Bullet.java

@@ -40,7 +40,7 @@
 import com.programmerdan.minecraft.addgun.guns.HitPart;
 
 /**
- * Represents a single bullet type that can match against standard ammo, be aggregated into clips or directly loaded into a gun.
+ * Represents a single bullet type that can match against standard ammo, be aggregated into magazines or directly loaded into a gun.
  * 
  * @author ProgrammerDan
  *

src/main/java/com/programmerdan/minecraft/addgun/ammo/Bullets.java

@@ -16,15 +16,15 @@
 
 import com.google.common.collect.Sets;
 import com.programmerdan.minecraft.addgun.AddGun;
-import com.programmerdan.minecraft.addgun.events.LoadClipEvent;
+import com.programmerdan.minecraft.addgun.events.LoadMagazineEvent;
 import com.programmerdan.minecraft.addgun.events.LoadGunEvent;
 import com.programmerdan.minecraft.addgun.guns.StandardGun;
 
 /**
  * Intent here is this class holds configurations of bullets and provides easy accessors.
  * Each gun will have a list of bullets that it can use.
  * 
- * Bullets and clips are constructed from config.
+ * Bullets and magazines are constructed from config.
  * 
  * @author ProgrammerDan
  *
@@ -33,15 +33,15 @@ public class Bullets implements Listener {
 
 	private Map<String, Bullet> tagMap = new ConcurrentHashMap<>();
 
-	private Map<String, Clip> clipTagMap = new ConcurrentHashMap<>();
+	private Map<String, Magazine> magazineTagMap = new ConcurrentHashMap<>();
 
 	private Map<String, Bullet> nameMap = new ConcurrentHashMap<>();
 
-	private Map<String, Clip> clipMap = new ConcurrentHashMap<>();
+	private Map<String, Magazine> magazineMap = new ConcurrentHashMap<>();
 
 	private Map<Material, Set<Bullet>> map = new ConcurrentHashMap<>();
 
-	private Map<Material, Set<Clip>> clips = new ConcurrentHashMap<>();
+	private Map<Material, Set<Magazine>> magazines = new ConcurrentHashMap<>();
 
 	/**
 	 * Register a bullet. Handles all index mapping.
@@ -65,24 +65,24 @@ public void registerBullet(Bullet bullet) {
 	}
 
 	/**
-	 * Registers a clip. Handles all index mapping.
+	 * Registers a magazine. Handles all index mapping.
 	 * 
-	 * @param clip the clip to regsiter
+	 * @param magazine the magazine to regsiter
 	 */
-	public void registerClip(Clip clip) {
-		if (clip == null) return;
+	public void registerMagazine(Magazine magazine) {
+		if (magazine == null) return;
 
-		clipMap.put(clip.getName(), clip);
+		magazineMap.put(magazine.getName(), magazine);
 
-		clips.compute(clip.getMaterialType(), (k, s) -> {
+		magazines.compute(magazine.getMaterialType(), (k, s) -> {
 			if (s == null) {
 				s = Sets.newConcurrentHashSet();
 			}
-			s.add(clip);
+			s.add(magazine);
 			return s;
 		});
 
-		clipTagMap.put(clip.getTag(), clip);
+		magazineTagMap.put(magazine.getTag(), magazine);
 	}
 
 	/**
@@ -124,50 +124,50 @@ public Bullet getBulletByTag(String tag) {
 	}
 
 	/**
-	 * Using a supplied item, identifies which clip, or if none, null.
+	 * Using a supplied item, identifies which magazine, or if none, null.
 	 * 
-	 * @param clip the ItemStack to check
-	 * @return a Clip or null.
+	 * @param magazine the ItemStack to check
+	 * @return a Magazine or null.
 	 */
-	public Clip findClip(ItemStack clip) {
-		if (clip == null) return null;
-		Set<Clip> set = clips.get(clip.getType());
+	public Magazine findMagazine(ItemStack magazine) {
+		if (magazine == null) return null;
+		Set<Magazine> set = magazines.get(magazine.getType());
 		if (set == null) return null;
 		// TODO: Can we do better?
-		for (Clip sclip : set) {
-			if (sclip.isClip(clip)) {
-				return sclip;
+		for (Magazine smag : set) {
+			if (smag.isMagazine(magazine)) {
+				return smag;
 			}
 		}
 		return null;
 	}
 
 	/**
-	 * Using the provided name, gets the clip, or null.
-	 * @param name the name of the clip
-	 * @return the Clip or null if no match
+	 * Using the provided name, gets the magazine, or null.
+	 * @param name the name of the magazine
+	 * @return the Magazine or null if no match
 	 */
-	public Clip getClip(String name) {
-		return clipMap.get(name);
+	public Magazine getMagazine(String name) {
+		return magazineMap.get(name);
 	}
 
 	/**
-	 * Using the provided loretag, gets the clip, or null.
+	 * Using the provided loretag, gets the magazine, or null.
 	 * 
-	 * @param tag the loretag of the clip
-	 * @return the Clip or null if no match
+	 * @param tag the loretag of the magazine
+	 * @return the Magazine or null if no match
 	 */
-	public Clip getClipByTag(String tag) {
-		return clipTagMap.get(tag);
+	public Magazine getMagazineByTag(String tag) {
+		return magazineTagMap.get(tag);
 	}
 
 	/**
-	 * Returns a representation of all the clips configured by names
+	 * Returns a representation of all the magazines configured by names
 	 * 
-	 * @return a set of clip names
+	 * @return a set of magazine names
 	 */
-	public Set<String> allClipNames() {
-		return clipMap.keySet();
+	public Set<String> allMagazineNames() {
+		return magazineMap.keySet();
 	}
 
 	/**
@@ -186,7 +186,7 @@ public Set<String> allBulletNames() {
 	 * 
 	 */
 	@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
-	public void interactClipEvent(InventoryClickEvent event) {
+	public void interactMagazineEvent(InventoryClickEvent event) {
 		if (!(InventoryAction.SWAP_WITH_CURSOR.equals(event.getAction()) || 
 				InventoryAction.PICKUP_ALL.equals(event.getAction()) || 
 				InventoryAction.PICKUP_HALF.equals(event.getAction()) || 
@@ -200,39 +200,39 @@ public void interactClipEvent(InventoryClickEvent event) {
 		ItemStack current = event.getCurrentItem();
 		ItemStack cursor = event.getCursor();
 
-		Clip currentClip = findClip(current);
-		if (currentClip == null) return;
+		Magazine currentMag = findMagazine(current);
+		if (currentMag == null) return;
 
 		Bullet cursorBullet = null;
 
 		if (cursor != null && !Material.AIR.equals(cursor.getType())) {
 			cursorBullet = findBullet(cursor);
 			if (cursorBullet != null) {
 				// load / swap event.
-				ItemStack[] outcome = currentClip.loadClip(current, cursorBullet, cursor.getAmount());
+				ItemStack[] outcome = currentMag.loadMagazine(current, cursorBullet, cursor.getAmount());
 
-				LoadClipEvent clipEvent = new LoadClipEvent(currentClip, cursorBullet, cursor.getAmount(), event.getWhoClicked());
-				Bukkit.getServer().getPluginManager().callEvent(clipEvent);
-				if (clipEvent.isCancelled()) return;
+				LoadMagazineEvent magEvent = new LoadMagazineEvent(currentMag, cursorBullet, cursor.getAmount(), event.getWhoClicked());
+				Bukkit.getServer().getPluginManager().callEvent(magEvent);
+				if (magEvent.isCancelled()) return;
 
 				event.setCurrentItem(outcome[0]);
 				event.setCursor(outcome[1]); // why tf is this deprecated?!
 				event.setResult(Result.DENY);
 			}
 		} else {
 			// unload event.
-			ItemStack[] outcome = currentClip.unloadClip(current);
+			ItemStack[] outcome = currentMag.unloadMagazine(current);
 			event.setCurrentItem(outcome[0]);
 			event.setCursor(outcome[1]); // why tf is this deprecated?!
 			event.setResult(Result.DENY);
 		}
 	}
 
 	/**
-	 * Quick check if there are any clips registered
+	 * Quick check if there are any magazines registered
 	 * @return true if yes, otherwise false
 	 */
-	public boolean hasClips() {
-		return !this.clipMap.isEmpty();
+	public boolean hasMagazines() {
+		return !this.magazineMap.isEmpty();
 	}
 }