Startup

I hope I'm doing this right...

2 files changed, 378 insertions, 0 deletions

diff --git a/src/api/java/morph/api/Ability.java b/src/api/java/morph/api/Ability.java
new file mode 100644
index 0000000..36a75e9
--- /dev/null
+++ b/src/api/java/morph/api/Ability.java
@@ -0,0 +1,208 @@
+package morph.api;
+
+import net.minecraft.entity.EntityLivingBase;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.util.ResourceLocation;
+import cpw.mods.fml.relauncher.Side;
+import cpw.mods.fml.relauncher.SideOnly;
+
+/**
+ * 
+ * Abstract ability class.
+ * Think of it like the Entity class, extend it to make your own types.
+ * Some abilities may seem more like traits, but let's just call it an ability for simplicity's sake.
+ * Please take note that entities inherit their superclass' abilities.
+ * @author iChun
+ *
+ */
+public abstract class Ability 
+{
+	/**
+	 * Ability parent field. Will be null for instances used in registration. Ability is then cloned and parent assigned later on.
+	 */
+	private EntityLivingBase parent;
+
+    /**
+     * Flag for Ability activity. If true, tick/postRender/kill will notbe called.
+     */
+    public boolean inactive;
+	
+	/**
+	 * Basic constructor (but you didn't really need me to tell you that ;D )
+	 */
+	public Ability()
+	{
+		parent = null;
+	}
+	
+	/**
+	 * Function for mod mob support, with args.
+	 */
+	public Ability parse(String[] args) { return this; }
+	
+	/**
+	 * Since parent is private it needs a setter.
+	 * @param newParent
+	 */
+	public void setParent(EntityLivingBase ent)
+	{
+		parent = ent;
+	}
+	
+	/**
+	 * Get's the parent entity for this ability
+	 * @return Entity the ability takes effect on
+	 */
+	public EntityLivingBase getParent()
+	{
+		return parent;
+	}
+	
+	/**
+	 * Each ability has to return a String type.
+	 * This is used for comparison, saving, as well as construction/loading of Ability.
+	 * Think of it like the way Minecraft registers entities.
+	 * @return Ability type
+	 */
+	public abstract String getType();
+	
+	/**
+	 * Ticks every world tick, basically an ability onUpdate, similar to Entity's onUpdate.
+	 * Will only tick if getParent() is not null.
+	 * Please remember that getParent is not necessarily a player.
+	 */
+	public abstract void tick();
+	
+	/**
+	 * Called when the ability is finally removed when the parent demorphs or morphs into a state that does not have this ability type.
+	 * This will NOT be called if the parent morphs into another morph that has this type of ability.
+	 */
+	public abstract void kill();
+	
+	/**
+	 * Creates a copy of this ability for use with parents.
+	 * As previously stated before the ability instance used during registration is a base so it needs to be cloned for use with parents.
+	 */
+	public abstract Ability clone();
+
+    /**
+     * Return true for this if you need an inactive copy of this morph in-between morph states (abilities of the next morph are only swapped over when morph is complete)
+     * Currently used for AbilitySwim to adjust the fog render.
+     * @return requiresInactiveClone
+     */
+    public boolean requiresInactiveClone()
+    {
+        return false;
+    }
+	
+	/**
+	 * Saving of ability to NBTTagCompound. 
+	 * Mainly used for synching Abilities between the client-server for mod mobs which do not use the API to add abilities.
+	 * The ability type (getType()) is appended to nbt before function is called.
+     * Not actually used.
+	 * @param NBTTagCompound saveData
+	 */
+	public abstract void save(NBTTagCompound tag);
+	
+	/**
+	 * Loading of ability from NBTTagCompound.
+	 * Mainly used to load custom fields from NBT.
+     * Not actually used.
+	 * @param NBTTagCompound saveData
+	 */
+	public abstract void load(NBTTagCompound tag);
+	
+	/**
+	 * Rendering to be done post-render.
+	 * EG: Used by AbilitySwim to render air bubbles whilst on land.
+	 */
+	@SideOnly(Side.CLIENT)
+	public abstract void postRender();
+	
+	/**
+	 * Icon location for ability. Can be null.
+	 * Mod's default icons are 32x32. Can be any resolution though.
+	 * @return resourcelocation for icon
+	 */
+	@SideOnly(Side.CLIENT)
+	public abstract ResourceLocation getIcon();
+	
+	@SideOnly(Side.CLIENT)
+	public boolean entityHasAbility(EntityLivingBase living)
+	{
+		return true;
+	}
+	
+	/**
+	 * Registers the ability so the mod can look up the class when attempting to load Ability save data.
+	 * Call this no later than PostInit.
+	 * @param ability type
+	 * @param AbilityClass
+	 */
+	public static void registerAbility(String name, Class<? extends Ability> clz)
+	{
+		try {
+			Class.forName("morph.common.ability.AbilityHandler").getDeclaredMethod("registerAbility", String.class, Class.class).invoke(null, name, clz);
+		} catch (Exception e) {
+		}
+	}
+
+	/**
+	 * Maps abilities to an Entity.
+	 * Adds on to the previous ability list, so this allows you to add abilities to Entity classes which already have abilities mapped.
+	 * However, only one ability of the same type is allowed for each entity. This method will overwrite abilities of the same type that were already mapped.
+	 * This will also register new abilities which were not registered before (just in case).
+	 * Call this no later than PostInit.
+	 * @param entClass
+	 * @param abilities
+	 */
+	public static void mapAbilities(Class<? extends EntityLivingBase> entClass, Ability...abilities)
+	{
+		try {
+			Class.forName("morph.common.ability.AbilityHandler").getDeclaredMethod("mapAbilities", Class.class, Ability[].class).invoke(null, entClass, abilities);
+		} catch (Exception e) {
+		}
+	}
+	
+	/**
+	 * Superman's kryptonite.
+	 * @param Entity class to remove ability from
+	 * @param Ability type
+	 */
+	public static void removeAbility(Class<? extends EntityLivingBase> entClass, String type)
+	{
+		try {
+			Class.forName("morph.common.ability.AbilityHandler").getDeclaredMethod("removeAbility", Class.class, String.class).invoke(null, entClass, type);
+		} catch (Exception e) {
+		}
+	}
+	
+	/**
+	 * Checks to see if the entity class has a mapped ability type.
+	 * @param entClass
+	 * @param Ability type
+	 * @return Entity class has ability type
+	 */
+	public static boolean hasAbility(Class<? extends EntityLivingBase> entClass, String type)
+	{
+		try {
+			return (Boolean)Class.forName("morph.common.ability.AbilityHandler").getDeclaredMethod("hasAbility", Class.class, String.class).invoke(null, entClass, type);
+		} catch (Exception e) {
+			return false;
+		}
+	}
+	
+	/**
+	 * Creates an ability by type.
+     * Check out AbilityHandler to see each Ability type and the parse function in their respective classes for the arguments.
+	 * @return
+	 */
+    public static Ability createNewAbilityByType(String type, String[] arguments)
+    {
+        try {
+            return (Ability)Class.forName("morph.common.ability.AbilityHandler").getDeclaredMethod("createNewAbilityByType", String.class, String[].class).invoke(null, type, arguments);
+        } catch (Exception e) {
+            return null;
+        }
+    }
+}
diff --git a/src/api/java/morph/api/Api.java b/src/api/java/morph/api/Api.java
new file mode 100644
index 0000000..1cfb49d
--- /dev/null
+++ b/src/api/java/morph/api/Api.java
@@ -0,0 +1,170 @@
+package morph.api;
+
+import net.minecraft.client.entity.AbstractClientPlayer;
+import net.minecraft.client.model.ModelBase;
+import net.minecraft.client.model.ModelRenderer;
+import net.minecraft.entity.EntityLivingBase;
+import net.minecraft.entity.player.EntityPlayerMP;
+import net.minecraft.util.ResourceLocation;
+import cpw.mods.fml.relauncher.Side;
+import cpw.mods.fml.relauncher.SideOnly;
+
+public final class Api 
+{
+	/**
+	 * Returns if a player is has a morph. If morph progress < 1.0F, player is mid-morphing.
+	 * Players demorphing are considered as a player with a morph until the demorph is complete.
+	 * @param Player Username
+	 * @param Clientside (false for Serverside)
+	 */
+	public static boolean hasMorph(String playerName, boolean isClient)
+	{
+		try {
+			return (Boolean)Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("hasMorph", String.class, boolean.class).invoke(null, playerName, isClient);
+		} catch (Exception e) {
+			return false;
+		}
+	}
+	
+	/**
+	 * Returns morph progression of a player. Time per morph is 80 ticks.
+	 * If player does not have a morph, 1.0F will be returned.
+	 * @param Player Username
+	 * @param Clientside (false for Serverside)
+	 */
+	public static float morphProgress(String playerName, boolean isClient)
+	{
+		try {
+			return (Float)Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("morphProgress", String.class, boolean.class).invoke(null, playerName, isClient);
+		} catch (Exception e) {
+			return 1.0F;
+		}
+	}
+	
+	/**
+	 * Returns previous entity instance used to render the morph.
+	 * If player does not have a previous morph state, null will be returned.
+	 * @param Player Username
+	 * @param Clientside (false for Serverside)
+	 */
+	public static EntityLivingBase getPrevMorphEntity(String playerName, boolean isClient)
+	{
+		try {
+			return (EntityLivingBase)Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("getPrevMorphEntity", String.class, boolean.class).invoke(null, playerName, isClient);
+		} catch (Exception e) {
+			return null;
+		}
+	}
+
+	/**
+	 * Returns entity instance used to render the morph.
+	 * If player does not have a morph, null will be returned.
+	 * @param Player Username
+	 * @param Clientside (false for Serverside)
+	 */
+	public static EntityLivingBase getMorphEntity(String playerName, boolean isClient)
+	{
+		try {
+			return (EntityLivingBase)Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("getMorphEntity", String.class, boolean.class).invoke(null, playerName, isClient);
+		} catch (Exception e) {
+			return null;
+		}
+	}
+	
+	/**
+	 * Blacklists an entity from being morphed into.
+	 * Previously saved morphs of the classtype will not be removed.
+	 * @param Class (extends EntityLivingBase)
+	 */
+	public static void blacklistEntity(Class<? extends EntityLivingBase> clz)
+	{
+		try {
+			Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("blacklistEntity", Class.class).invoke(null, clz);
+		} catch (Exception e) {
+		}
+	}
+	
+	/**
+	 * Forces a player to morph into an EntityLivingBase, also adds said entity to the morph list.
+	 * Called Serverside only.
+	 * @param player
+	 * @param living
+	 * @return morphSuccessful
+	 */
+	public static boolean forceMorph(EntityPlayerMP player, EntityLivingBase living)
+	{
+		try {
+			return (Boolean)Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("forceMorph", EntityPlayerMP.class, EntityLivingBase.class).invoke(null, player, living);
+		} catch (Exception e) {
+			return false;
+		}
+	}
+	
+	/**
+	 * Forces a player to demorph.
+	 * Called Serverside only.
+	 * @param player
+	 */
+	public static void forceDemorph(EntityPlayerMP player)
+	{
+		try {
+			Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("forceDemorph", EntityPlayerMP.class).invoke(null, player);
+		} catch (Exception e) {
+		}
+	}
+	
+	/**
+	 * Checks if the entity passed on is a Morph.
+	 * If it is, the player name will be passed, else null.
+	 * @param EntityLivingBase instance
+	 * @param Clientside (false for Serverside)
+	 */
+	public static String isEntityAMorph(EntityLivingBase living, boolean isClient)
+	{
+		try {
+			return (String)Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("isEntityAMorph", EntityLivingBase.class, boolean.class).invoke(null, living, isClient);
+		} catch (Exception e) {
+			return null;
+		}
+	}
+	
+	/**
+	 * Allows the rendering of the next player rendered.
+	 * Prevents Morph from cancelling the player render event to render the morphed entity.
+	 */
+	public static void allowNextPlayerRender()
+	{
+		try {
+			Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("allowNextPlayerRender").invoke(null);
+		} catch (Exception e) {
+		}
+	}
+	
+	/**
+	 * Returns the black grainy morph skin that overlays the player when the player is morphing
+	 * @return Morph Skin Resource Location
+	 */
+	@SideOnly(Side.CLIENT)
+	public static ResourceLocation getMorphSkinTexture()
+	{
+		try {
+			return (ResourceLocation)Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("getMorphSkinTexture").invoke(null);
+		} catch (Exception e) {
+			return AbstractClientPlayer.locationStevePng;
+		}
+	}
+
+    /**
+     * Assign a specific arm to a model for rendering in First Person.
+     * @param model Model which arm you are registering for
+     * @param arm The arm in a ModelRenderer form.
+     */
+    @SideOnly(Side.CLIENT)
+    public static void registerArmForModel(ModelBase model, ModelRenderer arm)
+    {
+        try {
+            Class.forName("morph.common.core.ApiHandler").getDeclaredMethod("registerArmForModel", ModelBase.class, ModelRenderer.class).invoke(null, model, arm);
+        } catch (Exception e) {
+        }
+    }
+}