From c7330d3124aebd822e120a75f0dc40b0a1ff10a3 Mon Sep 17 00:00:00 2001 From: makeo Date: Tue, 20 Oct 2015 16:25:35 +0200 Subject: [PATCH] Added some comments to api and removed setupGolemInventory --- .../makeo/gadomancy/api/ClickBehavior.java | 6 +++++ .../api/golems/AdditionalGolemType.java | 8 +++--- .../api/golems/cores/AdditionalGolemCore.java | 26 +++++++++++++++++-- .../golems/nbt/ExtendedGolemProperties.java | 1 - .../common/registration/RegisteredBlocks.java | 1 + 5 files changed, 35 insertions(+), 7 deletions(-) diff --git a/src/main/java/makeo/gadomancy/api/ClickBehavior.java b/src/main/java/makeo/gadomancy/api/ClickBehavior.java index 22e4bf8..7eb2e96 100644 --- a/src/main/java/makeo/gadomancy/api/ClickBehavior.java +++ b/src/main/java/makeo/gadomancy/api/ClickBehavior.java @@ -26,6 +26,9 @@ public abstract class ClickBehavior { this(false); } + /** + * This method is called by me to init all variables + */ @Deprecated public void init(World world, Block block, int x, int y, int z, int metadata) { this.world = world; @@ -36,6 +39,9 @@ public abstract class ClickBehavior { this.metadata = metadata; } + /** + * @return if this class needs to handle the given block + */ public abstract boolean isValidForBlock(); public boolean hasVisCost() { diff --git a/src/main/java/makeo/gadomancy/api/golems/AdditionalGolemType.java b/src/main/java/makeo/gadomancy/api/golems/AdditionalGolemType.java index 91b0879..558fb1d 100644 --- a/src/main/java/makeo/gadomancy/api/golems/AdditionalGolemType.java +++ b/src/main/java/makeo/gadomancy/api/golems/AdditionalGolemType.java @@ -45,13 +45,13 @@ public abstract class AdditionalGolemType { public abstract void registerIcons(IIconRegister ir); public abstract IIcon getIcon(ItemStack stack, int pass); - public void setupGolem() { - - } - public int getRenderPasses() { return 1; } public abstract ResourceLocation getEntityTexture(); + + /** + * @return resource location for the golem inventory slot texture + */ public abstract ResourceLocation getInvSlotTexture(); public EnumGolemType getEnumEntry() { diff --git a/src/main/java/makeo/gadomancy/api/golems/cores/AdditionalGolemCore.java b/src/main/java/makeo/gadomancy/api/golems/cores/AdditionalGolemCore.java index 40d46c9..274f430 100644 --- a/src/main/java/makeo/gadomancy/api/golems/cores/AdditionalGolemCore.java +++ b/src/main/java/makeo/gadomancy/api/golems/cores/AdditionalGolemCore.java @@ -15,20 +15,39 @@ import thaumcraft.common.entities.golems.EntityGolemBase; public abstract class AdditionalGolemCore { private String name; + /** + * Init your AI stuff here + * @param golem the golem entity + */ public abstract void setupGolem(EntityGolemBase golem); - public void setupGolemInventory(EntityGolemBase golem) { } - + /** + * @return If the golem has a gui + */ public abstract boolean hasGui(); + /** + * @return the core that is used to define some basic behaviors of the golem e.g. guard core: mob selection + */ public byte getBaseCore() { return 1; } + /** + * Open custom a gui here + * Only called if hasGui is true + * @param player player entity + * @param golem golem entity + * @return false -> open default gui true -> no gui + */ public boolean openGui(EntityPlayer player, EntityGolemBase golem) { return false; } + /** + * @param golem + * @return the held tool item of a golem e.g. fishing rod + */ public ItemStack getToolItem(EntityGolemBase golem) { return null; } @@ -39,6 +58,9 @@ public abstract class AdditionalGolemCore { public abstract String getUnlocalizedName(); + /** + * @return the item that is used as a core + */ public abstract ItemStack getItem(); public String getName() { diff --git a/src/main/java/makeo/gadomancy/common/entities/golems/nbt/ExtendedGolemProperties.java b/src/main/java/makeo/gadomancy/common/entities/golems/nbt/ExtendedGolemProperties.java index 3e094d1..6598b07 100644 --- a/src/main/java/makeo/gadomancy/common/entities/golems/nbt/ExtendedGolemProperties.java +++ b/src/main/java/makeo/gadomancy/common/entities/golems/nbt/ExtendedGolemProperties.java @@ -128,7 +128,6 @@ public class ExtendedGolemProperties implements IExtendedEntityProperties { golem.targetTasks.taskEntries.clear(); core.setupGolem(golem); - core.setupGolemInventory(golem); wrapper.lock(); } diff --git a/src/main/java/makeo/gadomancy/common/registration/RegisteredBlocks.java b/src/main/java/makeo/gadomancy/common/registration/RegisteredBlocks.java index 9b93617..e990c8a 100644 --- a/src/main/java/makeo/gadomancy/common/registration/RegisteredBlocks.java +++ b/src/main/java/makeo/gadomancy/common/registration/RegisteredBlocks.java @@ -2,6 +2,7 @@ package makeo.gadomancy.common.registration; import cpw.mods.fml.common.registry.GameRegistry; import makeo.gadomancy.api.ClickBehavior; +import makeo.gadomancy.api.GadomancyApi; import makeo.gadomancy.common.blocks.BlockArcaneDropper; import makeo.gadomancy.common.blocks.BlockInfusionClaw; import makeo.gadomancy.common.blocks.BlockRemoteJar;