swapping canarymod 1.7.10-1.1.3 for 1.8.0-1.2.0 and added contrib notes to top of generated docs

2015-01-11 00:11:44 +00:00 · 2015-01-11 00:11:44 +00:00 · ecc2d91ea2
commit ecc2d91ea2
parent c21be34609
4 changed files with 126 additions and 45 deletions
--- a/build.xml
+++ b/build.xml
@ -11,8 +11,7 @@
  <property name="src.bukkit" location="src/main/java/bukkit"/>

  <!-- compiles against these libraries -->
-  <property name="lib.canary" location="lib/CanaryMod-1.7.10-1.1.3-SNAPSHOT-shaded.jar"/>
-  <!-- property name="lib.bukkit" location="lib/bukkit-1.7.9-R0.2.jar"/ -->
+  <property name="lib.canary" location="lib/CanaryMod-1.8.0-1.2.0-SNAPSHOT-shaded.jar"/>
  <property name="lib.bukkit" location="lib/bukkit-1.7.10-R0.1-SNAPSHOT.jar"/>

  <property name="build" location="target/classes"/>
@ -127,7 +126,13 @@
  <target name="construct-api-ref" depends="gen-toc-apiref,init">

    <concat destfile="docs/API-Reference.md">
-      <header filtering="no" trimleading="yes"># ScriptCraft API Reference
+      <header filtering="no" trimleading="yes">&lt;!-- 
+IMPORTANT NOTE FOR CONTRIBUTORS
+-------------------------------
+Contributors: This file is generated from comments in javascript source files src/main/js/*
+If you would like to make changes, change the comments in the src/main/js/* files instead.
+--&gt;
+# ScriptCraft API Reference

 Walter Higgins

@ -160,7 +165,13 @@ Walter Higgins
  <!-- Piece together the Young persons' guide from template and generated table of contents -->
  <target name="construct-ypgpm" depends="gen-toc-ypgpm,init">
    <concat destfile="docs/YoungPersonsGuideToProgrammingMinecraft.md">
-      <header filtering="no" trimleading="yes"># The Young Person's Guide to Programming in Minecraft
+      <header filtering="no" trimleading="yes">&lt;!-- 
+  IMPORTANT NOTE FOR CONTRIBUTORS
+  -------------------------------
+  Contributors: This file is generated from source file src/docs/templates/ypgpm.md
+  If you would like to make changes, change file src/docs/templates/ypgpm.md instead
+--&gt;
+# The Young Person's Guide to Programming in Minecraft
      </header>
      <fileset file="${dist}/toc-ypgpm.md" />
      <fileset file="src/docs/templates/ypgpm.md" />
--- a/docs/API-Reference.md
+++ b/docs/API-Reference.md
@ -1,3 +1,9 @@
+<!-- 
+IMPORTANT NOTE FOR CONTRIBUTORS
+-------------------------------
+Contributors: This file is generated from comments in javascript source files src/main/js/*
+If you would like to make changes, change the comments in the src/main/js/* files instead.
+-->
 # ScriptCraft API Reference

 Walter Higgins
@ -77,6 +83,7 @@ Walter Higgins
   * [events.bookEdit()](#eventsbookedit)
   * [events.playerListEntry()](#eventsplayerlistentry)
   * [events.eat()](#eventseat)
+   * [events.playerList()](#eventsplayerlist)
   * [events.playerIdle()](#eventsplayeridle)
   * [events.enchant()](#eventsenchant)
   * [events.playerArmSwing()](#eventsplayerarmswing)
@ -384,6 +391,8 @@ Walter Higgins
   * [Usage (Bukkit) :](#usage-bukkit-)
 * [Utilities Module](#utilities-module)
   * [utils.player() function](#utilsplayer-function)
+   * [utils.world( worldName ) function](#utilsworld-worldname--function)
+   * [utils.blockAt( Location ) function](#utilsblockat-location--function)
   * [utils.locationToJSON() function](#utilslocationtojson-function)
   * [utils.locationToString() function](#utilslocationtostring-function)
   * [utils.locationFromJSON() function](#utilslocationfromjson-function)
@ -1234,6 +1243,14 @@ The crucial difference is that the events module now has functions for each of t

 * priority - optional - see events.on() for more information.

+### events.playerList()
+
+#### Parameters 
+
+ * callback - A function which is called whenever the [player.PlayerListHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerListHook.html) is fired
+
+ * priority - optional - see events.on() for more information.
+
 ### events.playerIdle()

 #### Parameters 
@ -4554,6 +4571,14 @@ if ( player ) {
 [bkpl]: http://jd.bukkit.org/dev/apidocs/org/bukkit/entity/Player.html
 [bkloc]: http://jd.bukkit.org/dev/apidocs/org/bukkit/Location.html

+### utils.world( worldName ) function
+
+Returns a World object matching the given name
+
+### utils.blockAt( Location ) function
+
+Returns the Block at the given location.
+
 ### utils.locationToJSON() function

 utils.locationToJSON() returns a [org.bukkit.Location][bkloc] object in JSON form...
@ -5599,30 +5624,37 @@ See https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/api/in

 The following functions are provided:

+ * acaciaDoor()
+ * acaciaFence()
+ * acaciaFenceGate()
 * acaciaLeaves()
 * acaciaLog()
 * acaciaSapling()
 * acaciaStairs()
 * acaciaWood()
- * acaciaWoodDoubleStep()
- * acaciaWoodStep()
+ * acaciaWoodSlab()
 * activatorRail()
 * allium()
+ * andesite()
 * anvil()
 * apple()
+ * armorStand()
 * arrow()
 * azureBluet()
 * bakedPotato()
+ * banner()
 * beacon()
 * bed()
 * bedrock()
+ * birchDoor()
+ * birchFence()
+ * birchFenceGate()
 * birchLeaves()
 * birchLog()
 * birchSapling()
 * birchWood()
- * birchWoodDoubleStep()
- * birchWoodStair()
- * birchWoodStep()
+ * birchWoodSlab()
+ * birchWoodStairs()
 * blackCarpet()
 * blackGlass()
 * blackGlassPane()
@ -5647,7 +5679,8 @@ The following functions are provided:
 * bread()
 * brewingStand()
 * brickBlock()
- * brickStair()
+ * brickSlab()
+ * brickStairs()
 * brownCarpet()
 * brownGlass()
 * brownGlassPane()
@ -5676,9 +5709,11 @@ The following functions are provided:
 * coal()
 * coalBlock()
 * coalOre()
+ * coarseDirt()
 * cobble()
 * cobbleSilverFishBlock()
- * cobbleStair()
+ * cobbleSlab()
+ * cobbleStairs()
 * cobblestoneWall()
 * cocoaBeans()
 * cocoaPlant()
@ -5687,7 +5722,9 @@ The following functions are provided:
 * cookedChicken()
 * cookedClownFish()
 * cookedFish()
+ * cookedMutton()
 * cookedPufferFish()
+ * cookedRabbit()
 * cookedSalmon()
 * cookie()
 * crackedSilverFishBlock()
@ -5699,13 +5736,15 @@ The following functions are provided:
 * cyanGlassPane()
 * cyanStainedClay()
 * dandelionYellow()
+ * darkOakDoor()
+ * darkOakFence()
+ * darkOakFenceGate()
 * darkOakLeaves()
 * darkOakLog()
 * darkOakSapling()
 * darkOakStairs()
 * darkOakWood()
- * darkOakWoodDoubleStep()
- * darkOakWoodStep()
+ * darkOakWoodSlab()
 * daylightSensor()
 * deadBush()
 * detectorRail()
@ -5722,19 +5761,27 @@ The following functions are provided:
 * diamondPickaxe()
 * diamondSpade()
 * diamondSword()
+ * diorite()
 * dirt()
 * dispenser()
+ * doubleAcaciaWoodSlab()
+ * doubleBirchWoodSlab()
+ * doubleBrickBlockSlab()
+ * doubleCobbleSlab()
+ * doubleDarkOakWoodSlab()
 * doubleGrass()
- * doublestepBrickBlock()
- * doublestepCobble()
- * doublestepNetherBrick()
- * doublestepOrnateStone()
- * doublestepQuartz()
- * doublestepSandStone()
- * doublestepSandStoneTrim()
- * doublestepStone()
- * doublestepStoneBricks()
- * doublestepWood()
+ * doubleJungleWoodSlab()
+ * doubleNetherBrickSlab()
+ * doubleOakWoodSlab()
+ * doubleOrnateStoneSlab()
+ * doubleQuartzSlab()
+ * doubleRedSandstoneSlab()
+ * doubleSandStoneTrimSlab()
+ * doubleSandstoneSlab()
+ * doubleSpruceWoodSlab()
+ * doubleStoneBricksSlab()
+ * doubleStoneSlab()
+ * doubleWoodSlab()
 * dropper()
 * egg()
 * elevenRecord()
@ -5789,6 +5836,7 @@ The following functions are provided:
 * goldSword()
 * goldenApple()
 * goldenCarrot()
+ * granite()
 * grass()
 * gravel()
 * grayCarpet()
@ -5830,13 +5878,15 @@ The following functions are provided:
 * itemFrame()
 * jackOLantern()
 * jukebox()
+ * jungleDoor()
+ * jungleFence()
+ * jungleFenceGate()
 * jungleLeaves()
 * jungleLog()
 * jungleSapling()
 * jungleWood()
- * jungleWoodDoubleStep()
- * jungleWoodStair()
- * jungleWoodStep()
+ * jungleWoodSlab()
+ * jungleWoodStairs()
 * ladder()
 * lapisBlock()
 * lapisLazuli()
@ -5897,8 +5947,9 @@ The following functions are provided:
 * nameTag()
 * netherBrick()
 * netherBrickFence()
- * netherBrickStair()
+ * netherBrickStairs()
 * netherBricks()
+ * netherBricksSlab()
 * netherQuartz()
 * netherQuartzOre()
 * netherStar()
@ -5909,8 +5960,7 @@ The following functions are provided:
 * oakLog()
 * oakSapling()
 * oakWood()
- * oakWoodDoubleStep()
- * oakWoodStep()
+ * oakWoodSlab()
 * obsidian()
 * orangeCarpet()
 * orangeDye()
@ -5921,6 +5971,7 @@ The following functions are provided:
 * ornateQuartzBlock()
 * ornateSilverFishBlock()
 * ornateStoneBrick()
+ * ornateStoneSlab()
 * oxeyeDaisy()
 * packedIce()
 * painting()
@ -5928,7 +5979,7 @@ The following functions are provided:
 * peony()
 * pineLeaves()
 * pineLog()
- * pineWoodStair()
+ * pineWoodStairs()
 * pinkCarpet()
 * pinkDye()
 * pinkGlass()
@ -5938,6 +5989,9 @@ The following functions are provided:
 * piston()
 * podzol()
 * poisonousPotato()
+ * polishedAndesite()
+ * polishedDiorite()
+ * polishedGranite()
 * poppy()
 * pork()
 * portal()
@ -5946,6 +6000,8 @@ The following functions are provided:
 * potion()
 * poweredMinecart()
 * poweredRail()
+ * prismarineCrystals()
+ * prismarineShard()
 * pufferFish()
 * pumpkin()
 * pumpkinPie()
@ -5959,16 +6015,27 @@ The following functions are provided:
 * quartzPillarCap()
 * quartzPillarHorizontal()
 * quartzPillarVertical()
+ * quartzSlab()
 * quartzStairs()
+ * rabbitFoot()
+ * rabbitHide()
+ * rabbitStew()
 * rail()
 * rawBeef()
 * rawChicken()
 * rawFish()
+ * rawMutton()
+ * rawRabbit()
 * rawSalmon()
 * redCarpet()
 * redGlass()
 * redGlassPane()
 * redMushroom()
+ * redSandstone()
+ * redSandstoneBlank()
+ * redSandstoneOrnate()
+ * redSandstoneSlab()
+ * redSandstoneStairs()
 * redStainedClay()
 * redStone()
 * redTulip()
@ -5984,10 +6051,12 @@ The following functions are provided:
 * rottenFlesh()
 * saddle()
 * sand()
+ * sandStoneTrimSlab()
 * sandstone()
 * sandstoneBlank()
 * sandstoneOrnate()
- * sandstoneStair()
+ * sandstoneSlab()
+ * sandstoneStairs()
 * seeds()
 * shears()
 * shrub()
@ -6003,34 +6072,28 @@ The following functions are provided:
 * spiderEye()
 * spiderWeb()
 * sponge()
+ * spruceDoor()
+ * spruceFence()
+ * spruceFenceGate()
 * spruceSapling()
 * spruceWood()
- * spruceWoodDoubleStep()
- * spruceWoodStep()
+ * spruceWoodSlab()
 * stalRecord()
 * steak()
- * stepBrickBlock()
- * stepCobble()
- * stepNetherBricks()
- * stepOrnateStone()
- * stepQuartz()
- * stepSandStone()
- * stepSandStoneTrim()
- * stepStone()
- * stepStoneBricks()
- * stepWood()
 * stick()
 * stickyPiston()
 * stone()
 * stoneAxe()
 * stoneBrick()
 * stoneBrickSilverFishBlock()
- * stoneBrickStair()
+ * stoneBrickStairs()
+ * stoneBricksSlab()
 * stoneButton()
 * stoneHoe()
 * stonePickaxe()
 * stonePlate()
 * stoneSilverFishBlock()
+ * stoneSlab()
 * stoneSpade()
 * stoneSword()
 * storageMinecart()
@ -6064,10 +6127,11 @@ The following functions are provided:
 * woodHoe()
 * woodPickaxe()
 * woodPlate()
+ * woodSlab()
 * woodSpade()
 * woodSword()
 * woodenButton()
- * woodenStair()
+ * woodenStairs()
 * woolBlack()
 * woolBlue()
 * woolBrown()
--- a/docs/YoungPersonsGuideToProgrammingMinecraft.md
+++ b/docs/YoungPersonsGuideToProgrammingMinecraft.md
@ -1,3 +1,9 @@
+<!-- 
+IMPORTANT NOTE FOR CONTRIBUTORS
+-------------------------------
+Contributors: This file is generated from source file src/docs/templates/ypgpm.md
+If you would like to make changes, change file src/docs/templates/ypgpm.md instead
+-->
 # The Young Person's Guide to Programming in Minecraft
 ## Table of Contents
 * [Introduction](#introduction)
--- a/lib/CanaryMod-1.7.10-1.1.3-SNAPSHOT-shaded.jar
+++ b/lib/CanaryMod-1.7.10-1.1.3-SNAPSHOT-shaded.jar