Move some base classes into the API

Add Javadocs for API classes that didn't already have them

Redo

'nother redo

Another redo

Update ItemSigil.java

Last one, I swear

Fix
This commit is contained in:
Arcaratus 2016-03-22 21:10:05 -04:00
parent 6a40dbab0a
commit 0383f0fb31
41 changed files with 331 additions and 343 deletions

View file

@ -14,10 +14,16 @@ public class BoundToolEvent extends Event
this.player = player;
}
/**
* This event is called when a {@link WayofTime.bloodmagic.item.ItemBoundTool}
* is being charged.
*
* If canceled, will result in the charging being canceled.
*/
@Cancelable
public static class Charge extends BoundToolEvent
{
public ItemStack result;
public Charge(EntityPlayer player, ItemStack result)
@ -27,10 +33,16 @@ public class BoundToolEvent extends Event
}
}
/**
* This event is called when a {@link WayofTime.bloodmagic.item.ItemBoundTool}'s
* charge is released.
*
* If canceled, will result in the charge not being released.
*/
@Cancelable
public static class Release extends BoundToolEvent
{
public final ItemStack boundTool;
public int charge;

View file

@ -12,6 +12,18 @@ public class ItemBindEvent extends Event
public String key;
public ItemStack itemStack;
/**
* This event is called whenever a player attempts to bind a {@link WayofTime.bloodmagic.api.iface.IBindable} item.
*
* @param player
* The player doing the binding
* @param key
* The UUID of the player doing the binding
* @param itemStack
* The {@link ItemStack} that the player is binding
*
* This event is {@link Cancelable}.<br>
*/
public ItemBindEvent(EntityPlayer player, String key, ItemStack itemStack)
{
super();

View file

@ -55,7 +55,6 @@ public class RitualEvent extends Event
@Cancelable
public static class RitualRunEvent extends RitualEvent
{
public RitualRunEvent(IMasterRitualStone mrs, String owner, Ritual ritual)
{
super(mrs, owner, ritual);

View file

@ -1,6 +1,7 @@
package WayofTime.bloodmagic.api.event;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event;
@ -13,6 +14,23 @@ public class SacrificeKnifeUsedEvent extends Event
public boolean shouldDrainHealth;
public boolean shouldFillAltar;
/**
* This event is called whenever a player attempts to use a {@link WayofTime.bloodmagic.item.ItemSacrificialDagger}
* to self-sacrifice near an altar.
*
* @param player
* The player doing the sacrificing
* @param shouldDrainHealth
* Determines whether or not health is lost
* @param shouldFillAltar
* Determines whether or not an altar should be filled
* @param hp
* Amount of health lost
* @param lpAdded
* Amount of LP added to the altar
*
* This event is {@link Cancelable}.<br>
*/
public SacrificeKnifeUsedEvent(EntityPlayer player, boolean shouldDrainHealth, boolean shouldFillAltar, int hp, int lpAdded)
{
this.player = player;

View file

@ -5,21 +5,32 @@ import net.minecraft.item.ItemStack;
import net.minecraftforge.fml.common.eventhandler.Cancelable;
import net.minecraftforge.fml.common.eventhandler.Event;
/**
* Base event class for Soul Network related events.
*
* {@link #ownerUUID} contains the owner's UUID
* {@link #syphon} contains the amount of LP to be drained
*/
public class SoulNetworkEvent extends Event
{
public final String ownerName;
public final String ownerUUID;
public int syphon;
public SoulNetworkEvent(String ownerName, int syphon)
public SoulNetworkEvent(String ownerUUID, int syphon)
{
this.ownerName = ownerName;
this.ownerUUID = ownerUUID;
this.syphon = syphon;
}
/**
* This event is called when an {@link WayofTime.bloodmagic.api.impl.ItemBindable}
* is being drained inside of a {@link net.minecraft.tileentity.TileEntity}.
*
* If canceled, the drain will not be executed.
*/
@Cancelable
public static class ItemDrainInContainerEvent extends SoulNetworkEvent
{
public ItemStack stack;
public ItemDrainInContainerEvent(ItemStack stack, String ownerName, int syphon)
@ -29,10 +40,15 @@ public class SoulNetworkEvent extends Event
}
}
/**
* This event is called when a {@link EntityPlayer}
* drains the Soul Network
*
* If canceled, the drain will not be executed.
*/
@Cancelable
public static class PlayerDrainNetworkEvent extends SoulNetworkEvent
{
public final EntityPlayer player;
// If true, will damage regardless of if the network had enough inside it
public boolean shouldDamage;
@ -48,7 +64,6 @@ public class SoulNetworkEvent extends Event
@Cancelable
public static class ItemDrainNetworkEvent extends PlayerDrainNetworkEvent
{
public final ItemStack itemStack;
/**
* Amount of damage that would incur if the network could not drain