Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.

build.xml

@@ -53,9 +53,21 @@
       <arg value="src/docs/js/generateApiDocs.js"/>
       <arg value="${dist}/js"/>
     </java>
-
+    <java classname="jscript" failonerror="true" fork="true" output="${dist}/items.md" error="${dist}/genitemserror.log">
+      <classpath>
+        <pathelement path="${build}"/>      
+	<pathelement path="lib/canary.jar"/>
+      </classpath>
+      <arg value="src/docs/js/generateItemsDoc.js"/>
+    </java>
+    <concat destfile="${dist}/apiref-con.md">
+      <fileset file="${dist}/apiref.md" />
+      <fileset file="${dist}/items.md" />
+    </concat>
   </target>
 
+
+
   <target name="gen-events-helper-canary" depends="compile-docs,init">
     <mkdir dir="${dist}/js/lib"/>
     <java classname="jscript" failonerror="true" fork="true" output="${dist}/js/lib/events-helper.js" error="${dist}/geneventserror.log">
@@ -99,7 +111,7 @@ Walter Higgins
 
       </header>
       <fileset file="${dist}/toc-apiref.md" />
-      <fileset file="${dist}/apiref.md" />
+      <fileset file="${dist}/apiref-con.md" />
    </concat>      
   </target>
 
@@ -109,7 +121,7 @@ Walter Higgins
         <pathelement path="${build}"/>      
       </classpath>
       <arg value="src/docs/js/generateTOC.js"/>
-      <arg value="${dist}/apiref.md"/>
+      <arg value="${dist}/apiref-con.md"/>
     </java>
   </target>
 

src/docs/js/generateApiDocs.js

@@ -1,27 +1,15 @@
 /*
  This script is run at build time to generate api.md - a single Markdown document containing documentation for ScriptCraft's API
-*/
-var err = java.lang.System.err;
-
-args = Array.prototype.slice.call(args,1);
-
-if (typeof importPackage == 'undefined'){
-    // load compatibility script
-    load('nashorn:mozilla_compat.js');
-}
-var dir = args[0];
-var foreach = function(array, func){
+ */
+function foreach(array, func){
   for (var i =0; i < array.length; i++){
     func(array[i],i,array);
   }
-};
-
-importPackage(java.io);
+}
 /*
  find - a (very) basic implementation of the unix command line tool.
-*/
-var find = function(dir,store,re) 
-{
+ */
+function find(dir,store,re) {
   var files = dir.listFiles();
   foreach (files, function(filename){
     filename = "" + filename;
@@ -35,13 +23,13 @@ var find = function(dir,store,re)
         store.push(filename);
     }
   });
-};
+}
 /*
  the main module file for a given directory
  (assuming the main module is in a file with the same name as the parent 
  directory) - e.g. drone/drone.js 
-*/
-var sorter = function( precedence ){
+ */
+function sorter( precedence ){
   return function(a,b)
   {
     // convert from Java string to JS string
@@ -86,8 +74,8 @@ var sorter = function( precedence ){
       return result;
     }
   };
-};
-var sortByModule = function(a,b)
+}
+function sortByModule(a,b)
 {
   var aparts = (''+a).split(/\//);
   var bparts = (''+b).split(/\//);
@@ -105,7 +93,22 @@ var sortByModule = function(a,b)
     return -1;
   else
     return 1;
-};
+}
+
+
+var err = java.lang.System.err;
+
+args = Array.prototype.slice.call(args,1);
+
+if (typeof importPackage == 'undefined'){
+  // load compatibility script
+  load('nashorn:mozilla_compat.js');
+}
+var dir = args[0];
+
+
+importPackage(java.io);
+
 var store = [];
 find(new File(dir),store,/\/[a-zA-Z0-9_\-]+\.js$/);
 

src/docs/js/generateItemsDoc.js

@@ -0,0 +1,45 @@
+args = Array.prototype.slice.call(args,1);
+// [0] = type, [1] = lib.jar [2] = blockX, [3] = classX
+var out = java.lang.System.out,
+  err = java.lang.System.err,
+  entry = null;
+var content = [
+  '/*********************',
+  '## Items module',
+  'The Items module provides a suite of functions - one for each possible item.',
+  'See https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/api/inventory/ItemType.html for a list of possible items',
+  '',
+  '### Usage',
+  '',
+  '    items.book(); // returns net.canarymod.api.inventory.ItemType.Book',
+  '    items.book(2); // returns a new net.canarymod.api.inventory.Item object with an amount 2 (2 books)',
+  '    items.book( itemType ); // compares itemType parameter to ItemType.Book or an Item of type book',
+  '',
+  'The following functions are provided:',
+  ''
+];
+
+//var ItemType = java.lang.Class.forName('net.canarymod.api.inventory.ItemType');
+var ItemType = Packages.net.canarymod.api.inventory.ItemType;
+var materials = ItemType.class.getDeclaredFields();
+
+var enumVals = [];
+for (var i = 0;i < materials.length; i++ ){
+
+  if (materials[i].type != ItemType.class) {
+    continue;
+  }
+  var materialField = materials[i];
+  var name = (''+materialField.name).replace(/^(.)/,function(a){ return a.toLowerCase() });
+  enumVals.push(' * ' + name + '()');
+}
+enumVals.sort();
+content = content.concat(enumVals);
+content.push('');
+content.push('***/');
+for (var i = 0; i< content.length; i++){
+  out.println(content[i]);
+}
+
+
+  

src/main/java/canary/org/scriptcraftjs/canarymod/ScriptCraftPlugin.java

@@ -16,6 +16,9 @@ import net.canarymod.commandsys.Command;
 import net.canarymod.commandsys.TabComplete;
 import net.canarymod.chat.MessageReceiver;
 import net.canarymod.Canary;
+import net.canarymod.api.inventory.recipes.CraftingRecipe;
+import net.canarymod.api.inventory.recipes.RecipeRow;
+import net.canarymod.api.inventory.Item;
 
 public class ScriptCraftPlugin extends Plugin implements PluginListener, CommandListener
 {
@@ -57,7 +60,14 @@ public class ScriptCraftPlugin extends Plugin implements PluginListener, Command
         }
         return true;
     }
-
+    public CraftingRecipe makeShapedRecipe(Item resultingItem, RecipeRow... rows){
+        CraftingRecipe result = new CraftingRecipe(resultingItem, rows);
+        return result;
+    }
+    public CraftingRecipe makeShapelessRecipe(Item resultingItem, Item... items){
+        CraftingRecipe result = new CraftingRecipe(resultingItem, items);
+        return result;
+    }
     static class ScriptCraftTask extends ServerTask {
         private Runnable runnable = null;
         public ScriptCraftTask(Runnable runnable, TaskOwner owner, long delay, boolean continuous){
@@ -97,7 +107,7 @@ public class ScriptCraftPlugin extends Plugin implements PluginListener, Command
     @Command(
              aliases = { "js" },
              description = "Execute Javascript code",
-	     permissions = { "canary.super.js", "canary.command.super.js" },
+             permissions = { "scriptcraft.evaluate", "*" },
              toolTip = "/js javascript expression")
              public void jsCommand(MessageReceiver sender, String[] args) {
 
@@ -110,7 +120,7 @@ public class ScriptCraftPlugin extends Plugin implements PluginListener, Command
     @Command(
              aliases = { "jsp" },
              description = "Run javascript-provided command",
-	     permissions = { "canary.jsp", "canary.command.jsp" },
+             permissions = { "" },
              toolTip = "/jsp command")
              public void jspCommand(MessageReceiver sender, String[] args) {
 

src/main/js/lib/scriptcraft.js

@@ -678,7 +678,7 @@ function __onEnable ( __engine, __plugin, __script ) {
   configFile = new File(configFile,'global-config.json');
   var config = _load( configFile );
   if ( !config ) {
-    config = { verbose: true };
+    config = { verbose: false };
   }
   global.config = config;
   global.__plugin = __plugin;

src/main/js/modules/bukkit/recipes.js

@@ -0,0 +1,15 @@
+var items = require('items');
+var bkShapedRecipe = org.bukkit.inventory.ShapedRecipe;
+
+exports.add = function( recipe ){
+  var result = new bkShapedRecipe( recipe.result );
+  result.shape( recipe.shape );
+  for (var i in recipe.ingredients ){
+    result.setIngredient( i, recipe.ingredients[i] );
+  }
+  server.addRecipe(result);
+  return result;
+};
+exports.remove = function( recipe ) {
+  server.removeRecipe(recipe);
+};

src/main/js/modules/canary/recipes.js

@@ -0,0 +1,36 @@
+var cm = Packages.net.canarymod;
+var cmRecipe = cm.api.inventory.recipes.CraftingRecipe;
+var cmRecipeRow = cm.api.inventory.recipes.RecipeRow;
+
+function addRecipe( recipe ){
+  if (!recipe){
+    return null;
+  }
+  var result,
+    rows,
+    i,j,
+    cells,
+    rr;
+  if (recipe.shape){
+    rows = [];
+    for (i = 0; i < recipe.shape.length; i++){
+      cells = recipe.shape[i].split('');
+      rr = [];
+      for ( j = 0; j < cells.length ; j++){
+	if (cells[j] != ' '){
+	  rr.push(recipe.ingredients[cells[j]]);
+	}
+      }
+      rows.push( new cmRecipeRow(recipe.shape[i], rr) );
+    }
+    result = __plugin.makeShapedRecipe( recipe.result, rows);
+  } else { 
+    result = __plugin.makeShapelessRecipe( recipe.result, recipe.ingredients );
+  }
+  return result;
+}
+function removeRecipe( recipe ){
+  server.removeRecipe( recipe );
+}
+exports.add = addRecipe;
+exports.remove = removeRecipe;

src/main/js/modules/recipes.js

@@ -0,0 +1,32 @@
+/*************************************************************************
+## The recipes module
+
+The Recipes module provides convenience functions for adding and removing recipes
+from the game.
+
+### Example
+To add an EnderBow to the game (assumes there's an enchanted Item variable called enderBow)...
+
+    var recipes = require('recipes');
+    var items = require('items');
+    ...
+    var enderBowRecipe = recipes.add( {
+      result: enderBow,
+      ingredients: {
+        E: items.enderPearl(1),
+        S: items.stick(1),
+        W: items.string(1)
+      },
+      shape: [ 'ESW',
+               'SEW',
+               'ESW' ]
+    } );
+    // to remove...
+    recipes.remove( enderBowRecipe );
+
+***/
+if (__plugin.canary) {
+  module.exports = require('./canary/recipes');
+} else {
+  module.exports = require('./bukkit/recipes');
+}

src/main/js/modules/utils/utils.js

@@ -746,6 +746,16 @@ exports.array = function( ){
   }
   return result;
 };
+/*************************************************************************
+### utils.players() function
+
+This function returns a javascript array of all online players on the server.
+
+### utils.playerNames() function
+
+This function returns a javascript array of player names (as javascript strings)
+
+***/
 function getPlayersBukkit(){
   var result = [];
   for (var i = 0; i < server.onlinePlayers.length; i++){
@@ -761,6 +771,13 @@ function getPlayersCanary(){
   }
   return result;
 }
+var getPlayers = null;
+if (__plugin.canary) {
+  getPlayers = getPlayersCanary;
+} else {
+  getPlayers = getPlayersBukkit;
+}
+
 function getStatBukkit(player, stat){
   return player.getStatistic(org.bukkit.Statistic[stat.toUpperCase()]);
 }
@@ -768,7 +785,12 @@ function getStatCanary(player, stat){
   var cmStatistics = Packages.net.canarymod.api.statistics.Statistics;
   return player.getStat(cmStatistics[stat.toUpperCase()].instance);
 }
-exports.players = __plugin.canary ? getPlayersCanary: getPlayersBukkit;
+function getPlayerNames(){
+  return getPlayers().map(function(p){ return p.name; });
+}
+exports.players = getPlayers;
+exports.playerNames = getPlayerNames;
+
 /*************************************************************************
 ### utils.stat() function