- Added documentation to some classes

- Created script provider system
- Did some refactoring to improve the API
This commit is contained in:
Stan Hebben committed 2014-06-10 21:12:55 +02:00
1 parent 38b78ce305
commit 97c7f42400
50 files changed
+1311 -318

No files matched your search

@@ -0,0 +1,56 @@
/*
* To change this license header, choose License Headers in Project Properties.
* To change this template file, choose Tools | Templates
* and open the template in the editor.
*/
package minetweaker.runtime;
import java.io.Closeable;
import java.util.List;
import minetweaker.IUndoableAction;
import minetweaker.minecraft.item.IIngredient;
import stanhebben.zenscript.annotations.ZenClass;
import stanhebben.zenscript.annotations.ZenMethod;
/**
*
* @author Stan
*/
@ZenClass("minetweaker.MineTweaker")
public interface IMineTweaker {
/**
* Executes a specified MineTweaker action. Will print a log message and
* adds the action to the undo list.
*
* @param action action to execute
*/
public void apply(IUndoableAction action);
/**
* Removes a specific item from all known recipes handlers.
*
* @param items items to remove
*/
@ZenMethod
public void remove(IIngredient items);
/**
* Rolls back all actions performed by MineTweaker. Returns the list of
* actions that could not be rolled back (the "stuck" ones that are not
* undoable).
*
* @return stuck action list
*/
public List<IUndoableAction> rollback();
/**
* Registers a script provider.
*
* @param provider
* @return
*/
public Closeable registerScriptProvider(IScriptProvider provider);
public void load();
}