Update some docs, 1.0.1 done

This commit is contained in:
Raoul Van den Berge
2016-09-13 16:18:20 +02:00
parent 430de5f1a1
commit cbfdf1ef17
8 changed files with 11 additions and 10 deletions

View File

@@ -4,6 +4,7 @@ import javax.annotation.Nullable;
/** /**
* A registry that stores crafting task factories. * A registry that stores crafting task factories.
* Implement this for adding custom crafting tasks.
*/ */
public interface ICraftingTaskRegistry { public interface ICraftingTaskRegistry {
/** /**

View File

@@ -169,7 +169,7 @@ public interface INetworkMaster {
* *
* @param stack the stack prototype to insert, do NOT modify * @param stack the stack prototype to insert, do NOT modify
* @param size the amount of that prototype that has to be inserted * @param size the amount of that prototype that has to be inserted
* @param simulate if we are simulating * @param simulate true if we are simulating, false otherwise
* @return null if the insert was successful, or a stack with the remainder * @return null if the insert was successful, or a stack with the remainder
*/ */
@Nullable @Nullable
@@ -191,7 +191,7 @@ public interface INetworkMaster {
* *
* @param stack the stack prototype to insert, do NOT modify * @param stack the stack prototype to insert, do NOT modify
* @param size the amount of that prototype that has to be inserted * @param size the amount of that prototype that has to be inserted
* @param simulate if we are simulating * @param simulate true if we are simulating, false otherwise
* @return null if the insert was successful, or a stack with the remainder * @return null if the insert was successful, or a stack with the remainder
*/ */
@Nullable @Nullable

View File

@@ -13,7 +13,7 @@ public interface IFluidGridHandler {
* Called when a player tries to extract a fluid from the grid. * Called when a player tries to extract a fluid from the grid.
* *
* @param hash the hash of the fluid we're trying to extract, see {@link refinedstorage.api.network.NetworkUtils#getFluidStackHashCode(net.minecraftforge.fluids.FluidStack)} * @param hash the hash of the fluid we're trying to extract, see {@link refinedstorage.api.network.NetworkUtils#getFluidStackHashCode(net.minecraftforge.fluids.FluidStack)}
* @param shift if shift click was used * @param shift true if shift click was used, false otherwise
* @param player the player that is attempting the extraction * @param player the player that is attempting the extraction
*/ */
void onExtract(int hash, boolean shift, EntityPlayerMP player); void onExtract(int hash, boolean shift, EntityPlayerMP player);

View File

@@ -36,7 +36,7 @@ public interface IItemGridHandler {
* Called when a player is trying to insert an item that it is holding in their hand in the GUI. * Called when a player is trying to insert an item that it is holding in their hand in the GUI.
* *
* @param player the player that is attempting the insert * @param player the player that is attempting the insert
* @param single if we are only inserting a single item * @param single true if we are only inserting a single item, false otherwise
*/ */
void onInsertHeldItem(EntityPlayerMP player, boolean single); void onInsertHeldItem(EntityPlayerMP player, boolean single);
@@ -52,7 +52,7 @@ public interface IItemGridHandler {
* Called when a player wants to cancel a crafting task. * Called when a player wants to cancel a crafting task.
* *
* @param id the task id, or -1 to cancel all tasks * @param id the task id, or -1 to cancel all tasks
* @param depth the child depth of this task to cancel * @param depth the depth to cancel. 0 to cancel the entire task, or n to cancel the nth child of the task
*/ */
void onCraftingCancelRequested(int id, int depth); void onCraftingCancelRequested(int id, int depth);
} }

View File

@@ -21,13 +21,13 @@ public interface ISoldererRegistry {
* Returns a solderer recipe from the rows. * Returns a solderer recipe from the rows.
* *
* @param rows an item handler, where slots 0 - 2 are the rows * @param rows an item handler, where slots 0 - 2 are the rows
* @return the {@link ISoldererRecipe}, or null if no recipe was found * @return the recipe, or null if no recipe was found
*/ */
@Nullable @Nullable
ISoldererRecipe getRecipe(@Nonnull IItemHandler rows); ISoldererRecipe getRecipe(@Nonnull IItemHandler rows);
/** /**
* @return a list with all the solderer recipes, do NOT modify * @return a list with all the solderer recipes
*/ */
List<ISoldererRecipe> getRecipes(); List<ISoldererRecipe> getRecipes();
} }

View File

@@ -6,7 +6,7 @@ import net.minecraftforge.oredict.OreDictionary;
import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.ArrayUtils;
/** /**
* Utilities for comparing. * Utilities for comparing item and fluid stacks.
*/ */
public final class CompareUtils { public final class CompareUtils {
public static final int COMPARE_DAMAGE = 1; public static final int COMPARE_DAMAGE = 1;

View File

@@ -22,7 +22,7 @@ public interface IFluidStorage {
* *
* @param stack the fluid prototype to insert, do NOT modify * @param stack the fluid prototype to insert, do NOT modify
* @param size the amount of that prototype that has to be inserted * @param size the amount of that prototype that has to be inserted
* @param simulate if we are simulating * @param simulate true if we are simulating, false otherwise
* @return null if the insert was successful, or a stack with the remainder * @return null if the insert was successful, or a stack with the remainder
*/ */
@Nullable @Nullable

View File

@@ -22,7 +22,7 @@ public interface IItemStorage {
* *
* @param stack the stack prototype to insert, do NOT modify * @param stack the stack prototype to insert, do NOT modify
* @param size the amount of that prototype that has to be inserted * @param size the amount of that prototype that has to be inserted
* @param simulate if we are simulating * @param simulate true if we are simulating, false otherwise
* @return null if the insert was successful, or a stack with the remainder * @return null if the insert was successful, or a stack with the remainder
*/ */
@Nullable @Nullable