arg/scriptcraft
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
This repository has been archived on 2021-07-14. You can view files and clone it, but cannot push or open issues or pull requests.
scriptcraft/docs/API-Reference.md

6187 lines
213 KiB
Markdown
Raw Normal View History

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 01:11:44 +01:00
<!--
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.
-->
updating docs for module release
2013-12-24 23:47:57 +01:00
# ScriptCraft API Reference
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
Walter Higgins
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
[walter.higgins@gmail.com][email]
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
[email]: mailto:walter.higgins@gmail.com?subject=ScriptCraft_API_Reference
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Table of Contents
* [Modules in Scriptcraft](#modules-in-scriptcraft)
* [Module Loading](#module-loading)
* [The plugins directory](#the-plugins-directory)
* [The modules directory](#the-modules-directory)
* [The lib directory](#the-lib-directory)
* [plugins sub-directories](#plugins-sub-directories)
* [Global variables](#global-variables)
fix links
2014-01-04 21:23:17 +01:00
* [__plugin variable](#__plugin-variable)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [server variable](#server-variable)
* [self variable](#self-variable)
* [config variable](#config-variable)
* [events variable](#events-variable)
* [Module variables](#module-variables)
fix links
2014-01-04 21:23:17 +01:00
* [&#95;&#95;filename variable](#__filename-variable)
* [&#95;&#95;dirname variable](#__dirname-variable)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [Global functions](#global-functions)
* [echo function](#echo-function)
* [require() function](#require-function)
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
* [scload() function](#scload-function)
* [scsave() function](#scsave-function)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [plugin() function](#plugin-function)
* [command() function](#command-function)
* [setTimeout() function](#settimeout-function)
* [clearTimeout() function](#cleartimeout-function)
* [setInterval() function](#setinterval-function)
* [clearInterval() function](#clearinterval-function)
* [refresh() function](#refresh-function)
* [addUnloadHandler() function](#addunloadhandler-function)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [isOp() function](#isop-function)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [require - Node.js-style module loading in ScriptCraft](#require---nodejs-style-module-loading-in-scriptcraft)
* [math.js](#mathjs)
* [inc.js](#incjs)
* [program.js](#programjs)
* [Important](#important)
* [module name resolution](#module-name-resolution)
* [events Module](#events-module)
* [events.on() static method](#eventson-static-method)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [Events Helper Module (canary version)](#events-helper-module-canary-version)
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
* [Usage](#usage)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.minecartActivate()](#eventsminecartactivate)
* [events.villagerTradeUnlock()](#eventsvillagertradeunlock)
* [events.mobTarget()](#eventsmobtarget)
* [events.chickenLayEgg()](#eventschickenlayegg)
* [events.potionEffectFinish()](#eventspotioneffectfinish)
* [events.entityMove()](#eventsentitymove)
* [events.hangingEntityDestroy()](#eventshangingentitydestroy)
* [events.vehicleCollision()](#eventsvehiclecollision)
* [events.potionEffectApplied()](#eventspotioneffectapplied)
* [events.vehicleDestroy()](#eventsvehicledestroy)
* [events.vehicleEnter()](#eventsvehicleenter)
* [events.damage()](#eventsdamage)
* [events.entityMount()](#eventsentitymount)
* [events.slimeSplit()](#eventsslimesplit)
* [events.endermanDropBlock()](#eventsendermandropblock)
* [events.itemTouchGround()](#eventsitemtouchground)
* [events.entitySpawn()](#eventsentityspawn)
* [events.endermanPickupBlock()](#eventsendermanpickupblock)
* [events.vehicleDamage()](#eventsvehicledamage)
* [events.entityLightningStruck()](#eventsentitylightningstruck)
* [events.entityDespawn()](#eventsentitydespawn)
* [events.vehicleMove()](#eventsvehiclemove)
* [events.projectileHit()](#eventsprojectilehit)
* [events.entityDeath()](#eventsentitydeath)
* [events.entityTame()](#eventsentitytame)
* [events.vehicleExit()](#eventsvehicleexit)
* [events.dimensionSwitch()](#eventsdimensionswitch)
* [events.foodLevel()](#eventsfoodlevel)
* [events.bookEdit()](#eventsbookedit)
* [events.playerListEntry()](#eventsplayerlistentry)
* [events.eat()](#eventseat)
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 01:11:44 +01:00
* [events.playerList()](#eventsplayerlist)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.playerIdle()](#eventsplayeridle)
* [events.enchant()](#eventsenchant)
* [events.playerArmSwing()](#eventsplayerarmswing)
* [events.teleport()](#eventsteleport)
* [events.anvilUse()](#eventsanviluse)
* [events.portalUse()](#eventsportaluse)
* [events.foodSaturation()](#eventsfoodsaturation)
* [events.connection()](#eventsconnection)
* [events.playerRespawned()](#eventsplayerrespawned)
* [events.armorBroken()](#eventsarmorbroken)
* [events.levelUp()](#eventslevelup)
* [events.blockRightClick()](#eventsblockrightclick)
* [events.itemDrop()](#eventsitemdrop)
* [events.playerRespawning()](#eventsplayerrespawning)
* [events.craft()](#eventscraft)
* [events.experience()](#eventsexperience)
* [events.signChange()](#eventssignchange)
* [events.healthChange()](#eventshealthchange)
* [events.disconnection()](#eventsdisconnection)
* [events.gameModeChange()](#eventsgamemodechange)
* [events.preConnection()](#eventspreconnection)
* [events.villagerTrade()](#eventsvillagertrade)
* [events.returnFromIdle()](#eventsreturnfromidle)
* [events.slotClick()](#eventsslotclick)
* [events.entityRightClick()](#eventsentityrightclick)
* [events.foodExhaustion()](#eventsfoodexhaustion)
* [events.chat()](#eventschat)
* [events.itemPickup()](#eventsitempickup)
* [events.bedExit()](#eventsbedexit)
* [events.blockPlace()](#eventsblockplace)
* [events.toolBroken()](#eventstoolbroken)
* [events.kick()](#eventskick)
* [events.playerDeath()](#eventsplayerdeath)
* [events.blockLeftClick()](#eventsblockleftclick)
* [events.blockDestroy()](#eventsblockdestroy)
* [events.bedEnter()](#eventsbedenter)
* [events.signShow()](#eventssignshow)
* [events.inventory()](#eventsinventory)
* [events.playerMove()](#eventsplayermove)
* [events.itemUse()](#eventsitemuse)
* [events.ban()](#eventsban)
* [events.statGained()](#eventsstatgained)
* [events.smeltBegin()](#eventssmeltbegin)
* [events.treeGrow()](#eventstreegrow)
* [events.chunkCreated()](#eventschunkcreated)
* [events.liquidDestroy()](#eventsliquiddestroy)
* [events.chunkLoaded()](#eventschunkloaded)
* [events.pistonRetract()](#eventspistonretract)
* [events.smelt()](#eventssmelt)
* [events.blockUpdate()](#eventsblockupdate)
* [events.portalDestroy()](#eventsportaldestroy)
* [events.ignition()](#eventsignition)
* [events.redstoneChange()](#eventsredstonechange)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.weatherChange()](#eventsweatherchange)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.chunkCreation()](#eventschunkcreation)
* [events.hopperTransfer()](#eventshoppertransfer)
* [events.chunkUnload()](#eventschunkunload)
* [events.blockGrow()](#eventsblockgrow)
* [events.dispense()](#eventsdispense)
* [events.blockDropXp()](#eventsblockdropxp)
* [events.fireworkExplode()](#eventsfireworkexplode)
* [events.leafDecay()](#eventsleafdecay)
* [events.pistonExtend()](#eventspistonextend)
* [events.noteBlockPlay()](#eventsnoteblockplay)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.lightningStrike()](#eventslightningstrike)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.decorate()](#eventsdecorate)
* [events.explosion()](#eventsexplosion)
* [events.tNTActivate()](#eventstntactivate)
* [events.timeChange()](#eventstimechange)
* [events.flow()](#eventsflow)
* [events.portalCreate()](#eventsportalcreate)
* [events.blockPhysics()](#eventsblockphysics)
* [events.playerCommand()](#eventsplayercommand)
* [events.consoleCommand()](#eventsconsolecommand)
* [events.commandBlockCommand()](#eventscommandblockcommand)
* [events.loadWorld()](#eventsloadworld)
* [events.permissionCheck()](#eventspermissioncheck)
* [events.serverGuiStart()](#eventsserverguistart)
* [events.unloadWorld()](#eventsunloadworld)
* [events.pluginDisable()](#eventsplugindisable)
* [events.pluginEnable()](#eventspluginenable)
* [events.serverTick()](#eventsservertick)
* [events.serverListPing()](#eventsserverlistping)
* [events.serverShutdown()](#eventsservershutdown)
* [Events Helper Module (bukkit version)](#events-helper-module-bukkit-version)
* [Usage](#usage-1)
* [events.weatherChange()](#eventsweatherchange-1)
* [events.lightningStrike()](#eventslightningstrike-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.thunderChange()](#eventsthunderchange)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.vehicleMove()](#eventsvehiclemove-1)
* [events.vehicleDestroy()](#eventsvehicledestroy-1)
* [events.vehicleExit()](#eventsvehicleexit-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.vehicleEntityCollision()](#eventsvehicleentitycollision)
* [events.vehicleBlockCollision()](#eventsvehicleblockcollision)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.vehicleEnter()](#eventsvehicleenter-1)
* [events.vehicleDamage()](#eventsvehicledamage-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.vehicleUpdate()](#eventsvehicleupdate)
* [events.vehicleCreate()](#eventsvehiclecreate)
* [events.paintingBreak()](#eventspaintingbreak)
* [events.paintingBreakByEntity()](#eventspaintingbreakbyentity)
* [events.paintingPlace()](#eventspaintingplace)
* [events.enchantItem()](#eventsenchantitem)
* [events.prepareItemEnchant()](#eventsprepareitemenchant)
* [events.playerInteractEntity()](#eventsplayerinteractentity)
* [events.playerEggThrow()](#eventsplayereggthrow)
* [events.playerUnleashEntity()](#eventsplayerunleashentity)
* [events.playerInventory()](#eventsplayerinventory)
* [events.playerLevelChange()](#eventsplayerlevelchange)
* [events.playerPortal()](#eventsplayerportal)
* [events.playerItemConsume()](#eventsplayeritemconsume)
* [events.playerTeleport()](#eventsplayerteleport)
* [events.playerBedEnter()](#eventsplayerbedenter)
* [events.playerUnregisterChannel()](#eventsplayerunregisterchannel)
* [events.playerChat()](#eventsplayerchat)
* [events.playerShearEntity()](#eventsplayershearentity)
* [events.asyncPlayerChat()](#eventsasyncplayerchat)
* [events.playerDropItem()](#eventsplayerdropitem)
* [events.playerRegisterChannel()](#eventsplayerregisterchannel)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.playerMove()](#eventsplayermove-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.playerItemBreak()](#eventsplayeritembreak)
* [events.playerBucketEmpty()](#eventsplayerbucketempty)
* [events.playerStatisticIncrement()](#eventsplayerstatisticincrement)
* [events.playerToggleFlight()](#eventsplayertoggleflight)
* [events.playerItemHeld()](#eventsplayeritemheld)
* [events.playerAchievementAwarded()](#eventsplayerachievementawarded)
* [events.playerToggleSneak()](#eventsplayertogglesneak)
* [events.playerExpChange()](#eventsplayerexpchange)
* [events.playerPreLogin()](#eventsplayerprelogin)
* [events.playerJoin()](#eventsplayerjoin)
* [events.playerAnimation()](#eventsplayeranimation)
* [events.playerEditBook()](#eventsplayereditbook)
* [events.playerPickupItem()](#eventsplayerpickupitem)
* [events.playerChangedWorld()](#eventsplayerchangedworld)
* [events.playerFish()](#eventsplayerfish)
* [events.playerChatTabComplete()](#eventsplayerchattabcomplete)
* [events.playerRespawn()](#eventsplayerrespawn)
* [events.playerBedLeave()](#eventsplayerbedleave)
* [events.asyncPlayerPreLogin()](#eventsasyncplayerprelogin)
* [events.playerInteract()](#eventsplayerinteract)
* [events.playerBucketFill()](#eventsplayerbucketfill)
* [events.playerVelocity()](#eventsplayervelocity)
* [events.playerQuit()](#eventsplayerquit)
* [events.playerLogin()](#eventsplayerlogin)
* [events.playerKick()](#eventsplayerkick)
* [events.playerToggleSprint()](#eventsplayertogglesprint)
* [events.playerCommandPreprocess()](#eventsplayercommandpreprocess)
* [events.playerGameModeChange()](#eventsplayergamemodechange)
* [events.furnaceSmelt()](#eventsfurnacesmelt)
* [events.inventoryDrag()](#eventsinventorydrag)
* [events.craftItem()](#eventscraftitem)
* [events.furnaceBurn()](#eventsfurnaceburn)
* [events.inventoryOpen()](#eventsinventoryopen)
* [events.inventoryPickupItem()](#eventsinventorypickupitem)
* [events.inventoryMoveItem()](#eventsinventorymoveitem)
* [events.inventoryClick()](#eventsinventoryclick)
* [events.inventoryClose()](#eventsinventoryclose)
* [events.inventoryCreative()](#eventsinventorycreative)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.inventory()](#eventsinventory-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.prepareItemCraft()](#eventsprepareitemcraft)
* [events.furnaceExtract()](#eventsfurnaceextract)
* [events.brew()](#eventsbrew)
* [events.serverCommand()](#eventsservercommand)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.serverListPing()](#eventsserverlistping-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.serviceRegister()](#eventsserviceregister)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.pluginDisable()](#eventsplugindisable-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.remoteServerCommand()](#eventsremoteservercommand)
* [events.mapInitialize()](#eventsmapinitialize)
* [events.serviceUnregister()](#eventsserviceunregister)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.pluginEnable()](#eventspluginenable-1)
* [events.playerDeath()](#eventsplayerdeath-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.entityCreatePortal()](#eventsentitycreateportal)
* [events.entityCombust()](#eventsentitycombust)
* [events.sheepDyeWool()](#eventssheepdyewool)
* [events.expBottle()](#eventsexpbottle)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.entityTame()](#eventsentitytame-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.projectileLaunch()](#eventsprojectilelaunch)
* [events.entityDamage()](#eventsentitydamage)
* [events.itemSpawn()](#eventsitemspawn)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.projectileHit()](#eventsprojectilehit-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.foodLevelChange()](#eventsfoodlevelchange)
* [events.itemDespawn()](#eventsitemdespawn)
* [events.entityPortalEnter()](#eventsentityportalenter)
* [events.entityPortal()](#eventsentityportal)
* [events.entityTarget()](#eventsentitytarget)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.entityDeath()](#eventsentitydeath-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.sheepRegrowWool()](#eventssheepregrowwool)
* [events.entityShootBow()](#eventsentityshootbow)
* [events.creeperPower()](#eventscreeperpower)
* [events.entityCombustByBlock()](#eventsentitycombustbyblock)
* [events.entityBreakDoor()](#eventsentitybreakdoor)
* [events.entityDamageByEntity()](#eventsentitydamagebyentity)
* [events.entityUnleash()](#eventsentityunleash)
* [events.entityExplode()](#eventsentityexplode)
* [events.entityInteract()](#eventsentityinteract)
* [events.explosionPrime()](#eventsexplosionprime)
* [events.horseJump()](#eventshorsejump)
* [events.creatureSpawn()](#eventscreaturespawn)
* [events.entityCombustByEntity()](#eventsentitycombustbyentity)
* [events.entityDamageByBlock()](#eventsentitydamagebyblock)
* [events.entityTargetLivingEntity()](#eventsentitytargetlivingentity)
* [events.entityTeleport()](#eventsentityteleport)
* [events.playerLeashEntity()](#eventsplayerleashentity)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.slimeSplit()](#eventsslimesplit-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.pigZap()](#eventspigzap)
* [events.potionSplash()](#eventspotionsplash)
* [events.entityChangeBlock()](#eventsentitychangeblock)
* [events.entityPortalExit()](#eventsentityportalexit)
* [events.entityRegainHealth()](#eventsentityregainhealth)
* [events.entityBlockForm()](#eventsentityblockform)
* [events.blockSpread()](#eventsblockspread)
* [events.blockMultiPlace()](#eventsblockmultiplace)
* [events.notePlay()](#eventsnoteplay)
* [events.blockFade()](#eventsblockfade)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.blockPlace()](#eventsblockplace-1)
* [events.blockPhysics()](#eventsblockphysics-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.blockIgnite()](#eventsblockignite)
* [events.blockBreak()](#eventsblockbreak)
* [events.blockBurn()](#eventsblockburn)
* [events.blockFromTo()](#eventsblockfromto)
* [events.blockRedstone()](#eventsblockredstone)
* [events.blockPistonRetract()](#eventsblockpistonretract)
* [events.blockDispense()](#eventsblockdispense)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.signChange()](#eventssignchange-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.blockPistonExtend()](#eventsblockpistonextend)
* [events.blockCanBuild()](#eventsblockcanbuild)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.blockGrow()](#eventsblockgrow-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.leavesDecay()](#eventsleavesdecay)
* [events.blockExp()](#eventsblockexp)
* [events.blockForm()](#eventsblockform)
* [events.blockDamage()](#eventsblockdamage)
* [events.hangingPlace()](#eventshangingplace)
* [events.hangingBreakByEntity()](#eventshangingbreakbyentity)
* [events.hangingBreak()](#eventshangingbreak)
* [events.structureGrow()](#eventsstructuregrow)
* [events.spawnChange()](#eventsspawnchange)
* [events.worldLoad()](#eventsworldload)
* [events.worldInit()](#eventsworldinit)
* [events.worldUnload()](#eventsworldunload)
* [events.worldSave()](#eventsworldsave)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.chunkUnload()](#eventschunkunload-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.chunkPopulate()](#eventschunkpopulate)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [events.portalCreate()](#eventsportalcreate-1)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [events.chunkLoad()](#eventschunkload)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [console global variable](#console-global-variable)
* [Example](#example)
* [Using string substitutions](#using-string-substitutions)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [Drone Plugin](#drone-plugin)
* [Constructing a Drone Object](#constructing-a-drone-object)
* [Drone.box() method](#dronebox-method)
* [Drone.box0() method](#dronebox0-method)
* [Drone.boxa() method](#droneboxa-method)
* [Chaining](#chaining)
* [Drone Properties](#drone-properties)
* [Extending Drone](#extending-drone)
* [Drone.extend() static method](#droneextend-static-method)
* [Drone Constants](#drone-constants)
* [Drone.times() Method](#dronetimes-method)
including api
2014-12-28 16:07:32 +01:00
* [Drone.arc() method](#dronearc-method)
Adding documentation for bed() method.
2015-01-01 13:53:11 +01:00
* [Drone.bed() method](#dronebed-method)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [Drone.blocktype() method](#droneblocktype-method)
including api
2014-12-28 16:07:32 +01:00
* [Copy & Paste using Drone](#copy--paste-using-drone)
* [Drone.copy() method](#dronecopy-method)
* [Drone.paste() method](#dronepaste-method)
* [Drone.cylinder() method](#dronecylinder-method)
* [Drone.cylinder0() method](#dronecylinder0-method)
* [Drone.door() method](#dronedoor-method)
* [Drone.door_iron() method](#dronedoor_iron-method)
* [Drone.door2() method](#dronedoor2-method)
* [Drone.door2_iron() method](#dronedoor2_iron-method)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [Drone.firework() method](#dronefirework-method)
including api
2014-12-28 16:07:32 +01:00
* [Drone.garden() method](#dronegarden-method)
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
* [Drone.ladder() method](#droneladder-method)
including api
2014-12-28 16:07:32 +01:00
* [Drone Movement](#drone-movement)
* [Drone Positional Info](#drone-positional-info)
* [Drone Markers](#drone-markers)
* [Drone.prism() method](#droneprism-method)
* [Drone.prism0() method](#droneprism0-method)
* [Drone.rand() method](#dronerand-method)
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
* [Drone.wallsign() method](#dronewallsign-method)
* [Drone.signpost() method](#dronesignpost-method)
including api
2014-12-28 16:07:32 +01:00
* [Drone.sign() method](#dronesign-method)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [Drone.sphere() method](#dronesphere-method)
* [Drone.sphere0() method](#dronesphere0-method)
* [Drone.hemisphere() method](#dronehemisphere-method)
* [Drone.hemisphere0() method](#dronehemisphere0-method)
including api
2014-12-28 16:07:32 +01:00
* [Drone.stairs() function](#dronestairs-function)
* [Drone Trees methods](#drone-trees-methods)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [Drone.rainbow() method](#dronerainbow-method)
* [Drone.spiral_stairs() method](#dronespiral_stairs-method)
* [Blocks Module](#blocks-module)
* [Examples](#examples)
* [Fireworks Module](#fireworks-module)
* [Examples](#examples-1)
* [Asynchronous Input Module](#asynchronous-input-module)
* [The recipes module](#the-recipes-module)
* [Example](#example-1)
* [Http Module](#http-module)
* [http.request() function](#httprequest-function)
* [sc-mqtt module](#sc-mqtt-module)
* [Usage](#usage-2)
* [Signs Module](#signs-module)
* [signs.menu() function](#signsmenu-function)
* [signs.getTargetedBy() function](#signsgettargetedby-function)
* [Sounds Module](#sounds-module)
* [Usage (Bukkit) :](#usage-bukkit-)
* [Utilities Module](#utilities-module)
* [utils.player() function](#utilsplayer-function)
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 01:11:44 +01:00
* [utils.world( worldName ) function](#utilsworld-worldname--function)
* [utils.blockAt( Location ) function](#utilsblockat-location--function)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [utils.locationToJSON() function](#utilslocationtojson-function)
* [utils.locationToString() function](#utilslocationtostring-function)
* [utils.locationFromJSON() function](#utilslocationfromjson-function)
* [utils.getPlayerPos() function](#utilsgetplayerpos-function)
* [utils.getMousePos() function](#utilsgetmousepos-function)
* [utils.foreach() function](#utilsforeach-function)
* [utils.nicely() function](#utilsnicely-function)
* [utils.at() function](#utilsat-function)
Fix issue #193
2015-01-11 13:27:47 +01:00
* [utils.time( world ) function](#utilstime-world--function)
* [utils.time24( world ) function](#utilstime24-world--function)
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* [utils.find() function](#utilsfind-function)
* [utils.serverAddress() function](#utilsserveraddress-function)
* [utils.watchFile() function](#utilswatchfile-function)
* [utils.watchDir() function](#utilswatchdir-function)
* [utils.unwatchFile() function](#utilsunwatchfile-function)
* [utils.unwatchDir() function](#utilsunwatchdir-function)
* [utils.array() function](#utilsarray-function)
* [utils.players() function](#utilsplayers-function)
* [utils.playerNames() function](#utilsplayernames-function)
* [utils.stat() function](#utilsstat-function)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [Example Plugin #1 - A simple extension to Minecraft.](#example-plugin-1---a-simple-extension-to-minecraft)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [Usage:](#usage-3)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Example Plugin #2 - Making extensions available for all players.](#example-plugin-2---making-extensions-available-for-all-players)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [Usage:](#usage-4)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Example Plugin #3 - Limiting use of commands to operators only.](#example-plugin-3---limiting-use-of-commands-to-operators-only)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [Usage:](#usage-5)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Example Plugin #4 - Using parameters in commands.](#example-plugin-4---using-parameters-in-commands)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [Usage:](#usage-6)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Example Plugin #5 - Re-use - Using your own and others modules.](#example-plugin-5---re-use---using-your-own-and-others-modules)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [Usage:](#usage-7)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Example Plugin #6 - Re-use - Using 'utils' to get Player objects.](#example-plugin-6---re-use---using-utils-to-get-player-objects)
* [Usage:](#usage-8)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [Example Plugin #7 - Listening for events, Greet players when they join the game.](#example-plugin-7---listening-for-events-greet-players-when-they-join-the-game)
* [Arrows Plugin](#arrows-plugin)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Usage:](#usage-9)
Fix issue #111, reorg of lib/ and (undoc'd) persistence
2014-01-12 12:26:26 +01:00
* [Spawn Plugin](#spawn-plugin)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Usage](#usage-10)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [alias Plugin](#alias-plugin)
Added java apis in js doc. Fixed toc links. save uses pretty json.
2014-01-06 21:54:53 +01:00
* [Examples](#examples-2)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
* [Classroom Plugin](#classroom-plugin)
* [classroom.allowScripting() function](#classroomallowscripting-function)
* [Commando Plugin](#commando-plugin)
* [Description](#description)
* [Example hi-command.js](#example-hi-commandjs)
* [Example - timeofday-command.js](#example---timeofday-commandjs)
* [Caveats](#caveats)
* [homes Plugin](#homes-plugin)
* [Basic options](#basic-options)
* [Social options](#social-options)
* [Administration options](#administration-options)
* [NumberGuess mini-game:](#numberguess-mini-game)
Added java apis in js doc. Fixed toc links. save uses pretty json.
2014-01-06 21:54:53 +01:00
* [Description](#description-1)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [Example](#example-2)
Fix issue #111, reorg of lib/ and (undoc'd) persistence
2014-01-12 12:26:26 +01:00
* [Cow Clicker Mini-Game](#cow-clicker-mini-game)
* [How to Play](#how-to-play)
* [Rules](#rules)
* [Gameplay Mechanics](#gameplay-mechanics)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* [Items module](#items-module)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* [Usage](#usage-11)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
## Modules in Scriptcraft
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
ScriptCraft has a simple module loading system. In ScriptCraft, files
and modules are in one-to-one correspondence. As an example, foo.js
loads the module circle.js in the same directory.
*ScriptCraft now uses the same module system as Node.js - see [Node.js Modules][njsmod] for more details.*
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
[njsmod]: http://nodejs.org/api/modules.html
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
The contents of foo.js:
improved require function
2013-12-18 00:49:00 +01:00
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
var circle = require('./circle.js');
console.log( 'The area of a circle of radius 4 is '
+ circle.area(4));
```
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
The contents of circle.js:
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
var PI = Math.PI;
exports.area = function (r) {
return PI * r * r;
};
exports.circumference = function (r) {
return 2 * PI * r;
};
```
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
The module circle.js has exported the functions area() and
circumference(). To add functions and objects to the root of your
module, you can add them to the special exports object.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
Variables local to the module will be private, as though the module
was wrapped in a function. In this example the variable PI is private
to circle.js.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
If you want the root of your module's export to be a function (such as
a constructor) or if you want to export a complete object in one
assignment instead of building it one property at a time, assign it to
module.exports instead of exports.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
## Module Loading
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
When the ScriptCraft Java plugin is first installed, a new
Removing empty lib/canary.js and removing craftbukkit references from scriptcraft.js docs
2014-12-31 12:15:28 +01:00
`scriptcraft` subdirectory is created. If your minecraft server
directory is called 'mcserver' then the new subdirectories will be ...
improved require function
2013-12-18 00:49:00 +01:00
Removing empty lib/canary.js and removing craftbukkit references from scriptcraft.js docs
2014-12-31 12:15:28 +01:00
* mcserver/scriptcraft/
* mcserver/scriptcraft/plugins
* mcserver/scriptcraft/modules
* mcserver/scriptcraft/lib
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
... The `plugins`, `modules` and `lib` directories each serve a different purpose.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### The plugins directory
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
At server startup the ScriptCraft Java plugin is loaded and begins
automatically loading and executing all of the modules (javascript
files with the extension `.js`) it finds in the `scriptcraft/plugins`
directory. All modules in the plugins directory are automatically
loaded into the `global` namespace. What this means is that anything a
module in the `plugins` directory exports becomes a global
variable. For example, if you have a module greeting.js in the plugins
directory....
improved require function
2013-12-18 00:49:00 +01:00
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
exports.greet = function(player) {
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo(player, 'Hello ' + player.name);
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
};
```
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
... then `greet` becomes a global function and can be used at the
in-game (or server) command prompt like so...
'Buddha' Release : The annihilation of 'self' variable. use of 'self' should be limited only to in-game or console commands. It should not be used in the context of a module.
2013-12-30 22:33:12 +01:00
/js greet(self)
updating docs for module release
2013-12-24 23:47:57 +01:00
... This differs from how modules (in NodeJS and commonJS
environments) normally work. If you want your module to be exported
globally, put it in the `plugins` directory. If you don't want your
module to be exported globally but only want it to be used by other
modules, then put it in the `modules` directory instead. If you've
used previous versions of ScriptCraft and have put your custom
javascript modules in the `js-plugins` directory, then put them in the
`scriptcraft/plugins` directory. To summarise, modules in this directory are ...
* Automatically loaded and run at server startup.
* Anything exported by modules becomes a global variable.
### The modules directory
The module directory is where you should place your modules if you
don't want to export globally. In javascript, it's considered best
practice not to have too many global variables, so if you want to
develop modules for others to use, or want to develop more complex
mods then your modules should be placed in the `modules` directory.
*Modules in the `modules` directory are not automatically loaded at
startup*, instead, they are loaded and used by other modules/plugins
using the standard `require()` function. This is the key difference
between modules in the `plugins` directory and modules in the
`modules` directory. Modules in the `plugins` directory are
automatically loaded and exported in to the global namespace at server
startup, modules in the `modules` directory are not.
### The lib directory
Modules in the `lib` directory are for use by ScriptCraft and some
core functions for use by module and plugin developers are also
provided. The `lib` directory is for internal use by ScriptCraft.
Modules in this directory are not automatically loaded nor are they
globally exported.
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
### plugins sub-directories
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
As of December 24 2013, the `scriptcraft/plugins` directory has the following sub-directories...
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
* drone - Contains the drone module and drone extensions. Drone was the first scriptcraft module.
* mini-games - Contains mini-games
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
* arrows - The arrows module - Changes the behaviour of Arrows: Explosive, Fireworks, Teleportation etc.
* signs - The signs module (includes example signs) - create interactive signs.
* chat - The chat plugin/module
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
* alias - The alias plugin/module - for creating custom aliases for commonly-used commands.
updating docs for module release
2013-12-24 23:47:57 +01:00
* home - The home module - for setting homes and visiting other homes.
improved require function
2013-12-18 00:49:00 +01:00
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
## Global variables
There are a couple of special javascript variables available in ScriptCraft...
### __plugin variable
The ScriptCraft JavaPlugin object.
### server variable
The Minecraft Server object
### self variable
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
The current player. (Note - this value should not be used in multi-threaded scripts or event-handling code - it's not thread-safe). This variable is only safe to use at the in-game prompt and should *never* be used in modules. For example you can use it here...
'Buddha' Release : The annihilation of 'self' variable. use of 'self' should be limited only to in-game or console commands. It should not be used in the context of a module.
2013-12-30 22:33:12 +01:00
/js console.log(self.name)
... but not in any javascript module you create yourself or in any
event handling code. `self` is a temporary short-lived variable which
only exists in the context of the in-game or server command prompts.
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
### config variable
ScriptCraft configuration - this object is loaded and saved at startup/shutdown.
### events variable
The events object is used to add new event handlers to Minecraft.
## Module variables
The following variables are available only within the context of Modules. (not available at in-game prompt).
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
### &#95;&#95;filename variable
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
The current file - this variable is only relevant from within the context of a Javascript module.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
### &#95;&#95;dirname variable
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
The current directory - this variable is only relevant from within the context of a Javascript module.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
## Global functions
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
ScripCraft provides some global functions which can be used by all plugins/modules...
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
### echo function
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
The `echo()` function displays a message on the in-game screen.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
/js echo( self, 'Hello World')
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
For programmers familiar with Javascript web programming, an `alert`
function is also provided. `alert` works exactly the same as `echo`
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
e.g. `alert( self, 'Hello World')`.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### require() function
improved require function
2013-12-18 00:49:00 +01:00
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
ScriptCraft's `require()` function is used to load modules. The `require()` function takes a module name as a parameter and will try to load the named module.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
* modulename - The name of the module to be loaded. Can be one of the following...
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
- A relative file path (with or without `.js` suffix)
- An absolute file path (with or without `.js` suffix)
- A relative directory path (uses node.js rules for directories)
- An absolute directory path (uses node.js rules for directories)
- A name of the form `'events'` - in which case the `lib` directory and `modules` directories are searched for the module.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Return
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
require() will return the loaded module's exports.
improved require function
2013-12-18 00:49:00 +01:00
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
### scload() function
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### No longer recommended for use by Plugin/Module developers (deprecated)
improved require function
2013-12-18 00:49:00 +01:00
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
scload() should only be used to load .json data.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
* filename - The name of the file to load.
* warnOnFileNotFound (optional - default: false) - warn if the file was not found.
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Returns
improved require function
2013-12-18 00:49:00 +01:00
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
scload() will return the result of the last statement evaluated in the file.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Example
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
scload("myFile.js"); // loads a javascript file and evaluates it.
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
var myData = scload("myData.json"); // loads a javascript file and evaluates it - eval'd contents are returned.
updated require docs
2013-12-21 10:10:59 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
##### myData.json contents...
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
{ players: {
walterh: {
h: ["jsp home {1}"],
sunny:["time set 0",
"weather clear"]
}
}
}
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
### scsave() function
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
The scsave() function saves an in-memory javascript object to a
specified file. Under the hood, scsave() uses JSON (specifically
updating docs for module release
2013-12-24 23:47:57 +01:00
json2.js) to save the object. Again, there will usually be no need to
call this function directly as all javascript plugins' state are saved
automatically if they are declared using the `plugin()` function. Any
Fix issue #112 (Support for Nashorn in Java8)
2014-01-13 22:06:17 +01:00
in-memory object saved using the `scsave()` function can later be
restored using the `scload()` function.
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Parameters
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
* objectToSave : The object you want to save.
* filename : The name of the file you want to save it to.
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Example
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
var myObject = { name: 'John Doe',
aliases: ['John Ray', 'John Mee'],
date_of_birth: '1982/01/31' };
scsave(myObject, 'johndoe.json');
```
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
##### johndoe.json contents...
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
{ "name": "John Doe",
"aliases": ["John Ray", "John Mee"],
"date_of_birth": "1982/01/31"
};
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### plugin() function
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
The `plugin()` function should be used to declare a javascript module
whose state you want to have managed by ScriptCraft - that is - a
Module whose state will be loaded at start up and saved at shut down.
A plugin is just a regular javascript object whose state is managed by
ScriptCraft. The only member of the plugin which whose persistence is
managed by Scriptcraft is `store` - this special member will be
automatically saved at shutdown and loaded at startup by
ScriptCraft. This makes it easier to write plugins which need to
persist data.
Adding support for 'require()' and node.js-style modules (not node modules per se - just support for the same module semantics)
2013-12-21 09:58:40 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Parameters
* pluginName (String) : The name of the plugin - this becomes a global variable.
* pluginDefinition (Object) : The various functions and members of the plugin object.
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
* isPersistent (boolean - optional) : Specifies whether or not the
plugin/object state should be loaded and saved by ScriptCraft.
updated require docs
2013-12-21 10:10:59 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Example
updated require docs
2013-12-21 10:10:59 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
See chat/color.js for an example of a simple plugin - one which lets
players choose a default chat color. See also [Anatomy of a
ScriptCraft Plugin][anatomy].
Added 'use strict' to lib modules. Added legacy directory check
2014-01-02 19:46:46 +01:00
[anatomy]: ./Anatomy-of-a-Plugin.md
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### command() function
improved require function
2013-12-18 00:49:00 +01:00
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
The `command()` function is used to expose javascript functions for use by non-operators (regular players). Only operators should be allowed use raw javascript using the `/js ` command because it is too powerful for use by regular players and can be easily abused. However, the `/jsp ` command lets you (the operator / server administrator / plugin author) safely expose javascript functions for use by players.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Parameters
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
* commandFunction: The named javascript function which will be invoked when the command is invoked by a player. The name of the function will be used as the command name so name this function accordingly. The callback function in turn takes 2 parameters...
* params : An Array of type String - the list of parameters passed to the command.
* sender : The [CommandSender][bukcs] object that invoked the command (this is usually a Player object but can be a Block ([BlockCommandSender][bukbcs]).
docs for tab-completion of jsp command using function
2014-06-14 16:47:13 +02:00
* options (Array|Function - optional) : An array of command options/parameters which the player can supply (It's useful to supply an array so that Tab-Completion works for the `/jsp ` commands. If a function is supplied instead of an array then the function will be invoked at TAB-completion time and should return an array of strings.
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
* intercepts (boolean - optional) : Indicates whether this command can intercept Tab-Completion of the `/jsp ` command - advanced usage - see alias/alias.js for example.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
// javascript code
function boo( params, sender) {
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( sender, params[0] );
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
}
command( boo );
# in-game execution
/jsp boo Hi!
> Hi!
docs for tab-completion of jsp command using function
2014-06-14 16:47:13 +02:00
To use a callback for options (TAB-Completion) ...
Removing empty lib/canary.js and removing craftbukkit references from scriptcraft.js docs
2014-12-31 12:15:28 +01:00
var utils = require('utils');
docs for tab-completion of jsp command using function
2014-06-14 16:47:13 +02:00
function boo( params, sender ) {
var receiver = server.getPlayer( params[0] );
if ( receiver ){
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( receiver, sender.name + ' says boo!');
docs for tab-completion of jsp command using function
2014-06-14 16:47:13 +02:00
}
}
Removing empty lib/canary.js and removing craftbukkit references from scriptcraft.js docs
2014-12-31 12:15:28 +01:00
command( boo, utils.playerNames );
docs for tab-completion of jsp command using function
2014-06-14 16:47:13 +02:00
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
See chat/colors.js or alias/alias.js or homes/homes.js for more examples of how to use the `command()` function.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### setTimeout() function
improved require function
2013-12-18 00:49:00 +01:00
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
This function mimics the setTimeout() function used in browser-based javascript. However, the function will only accept a function reference, not a string of javascript code. Where setTimeout() in the browser returns a numeric value which can be subsequently passed to clearTimeout(), This implementation returns an object which can be subsequently passed to ScriptCraft's own clearTimeout() implementation.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
If Node.js supports setTimeout() then it's probably good for ScriptCraft to support it too.
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
//
// start a storm in 5 seconds
//
setTimeout( function() {
var world = server.worlds.get(0);
world.setStorm(true);
}, 5000);
```
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### clearTimeout() function
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
A scriptcraft implementation of clearTimeout().
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### setInterval() function
reorg
2013-12-24 01:15:17 +01:00
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
This function mimics the setInterval() function used in browser-based javascript. However, the function will only accept a function reference, not a string of javascript code. Where setInterval() in the browser returns a numeric value which can be subsequently passed to clearInterval(), This implementation returns an object which can be subsequently passed to ScriptCraft's own clearInterval() implementation.
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### clearInterval() function
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
A scriptcraft implementation of clearInterval().
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### refresh() function
improved require function
2013-12-18 00:49:00 +01:00
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
The refresh() function can be used to only reload the ScriptCraft plugin (it's like the `reload` command except it only reloads ScriptCraft). The refresh() function will ...
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
1. Disable the ScriptCraft plugin.
2. Unload all event listeners associated with the ScriptCraft plugin.
3. Enable the ScriptCraft plugin.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
... refresh() can be used during development to reload only scriptcraft javascript files.
See [issue #69][issue69] for more information.
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
[issue69]: https://github.com/walterhiggins/ScriptCraft/issues/69
improved require function
2013-12-18 00:49:00 +01:00
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
### addUnloadHandler() function
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
The addUnloadHandler() function takes a callback function as a parameter. The callback will be called when the ScriptCraft plugin is unloaded (usually as a result of a a `reload` command or server shutdown).
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
add doc comment for command tab completion using a function
2014-06-14 16:45:44 +02:00
This function provides a way for ScriptCraft modules to do any required cleanup/housekeeping just prior to the ScriptCraft Plugin unloading.
Added 'use strict' to lib modules. Added legacy directory check
2014-01-02 19:46:46 +01:00
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
### isOp() function
This function takes a single parameter and returns true if it's an operator or has operator-level privileges.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
## require - Node.js-style module loading in ScriptCraft
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
Node.js is a server-side javascript environment with an excellent
module loading system based on CommonJS. Modules in Node.js are really
simple. Each module is in its own javascript file and all variables
and functions within the file are private to that file/module only.
There is a very concise explanation of CommonJS modules at...
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
[http://wiki.commonjs.org/wiki/Modules/1.1.1.][cjsmodules]
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
Node.js also has good documentation on [Modules][njsmod].
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
If you want to export a variable or function you use the module.export
property.
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
For example imagine you have 3 files program.js, inc.js and math.js ...
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### math.js
reorg
2013-12-24 01:15:17 +01:00
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
exports.add = function(a,b){
return a + b;
}
```
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### inc.js
reorg
2013-12-24 01:15:17 +01:00
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
var math = require('./math');
exports.increment = function(n){
return math.add(n, 1);
}
```
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
### program.js
reorg
2013-12-24 01:15:17 +01:00
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```javascript
var inc = require('./inc').increment;
var a = 7;
a = inc(a);
print(a);
```
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
You can see from the above sample code that programs can use modules
and modules themeselves can use other modules. Modules have full
control over what functions and properties they want to provide to
others.
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
### Important
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
Although ScriptCraft now supports Node.js style modules, it does not
support node modules. Node.js and Rhino are two very different
Javascript environments. ScriptCraft uses Rhino Javascript, not
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
Node.js. Standard Node.js modules such as `'fs'` are not available in ScriptCraft.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
Modules can be loaded using relative or absolute paths. Per the CommonJS
module specification, the '.js' suffix is optional.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
[cjsmodules]: http://wiki.commonjs.org/wiki/Modules/1.1.1.
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
### module name resolution
When resolving module names to file paths, ScriptCraft uses the following rules...
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
1. if the module does not begin with './' or '/' then ...
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
1.1 Look in the 'scriptcraft/lib' directory. If it's not there then...
1.2 Look in the 'scriptcraft/modules' directory. If it's not there then
Throw an Error.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
2. If the module begins with './' or '/' then ...
2.1 if the module begins with './' then it's treated as a file path. File paths are
always relative to the module from which the require() call is being made.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
2.2 If the module begins with '/' then it's treated as an absolute path.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
If the module does not have a '.js' suffix, and a file with the same name and a .js sufix exists,
then the file will be loaded.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
3. If the module name resolves to a directory then...
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
3.1 look for a package.json file in the directory and load the `main` property e.g.
reorg
2013-12-24 01:15:17 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
// package.json located in './some-library/'
{
"main": './some-lib.js',
"name": 'some-library'
}
3.2 if no package.json file exists then look for an index.js file in the directory
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
## events Module
updating docs for module release
2013-12-24 23:47:57 +01:00
The Events module provides a thin wrapper around Bukkit's
Event-handling API. Bukkit's Events API makes use of Java Annotations
which are not available in Javascript, so this module provides a
simple way to listen to minecraft events in javascript.
reorg
2013-12-24 01:15:17 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
### events.on() static method
updating docs for module release
2013-12-24 23:47:57 +01:00
This method is used to register event listeners.
reorg
2013-12-24 01:15:17 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Parameters
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* eventName - A Java class. See [Bukkit API][buk] for details of the many bukkit event types.
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
* callback - A function which will be called whenever the event
Event handling rework. Simplified event handling and unregistering.
2014-03-15 19:06:23 +01:00
fires. The callback should take a single parameter, event (the event fired).
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
* priority (optional - default: "HIGHEST") - The priority the
listener/callback takes over other listeners to the same
event. Possible values are "HIGH", "HIGHEST", "LOW", "LOWEST",
"NORMAL", "MONITOR". For an explanation of what the different
priorities mean refer to bukkit's [Event API Reference][buk2].
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Returns
Event handling rework. Simplified event handling and unregistering.
2014-03-15 19:06:23 +01:00
An object which can be used to unregister the listener.
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Example:
updating docs for module release
2013-12-24 23:47:57 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
The following code will print a message on screen every time a block is broken in the game
updating docs for module release
2013-12-24 23:47:57 +01:00
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
```javascript
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
events.on( org.bukkit.block.BlockBreakEvent, function( evt ) {
echo(evt.player, evt.player.name + ' broke a block!');
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
} );
```
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
To handle an event only once and unregister from further events...
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
```javascript
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
events.on( org.bukkit.block.BlockBreakEvent, function( evt ) {
echo( evt.player, evt.player.name + ' broke a block!');
Event handling rework. Simplified event handling and unregistering.
2014-03-15 19:06:23 +01:00
this.unregister();
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
} );
fix docs for events.js
2014-04-26 21:34:45 +02:00
```
improved require function
2013-12-18 00:49:00 +01:00
Event handling rework. Simplified event handling and unregistering.
2014-03-15 19:06:23 +01:00
The `this` keyword when used inside the callback function refers to
the Listener object created by ScriptCraft. It has a single method
`unregister()` which can be used to stop listening. This is the same
object which is returned by the `events.on()` function.
updating docs for module release
2013-12-24 23:47:57 +01:00
To unregister a listener *outside* of the listener function...
improved require function
2013-12-18 00:49:00 +01:00
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
```javascript
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
var myBlockBreakListener = events.on( org.bukkit.block.BlockBreakEvent, function( evt ) { ... } );
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
...
Event handling rework. Simplified event handling and unregistering.
2014-03-15 19:06:23 +01:00
myBlockBreakListener.unregister();
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
```
improved require function
2013-12-18 00:49:00 +01:00
updating docs for module release
2013-12-24 23:47:57 +01:00
[buk2]: http://wiki.bukkit.org/Event_API_Reference
[buk]: http://jd.bukkit.org/dev/apidocs/index.html?org/bukkit/event/Event.html
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Events Helper Module (canary version)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
The Events helper module provides a suite of functions - one for each possible event.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
For example, the events.blockDestroy() function is just a wrapper function which calls events.on(net.canarymod.hook.player.BlockDestroyHook, callback, priority)
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
This module is a convenience wrapper for easily adding new event handling functions in Javascript.
At the in-game or server-console prompt, players/admins can type `events.` and use TAB completion
to choose from any of the approx. 160 different event types to listen to.
### Usage
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
events.blockDestroy( function( event ) {
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
echo( event.player, 'You broke a block!');
});
The crucial difference is that the events module now has functions for each of the built-in events. The functions are accessible via TAB-completion so will help beginning programmers to explore the events at the server console window.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.minecartActivate()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.MinecartActivateHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/MinecartActivateHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.villagerTradeUnlock()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.VillagerTradeUnlockHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/VillagerTradeUnlockHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.mobTarget()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.MobTargetHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/MobTargetHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chickenLayEgg()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ChickenLayEggHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/ChickenLayEggHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.potionEffectFinish()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.PotionEffectFinishHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/PotionEffectFinishHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityMove()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityMoveHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EntityMoveHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.hangingEntityDestroy()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.HangingEntityDestroyHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/HangingEntityDestroyHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleCollision()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.VehicleCollisionHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/VehicleCollisionHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.potionEffectApplied()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.PotionEffectAppliedHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/PotionEffectAppliedHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleDestroy()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.VehicleDestroyHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/VehicleDestroyHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleEnter()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.VehicleEnterHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/VehicleEnterHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.damage()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.DamageHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/DamageHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityMount()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityMountHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EntityMountHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.slimeSplit()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.SlimeSplitHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/SlimeSplitHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.endermanDropBlock()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EndermanDropBlockHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EndermanDropBlockHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.itemTouchGround()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ItemTouchGroundHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/ItemTouchGroundHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entitySpawn()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntitySpawnHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EntitySpawnHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.endermanPickupBlock()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EndermanPickupBlockHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EndermanPickupBlockHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleDamage()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.VehicleDamageHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/VehicleDamageHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityLightningStruck()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityLightningStruckHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EntityLightningStruckHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityDespawn()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityDespawnHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EntityDespawnHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleMove()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.VehicleMoveHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/VehicleMoveHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.projectileHit()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ProjectileHitHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/ProjectileHitHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityDeath()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityDeathHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EntityDeathHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityTame()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityTameHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/EntityTameHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleExit()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.VehicleExitHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/VehicleExitHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.dimensionSwitch()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.DimensionSwitchHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/entity/DimensionSwitchHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.foodLevel()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.FoodLevelHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/FoodLevelHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.bookEdit()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BookEditHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BookEditHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerListEntry()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerListEntryHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerListEntryHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.eat()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.EatHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/EatHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
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 01:11:44 +01:00
### 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.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerIdle()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerIdleHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerIdleHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.enchant()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.EnchantHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/EnchantHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerArmSwing()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerArmSwingHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerArmSwingHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.teleport()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.TeleportHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/TeleportHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.anvilUse()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.AnvilUseHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/AnvilUseHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.portalUse()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PortalUseHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PortalUseHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.foodSaturation()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.FoodSaturationHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/FoodSaturationHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.connection()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ConnectionHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ConnectionHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerRespawned()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerRespawnedHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerRespawnedHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.armorBroken()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ArmorBrokenHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ArmorBrokenHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.levelUp()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.LevelUpHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/LevelUpHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockRightClick()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BlockRightClickHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BlockRightClickHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.itemDrop()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ItemDropHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ItemDropHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerRespawning()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerRespawningHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerRespawningHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.craft()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.CraftHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/CraftHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.experience()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ExperienceHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ExperienceHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.signChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.SignChangeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/SignChangeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.healthChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.HealthChangeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/HealthChangeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.disconnection()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.DisconnectionHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/DisconnectionHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.gameModeChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.GameModeChangeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/GameModeChangeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.preConnection()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PreConnectionHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PreConnectionHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.villagerTrade()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.VillagerTradeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/VillagerTradeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.returnFromIdle()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ReturnFromIdleHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ReturnFromIdleHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.slotClick()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.SlotClickHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/SlotClickHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityRightClick()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.EntityRightClickHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/EntityRightClickHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.foodExhaustion()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.FoodExhaustionHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/FoodExhaustionHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chat()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ChatHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ChatHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.itemPickup()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ItemPickupHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ItemPickupHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.bedExit()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BedExitHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BedExitHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockPlace()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BlockPlaceHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BlockPlaceHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.toolBroken()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ToolBrokenHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ToolBrokenHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.kick()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.KickHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/KickHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerDeath()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerDeathHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerDeathHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockLeftClick()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BlockLeftClickHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BlockLeftClickHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockDestroy()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BlockDestroyHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BlockDestroyHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.bedEnter()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BedEnterHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BedEnterHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.signShow()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.SignShowHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/SignShowHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventory()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.InventoryHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/InventoryHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerMove()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerMoveHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/PlayerMoveHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.itemUse()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.ItemUseHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/ItemUseHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.ban()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.BanHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/BanHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.statGained()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.StatGainedHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/player/StatGainedHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.smeltBegin()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.SmeltBeginHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/SmeltBeginHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.treeGrow()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.TreeGrowHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/TreeGrowHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chunkCreated()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ChunkCreatedHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/ChunkCreatedHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.liquidDestroy()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.LiquidDestroyHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/LiquidDestroyHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chunkLoaded()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ChunkLoadedHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/ChunkLoadedHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.pistonRetract()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.PistonRetractHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/PistonRetractHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.smelt()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.SmeltHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/SmeltHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockUpdate()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.BlockUpdateHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/BlockUpdateHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.portalDestroy()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.PortalDestroyHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/PortalDestroyHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.ignition()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.IgnitionHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/IgnitionHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.redstoneChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.RedstoneChangeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/RedstoneChangeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.weatherChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.WeatherChangeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/WeatherChangeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chunkCreation()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ChunkCreationHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/ChunkCreationHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.hopperTransfer()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.HopperTransferHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/HopperTransferHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chunkUnload()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ChunkUnloadHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/ChunkUnloadHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockGrow()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.BlockGrowHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/BlockGrowHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.dispense()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.DispenseHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/DispenseHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockDropXp()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.BlockDropXpHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/BlockDropXpHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.fireworkExplode()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.FireworkExplodeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/FireworkExplodeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.leafDecay()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.LeafDecayHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/LeafDecayHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.pistonExtend()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.PistonExtendHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/PistonExtendHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.noteBlockPlay()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.NoteBlockPlayHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/NoteBlockPlayHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.lightningStrike()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.LightningStrikeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/LightningStrikeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.decorate()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.DecorateHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/DecorateHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.explosion()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ExplosionHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/ExplosionHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.tNTActivate()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.TNTActivateHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/TNTActivateHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.timeChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.TimeChangeHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/TimeChangeHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.flow()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.FlowHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/FlowHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.portalCreate()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.PortalCreateHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/PortalCreateHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockPhysics()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.BlockPhysicsHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/world/BlockPhysicsHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerCommand()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [command.PlayerCommandHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/command/PlayerCommandHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.consoleCommand()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [command.ConsoleCommandHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/command/ConsoleCommandHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.commandBlockCommand()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [command.CommandBlockCommandHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/command/CommandBlockCommandHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.loadWorld()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.LoadWorldHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/LoadWorldHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.permissionCheck()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.PermissionCheckHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/PermissionCheckHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serverGuiStart()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.ServerGuiStartHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/ServerGuiStartHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.unloadWorld()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.UnloadWorldHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/UnloadWorldHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.pluginDisable()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.PluginDisableHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/PluginDisableHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.pluginEnable()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.PluginEnableHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/PluginEnableHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serverTick()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.ServerTickHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/ServerTickHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serverListPing()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.ServerListPingHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/ServerListPingHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serverShutdown()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [system.ServerShutdownHook event](https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/hook/system/ServerShutdownHook.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Events Helper Module (bukkit version)
The Events helper module provides a suite of functions - one for each possible event.
For example, the events.blockBreak() function is just a wrapper function which calls events.on(org.bukkit.event.block.BlockBreakEvent, callback, priority)
This module is a convenience wrapper for easily adding new event handling functions in Javascript.
At the in-game or server-console prompt, players/admins can type `events.` and use TAB completion
to choose from any of the approx. 160 different event types to listen to.
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Usage
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
events.blockBreak( function( event ) {
echo( event.player, 'You broke a block!');
});
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The crucial difference is that the events module now has functions for each of the built-in events. The functions are accessible via TAB-completion so will help beginning programmers to explore the events at the server console window.
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.weatherChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [weather.WeatherChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/weather/WeatherChangeEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.lightningStrike()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [weather.LightningStrikeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/weather/LightningStrikeEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.thunderChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [weather.ThunderChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/weather/ThunderChangeEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleMove()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleMoveEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleMoveEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleDestroy()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleDestroyEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleDestroyEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleExit()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleExitEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleExitEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleEntityCollision()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleEntityCollisionEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleEntityCollisionEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleBlockCollision()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleBlockCollisionEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleBlockCollisionEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleEnter()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleEnterEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleEnterEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleDamage()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleDamageEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleDamageEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleUpdate()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleUpdateEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleUpdateEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.vehicleCreate()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [vehicle.VehicleCreateEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/vehicle/VehicleCreateEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.paintingBreak()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [painting.PaintingBreakEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/painting/PaintingBreakEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.paintingBreakByEntity()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [painting.PaintingBreakByEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/painting/PaintingBreakByEntityEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.paintingPlace()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [painting.PaintingPlaceEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/painting/PaintingPlaceEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.enchantItem()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [enchantment.EnchantItemEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/enchantment/EnchantItemEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.prepareItemEnchant()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [enchantment.PrepareItemEnchantEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/enchantment/PrepareItemEnchantEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerInteractEntity()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerInteractEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerInteractEntityEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerEggThrow()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerEggThrowEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerEggThrowEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerUnleashEntity()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerUnleashEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerUnleashEntityEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerInventory()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerInventoryEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerInventoryEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerLevelChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerLevelChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerLevelChangeEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerPortal()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerPortalEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerPortalEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerItemConsume()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerItemConsumeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerItemConsumeEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerTeleport()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerTeleportEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerTeleportEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerBedEnter()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerBedEnterEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerBedEnterEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerUnregisterChannel()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerUnregisterChannelEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerUnregisterChannelEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerChat()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerChatEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerChatEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerShearEntity()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerShearEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerShearEntityEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.asyncPlayerChat()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.AsyncPlayerChatEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/AsyncPlayerChatEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerDropItem()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerDropItemEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerDropItemEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerRegisterChannel()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerRegisterChannelEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerRegisterChannelEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerMove()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerMoveEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerMoveEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerItemBreak()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerItemBreakEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerItemBreakEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerBucketEmpty()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerBucketEmptyEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerBucketEmptyEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerStatisticIncrement()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerStatisticIncrementEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerStatisticIncrementEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerToggleFlight()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerToggleFlightEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerToggleFlightEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerItemHeld()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerItemHeldEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerItemHeldEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerAchievementAwarded()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerAchievementAwardedEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerAchievementAwardedEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerToggleSneak()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerToggleSneakEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerToggleSneakEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerExpChange()
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerExpChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerExpChangeEvent.html) is fired
Include docs for both bukkit and canary event helpers.
2014-11-09 12:52:10 +01:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerPreLogin()
tidy up docs on events-helper module.
2014-04-26 21:31:52 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerPreLoginEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerPreLoginEvent.html) is fired
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* priority - optional - see events.on() for more information.
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerJoin()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerJoinEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerJoinEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerAnimation()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerAnimationEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerAnimationEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerEditBook()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerEditBookEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerEditBookEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerPickupItem()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerPickupItemEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerPickupItemEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerChangedWorld()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerChangedWorldEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerChangedWorldEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerFish()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerFishEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerFishEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerChatTabComplete()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerChatTabCompleteEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerChatTabCompleteEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerRespawn()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerRespawnEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerRespawnEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerBedLeave()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerBedLeaveEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerBedLeaveEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.asyncPlayerPreLogin()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.AsyncPlayerPreLoginEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/AsyncPlayerPreLoginEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerInteract()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerInteractEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerInteractEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerBucketFill()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerBucketFillEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerBucketFillEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerVelocity()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerVelocityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerVelocityEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerQuit()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerQuitEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerQuitEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerLogin()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerLoginEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerLoginEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerKick()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerKickEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerKickEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerToggleSprint()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerToggleSprintEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerToggleSprintEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerCommandPreprocess()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerCommandPreprocessEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerCommandPreprocessEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerGameModeChange()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [player.PlayerGameModeChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/player/PlayerGameModeChangeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.furnaceSmelt()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.FurnaceSmeltEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/FurnaceSmeltEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventoryDrag()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryDragEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryDragEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.craftItem()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.CraftItemEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/CraftItemEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.furnaceBurn()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.FurnaceBurnEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/FurnaceBurnEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventoryOpen()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryOpenEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryOpenEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventoryPickupItem()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryPickupItemEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryPickupItemEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventoryMoveItem()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryMoveItemEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryMoveItemEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventoryClick()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryClickEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryClickEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventoryClose()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryCloseEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryCloseEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventoryCreative()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryCreativeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryCreativeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.inventory()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.InventoryEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/InventoryEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.prepareItemCraft()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.PrepareItemCraftEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/PrepareItemCraftEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.furnaceExtract()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.FurnaceExtractEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/FurnaceExtractEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.brew()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [inventory.BrewEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/inventory/BrewEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serverCommand()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.ServerCommandEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/ServerCommandEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serverListPing()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.ServerListPingEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/ServerListPingEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serviceRegister()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.ServiceRegisterEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/ServiceRegisterEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.pluginDisable()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.PluginDisableEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/PluginDisableEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.remoteServerCommand()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.RemoteServerCommandEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/RemoteServerCommandEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.mapInitialize()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.MapInitializeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/MapInitializeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.serviceUnregister()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.ServiceUnregisterEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/ServiceUnregisterEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.pluginEnable()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [server.PluginEnableEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/server/PluginEnableEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerDeath()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.PlayerDeathEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/PlayerDeathEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityCreatePortal()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityCreatePortalEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityCreatePortalEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityCombust()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityCombustEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityCombustEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.sheepDyeWool()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.SheepDyeWoolEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/SheepDyeWoolEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.expBottle()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ExpBottleEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/ExpBottleEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityTame()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityTameEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityTameEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.projectileLaunch()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ProjectileLaunchEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/ProjectileLaunchEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityDamage()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityDamageEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityDamageEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.itemSpawn()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ItemSpawnEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/ItemSpawnEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.projectileHit()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ProjectileHitEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/ProjectileHitEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.foodLevelChange()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.FoodLevelChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/FoodLevelChangeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.itemDespawn()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ItemDespawnEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/ItemDespawnEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityPortalEnter()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityPortalEnterEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityPortalEnterEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityPortal()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityPortalEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityPortalEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityTarget()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityTargetEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityTargetEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityDeath()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityDeathEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityDeathEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.sheepRegrowWool()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.SheepRegrowWoolEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/SheepRegrowWoolEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityShootBow()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityShootBowEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityShootBowEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.creeperPower()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.CreeperPowerEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/CreeperPowerEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityCombustByBlock()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityCombustByBlockEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityCombustByBlockEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityBreakDoor()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityBreakDoorEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityBreakDoorEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityDamageByEntity()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityDamageByEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityDamageByEntityEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityUnleash()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityUnleashEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityUnleashEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityExplode()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityExplodeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityExplodeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityInteract()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityInteractEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityInteractEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.explosionPrime()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.ExplosionPrimeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/ExplosionPrimeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.horseJump()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.HorseJumpEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/HorseJumpEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.creatureSpawn()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.CreatureSpawnEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/CreatureSpawnEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityCombustByEntity()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityCombustByEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityCombustByEntityEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityDamageByBlock()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityDamageByBlockEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityDamageByBlockEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityTargetLivingEntity()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityTargetLivingEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityTargetLivingEntityEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityTeleport()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityTeleportEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityTeleportEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.playerLeashEntity()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.PlayerLeashEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/PlayerLeashEntityEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.slimeSplit()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.SlimeSplitEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/SlimeSplitEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.pigZap()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.PigZapEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/PigZapEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.potionSplash()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.PotionSplashEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/PotionSplashEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityChangeBlock()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityChangeBlockEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityChangeBlockEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityPortalExit()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityPortalExitEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityPortalExitEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityRegainHealth()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [entity.EntityRegainHealthEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/entity/EntityRegainHealthEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.entityBlockForm()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.EntityBlockFormEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/EntityBlockFormEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockSpread()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockSpreadEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockSpreadEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockMultiPlace()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockMultiPlaceEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockMultiPlaceEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.notePlay()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.NotePlayEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/NotePlayEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockFade()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockFadeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockFadeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockPlace()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockPlaceEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockPlaceEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockPhysics()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockPhysicsEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockPhysicsEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockIgnite()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockIgniteEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockIgniteEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockBreak()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockBreakEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockBreakEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockBurn()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockBurnEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockBurnEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockFromTo()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockFromToEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockFromToEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockRedstone()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockRedstoneEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockRedstoneEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockPistonRetract()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockPistonRetractEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockPistonRetractEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockDispense()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockDispenseEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockDispenseEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.signChange()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.SignChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/SignChangeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockPistonExtend()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockPistonExtendEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockPistonExtendEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockCanBuild()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockCanBuildEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockCanBuildEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockGrow()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockGrowEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockGrowEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.leavesDecay()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.LeavesDecayEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/LeavesDecayEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockExp()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockExpEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockExpEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockForm()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockFormEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockFormEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.blockDamage()
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [block.BlockDamageEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/block/BlockDamageEvent.html) is fired
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
* priority - optional - see events.on() for more information.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.hangingPlace()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [hanging.HangingPlaceEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/hanging/HangingPlaceEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.hangingBreakByEntity()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [hanging.HangingBreakByEntityEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/hanging/HangingBreakByEntityEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.hangingBreak()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [hanging.HangingBreakEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/hanging/HangingBreakEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.structureGrow()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.StructureGrowEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/StructureGrowEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.spawnChange()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.SpawnChangeEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/SpawnChangeEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.worldLoad()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.WorldLoadEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/WorldLoadEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.worldInit()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.WorldInitEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/WorldInitEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.worldUnload()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.WorldUnloadEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/WorldUnloadEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.worldSave()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.WorldSaveEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/WorldSaveEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chunkUnload()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ChunkUnloadEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/ChunkUnloadEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chunkPopulate()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ChunkPopulateEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/ChunkPopulateEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.portalCreate()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.PortalCreateEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/PortalCreateEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### events.chunkLoad()
fixing toc issue
2014-04-26 18:14:32 +02:00
Events handling changes. Added new convenience functions to events module to make event handling easier still for newbies
2014-04-26 17:56:57 +02:00
#### Parameters
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* callback - A function which is called whenever the [world.ChunkLoadEvent event](http://jd.bukkit.org/rb/apidocs/org/bukkit/event/world/ChunkLoadEvent.html) is fired
fixing toc issue
2014-04-26 18:14:32 +02:00
added priority optional param to docs
2014-04-26 21:24:45 +02:00
* priority - optional - see events.on() for more information.
fixing toc issue
2014-04-26 18:14:32 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## console global variable
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
ScriptCraft provides a `console` global variable with the followng methods...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* log()
* info()
* warn()
* error()
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The ScriptCraft console methods work like the [Web API implementation][webcons].
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Example
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
console.log('Hello %s', 'world');
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Basic variable substitution is supported (ScriptCraft's implementation
of console uses the Bukkit Plugin [Logger][lgr] or Canary Plugin [Logman][cmlgr] under the hood and
uses [java.lang.String.format()][strfmt] for variable
substitution. All output will be sent to the server console (not
in-game).
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Using string substitutions
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
ScriptCraft uses Java's [String.format()][strfmt] so any string substitution identifiers supported by
`java.lang.String.format()` are supported (e.g. %s , %d etc).
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
for (var i=0; i<5; i++) {
console.log("Hello, %s. You've called me %d times.", "Bob", i+1);
}
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[lgr]: http://jd.bukkit.org/beta/apidocs/org/bukkit/plugin/PluginLogger.html
[cmlgr]: https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/logger/Logman.html
[strfmt]: http://docs.oracle.com/javase/6/docs/api/java/lang/String.html#format(java.lang.String, java.lang.Object...)
[webcons]: https://developer.mozilla.org/en-US/docs/Web/API/console
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Drone Plugin
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The Drone is a convenience class for building. It can be used for...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
1. Building
2. Copying and Pasting
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
It uses a fluent interface which means all of the Drone's methods return `this` and can be chained together like so...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var theDrone = new Drone(self);
theDrone.up().left().box(blocks.oak).down().fwd(3).cylinder0(blocks.lava,8);
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Constructing a Drone Object
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Drones can be created in any of the following ways...
1. Calling any one of the methods listed below will return a Drone object. For example...
var d = box( blocks.oak )
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... creates a 1x1x1 wooden block at the cross-hairs or player's location and returns a Drone object. This might look odd (if you're familiar with Java's Object-dot-method syntax) but all of the Drone class's methods are also global functions that return new Drone objects. This is short-hand for creating drones and is useful for playing around with Drones at the in-game command prompt. It's shorter than typing ...
var d = new Drone(self).box( blocks.oak )
... All of the Drone's methods return `this` so you can chain operations together like this...
var d = box( blocks.oak )
.up()
.box( blocks.oak ,3,1,3)
.down()
.fwd(2)
.box( blocks.oak )
.turn()
.fwd(2)
.box( blocks.oak )
.turn()
.fwd(2)
.box( blocks.oak );
2. Using the following form...
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
d = new Drone(self)
...will create a new Drone taking the current player as the parameter. If the player's cross-hairs are pointing at a block at the time then, that block's location becomes the drone's starting point. If the cross-hairs are _not_ pointing at a block, then the drone's starting location will be 2 blocks directly in front of the player. TIP: Building always happens right and front of the drone's position...
Plan View:
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
^
|
|
D---->
For convenience you can use a _corner stone_ to begin building. The corner stone should be located just above ground level. If the cross-hair is point at or into ground level when you create a new Drone() with either a player or location given as a parameter, then building begins at the location the player was looking at or at the location. You can get around this by pointing at a 'corner stone' just above ground level or alternatively use the following statement...
d = new Drone(self).up();
... which will move the drone up one block as soon as it's created.
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![corner stone](img/cornerstone1.png)
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
3. Or by using the following form...
d = new Drone(x,y,z,direction,world);
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This will create a new Drone at the location you specified using x, y, z In minecraft, the X axis runs west to east and the Z axis runs north to south. The direction parameter says what direction you want the drone to face: 0 = east, 1 = south, 2 = west, 3 = north. If the direction parameter is omitted, the player's direction is used instead. Both the `direction` and `world` parameters are optional.
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
4. Create a new Drone based on a Location object...
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
d = new Drone(location);
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This is useful when you want to create a drone at a given `org.bukkit.Location` . The `Location` class is used throughout the bukkit API. For example, if you want to create a drone when a block is broken at the block's location you would do so like this...
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
events.blockBreak( function( event ) {
var location = event.block.location;
var drone = new Drone(location);
// do more stuff with the drone here...
});
Added asynchronous player input (async prompt) function.
2014-04-14 00:25:02 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* Player : If a player reference is given as the sole parameter then the block the player was looking at will be used as the starting point for the drone. If the player was not looking at a block then the player's location will be used as the starting point. If a `Player` object is provided as a paramter then it should be the only parameter.
* location : *NB* If a `Location` object is provided as a parameter, then it should be the only parameter.
* x : The x coordinate of the Drone (x,y,z,direction and world are not needed if either a player or location parameter is provided)
* y : The y coordinate of the Drone
* z : The z coordinate of the Drone
* direction : The direction in which the Drone is facing. Possible values are 0 (east), 1 (south), 2 (west) or 3 (north)
* world : The world in which the drone is created.
### Drone.box() method
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
the box() method is a convenience method for building things. (For the more performance-oriented method - see cuboid)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### parameters
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* b - the block id - e.g. 6 for an oak sapling or '6:2' for a birch sapling. Alternatively you can use any one of the `blocks` values e.g. `blocks.sapling.birch`
* w (optional - default 1) - the width of the structure
* h (optional - default 1) - the height of the structure
* d (optional - default 1) - the depth of the structure - NB this is not how deep underground the structure lies - this is how far away (depth of field) from the drone the structure will extend.
self is available for autocompletion
2014-01-05 18:20:54 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
self is available for autocompletion
2014-01-05 18:20:54 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a black structure 4 blocks wide, 9 blocks tall and 1 block long...
box(blocks.wool.black, 4, 9, 1);
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... or the following code does the same but creates a variable that can be used for further methods...
var drone = new Drone(self);
drone.box(blocks.wool.black, 4, 9, 1);
![box example 1](img/boxex1.png)
### Drone.box0() method
Another convenience method - this one creates 4 walls with no floor or ceiling.
improved require function
2013-12-18 00:49:00 +01:00
self is available for autocompletion
2014-01-05 18:20:54 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* block - the block id - e.g. 6 for an oak sapling or '6:2' for a birch sapling. Alternatively you can use any one of the `blocks` values e.g. `blocks.sapling.birch`
* width (optional - default 1) - the width of the structure
* height (optional - default 1) - the height of the structure
* length (optional - default 1) - the length of the structure - how far
away (depth of field) from the drone the structure will extend.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a stone building with the insided hollowed out 7 wide by 3 tall by 6 long...
box0( blocks.stone, 7, 3, 6);
![example box0](img/box0ex1.png)
### Drone.boxa() method
Construct a cuboid using an array of blocks. As the drone moves first along the width axis, then the height (y axis) then the length, each block is picked from the array and placed.
#### Parameters
* blocks - An array of blocks - each block in the array will be placed in turn.
* width
* height
* length
improved require function
2013-12-18 00:49:00 +01:00
self is available for autocompletion
2014-01-05 18:20:54 +01:00
#### Example
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Construct a rainbow-colored road 100 blocks long...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var rainbowColors = [blocks.wool.red, blocks.wool.orange, blocks.wool.yellow, blocks.wool.lime,
blocks.wool.lightblue, blocks.wool.blue, blocks.wool.purple];
boxa(rainbowColors,7,1,30);
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![boxa example](img/boxaex1.png)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Chaining
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
All of the Drone methods return a Drone object, which means methods can be 'chained' together so instead of writing this...
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone = new Drone( self );
drone.fwd( 3 );
drone.left( 2 );
drone.box( blocks.grass ); // create a grass block
drone.up();
drone.box( blocks.grass ); // create another grass block
drone.down();
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
...you could simply write ...
var drone = new Drone(self).fwd(3).left(2).box(blocks.grass).up().box(blocks.grass).down();
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... since each Drone method is also a global function that constructs a drone if none is supplied, you can shorten even further to just...
fwd(3).left(2).box(blocks.grass).up().box(blocks.grass).down()
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The Drone object uses a [Fluent Interface][fl] to make ScriptCraft scripts more concise and easier to write and read. Minecraft's in-game command prompt is limited to about 80 characters so chaining drone commands together means more can be done before hitting the command prompt limit. For complex building you should save your commands in a new script file and load it using /js load()
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[fl]: http://en.wikipedia.org/wiki/Fluent_interface
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone Properties
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* x - The Drone's position along the west-east axis (x increases as you move east)
* y - The Drone's position along the vertical axis (y increses as you move up)
* z - The Drone's position along the north-south axis (z increases as you move south)
* dir - The Drone's direction 0 is east, 1 is south , 2 is west and 3 is north.
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Extending Drone
The Drone object can be easily extended - new buidling recipes/blueprints can be added and can become part of a Drone's chain using the *static* method `Drone.extend`.
### Drone.extend() static method
Use this method to add new methods (which also become chainable global functions) to the Drone object.
#### Parameters
* name - The name of the new method e.g. 'pyramid'.
* function - The method body.
Alternatively if you provide just a function as a parameter, then the function name will be used as the new method name. For example the following two approaches are both valid.
#### Example 1 Using name and function as parameters
// submitted by [edonaldson][edonaldson]
Update docs per new way to require('drone')
2015-01-11 01:29:43 +01:00
var Drone = require('drone');
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Drone.extend('pyramid', function( block,height) {
this.chkpt('pyramid');
for ( var i = height; i > 0; i -= 2) {
this.box(block, i, 1, i).up().right().fwd();
}
return this.move('pyramid');
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
});
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example 2 Using just a named function as a parameter
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
Update docs per new way to require('drone')
2015-01-11 01:29:43 +01:00
var Drone = require('drone');
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
function pyramid( block,height) {
this.chkpt('pyramid');
for ( var i = height; i > 0; i -= 2) {
this.box(block, i, 1, i).up().right().fwd();
}
return this.move('pyramid');
}
Drone.extend( pyramid );
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Once the method is defined (it can be defined in a new pyramid.js file) it can be used like so...
var d = new Drone(self);
d.pyramid(blocks.brick.stone, 12);
Adding sc-mqtt module for comms with Arduino
2014-01-18 00:05:36 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... or simply ...
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
pyramid(blocks.brick.stone, 12);
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[edonaldson]: https://github.com/edonaldson
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone Constants
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Drone.PLAYER_STAIRS_FACING
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
An array which can be used when constructing stairs facing in the Drone's direction...
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var d = new Drone(self);
d.box(blocks.stairs.oak + ':' + Drone.PLAYER_STAIRS_FACING[d.dir]);
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... will construct a single oak stair block facing the drone.
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Drone.PLAYER_SIGN_FACING
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
An array which can be used when placing signs so they face in a given direction. This is used internally by the Drone.sign() method. It should also be used for placing any of the following blocks...
further syntax-highlighting and ignore netbeans folder.
2014-02-04 22:49:12 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* chest
* ladder
* furnace
* dispenser
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
By default, chests, dispensers, signs, ladders and furnaces are placed facing towards the drone so to place a chest facing the Drone just use:
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.box( blocks.chest );
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To place a chest facing _away_ from the Drone:
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.box( blocks.chest + ':' + Drone.PLAYER_SIGN_FACING[(drone.dir + 2) % 4]);
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Drone.PLAYER_TORCH_FACING
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Used when placing torches. By default torches will be placed facing up. If you want to place a torch so that it faces towards the drone:
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.box( blocks.torch + ':' + Drone.PLAYER_TORCH_FACING[drone.dir]);
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
If you want to place a torch so it faces _away_ from the drone:
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.box( blocks.torch + ':' + Drone.PLAYER_TORCH_FACING[(drone.dir + 2) % 4]);
Added documentation for the Signs module and changed Signs examples so that a valid sign must be provided to the function returned by signs.menu().
2014-01-05 16:20:29 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.times() Method
Added new sounds module
2014-05-10 19:45:48 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The times() method makes building multiple copies of buildings
easy. It's possible to create rows or grids of buildings without
resorting to `for` or `while` loops.
Added new sounds module
2014-05-10 19:45:48 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Added new sounds module
2014-05-10 19:45:48 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* numTimes (optional - default 2) : The number of times you want to repeat the preceding statements.
Added new sounds module
2014-05-10 19:45:48 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Say you want to do the same thing over and over. You have a couple of options...
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* You can use a for loop...
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
d = new Drone(); for ( var i =0;i < 4; i++) { d.cottage().right(8); }
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
While this will fit on the in-game prompt, it's awkward. You need to
declare a new Drone object first, then write a for loop to create the
4 cottages. It's also error prone, even the `for` loop is too much
syntax for what should really be simple.
Fixed events-helper to include all non-abstract handlers. Added items.js module and fixed sounds.js (more work needed on items.js)
2014-05-18 01:35:26 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* You can use a while loop...
d = new Drone(); var i=4; while (i--) { d.cottage().right(8); }
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... which is slightly shorter but still too much syntax. Each of the
above statements is fine for creating a 1-dimensional array of
structures. But what if you want to create a 2-dimensional or
3-dimensional array of structures? Enter the `times()` method.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The `times()` method lets you repeat commands in a chain any number of
times. So to create 4 cottages in a row you would use the following
statement...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
cottage().right(8).times(4);
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
...which will build a cottage, then move right 8 blocks, then do it
again 4 times over so that at the end you will have 4 cottages in a
row. What's more the `times()` method can be called more than once in
a chain. So if you wanted to create a *grid* of 20 houses ( 4 x 5 ),
you would do so using the following statement...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
cottage().right(8).times(4).fwd(8).left(32).times(5);
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... breaking it down...
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
1. The first 3 calls in the chain ( `cottage()`, `right(8)`, `times(4)` ) build a single row of 4 cottages.
Added 2 new example plugins and changed drone so that public extensions (box, sphere, etc) pass 'self' as first param to Drone constructor (part of eventual phase-out of 'self' variable).
2013-12-31 19:21:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
2. The last 3 calls in the chain ( `fwd(8)`, `left(32)`, `times(5)` ) move the drone forward 8 then left 32 blocks (4 x 8) to return to the original x coordinate, then everything in the chain is repeated again 5 times so that in the end, we have a grid of 20 cottages, 4 x 5. Normally this would require a nested loop but the `times()` method does away with the need for loops when repeating builds.
Added 2 new example plugins and changed drone so that public extensions (box, sphere, etc) pass 'self' as first param to Drone constructor (part of eventual phase-out of 'self' variable).
2013-12-31 19:21:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Another example: This statement creates a row of trees 2 by 3 ...
Added 2 new example plugins and changed drone so that public extensions (box, sphere, etc) pass 'self' as first param to Drone constructor (part of eventual phase-out of 'self' variable).
2013-12-31 19:21:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
oak().right(10).times(2).left(20).fwd(10).times(3)
Added 2 new example plugins and changed drone so that public extensions (box, sphere, etc) pass 'self' as first param to Drone constructor (part of eventual phase-out of 'self' variable).
2013-12-31 19:21:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... You can see the results below.
Added 2 new example plugins and changed drone so that public extensions (box, sphere, etc) pass 'self' as first param to Drone constructor (part of eventual phase-out of 'self' variable).
2013-12-31 19:21:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![times example 1](img/times-trees.png)
Added 2 new example plugins and changed drone so that public extensions (box, sphere, etc) pass 'self' as first param to Drone constructor (part of eventual phase-out of 'self' variable).
2013-12-31 19:21:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.arc() method
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The arc() method can be used to create 1 or more 90 degree arcs in the
horizontal or vertical planes. This method is called by cylinder() and
cylinder0() and the sphere() and sphere0() methods.
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
arc() takes a single parameter - an object with the following named properties...
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* radius - The radius of the arc.
* blockType - The type of block to use - this is the block Id only (no meta). See [Data Values][dv].
* meta - The metadata value. See [Data Values][dv].
* orientation (default: 'horizontal' ) - the orientation of the arc - can be 'vertical' or 'horizontal'.
* stack (default: 1 ) - the height or length of the arc (depending on the orientation - if orientation is horizontal then this parameter refers to the height, if vertical then it refers to the length ).
* strokeWidth (default: 1 ) - the width of the stroke (how many blocks) - if drawing nested arcs it's usually a good idea to set strokeWidth to at least 2 so that there are no gaps between each arc. The arc method uses a [bresenham algorithm][bres] to plot points along the circumference.
* fill - If true (or present) then the arc will be filled in.
* quadrants (default: `{topleft:true,topright:true,bottomleft:true,bottomright:true}` - An object with 4 properties indicating which of the 4 quadrants of a circle to draw. If the quadrants property is absent then all 4 quadrants are drawn.
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Examples
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To draw a 1/4 circle (top right quadrant only) with a radius of 10 and
stroke width of 2 blocks ...
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
arc({blockType: blocks.iron,
meta: 0,
radius: 10,
strokeWidth: 2,
quadrants: { topright: true },
orientation: 'vertical',
stack: 1,
fill: false
} );
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![arc example 1](img/arcex1.png)
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[bres]: http://en.wikipedia.org/wiki/Midpoint_circle_algorithm
[dv]: http://www.minecraftwiki.net/wiki/Data_values
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.bed() method
Creates a bed. The foot of the bed will be at the drone's location and
the head of the bed will extend away from the drone.
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a bed at the in-game prompt, look at a block then type:
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
/js bed()
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
```
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Like most Drone methods, this returns the drone so it can be chained like so:
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
this
.fwd(3)
.bed()
.back(3)
```
### Drone.blocktype() method
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates the text out of blocks. Useful for large-scale in-game signs.
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* message - The message to create - (use `\n` for newlines)
* foregroundBlock (default: black wool) - The block to use for the foreground
* backgroundBlock (default: none) - The block to use for the background
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a 2-line high message using glowstone...
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
blocktype("Hello\nWorld",blocks.glowstone);
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![blocktype example][imgbt1]
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[imgbt1]: img/blocktype1.png
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Copy & Paste using Drone
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
A drone can be used to copy and paste areas of the game world.
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
deprecating Drone.copy() and Drone.paste() and updating to 3.1.0
2015-01-10 12:45:08 +01:00
#### Deprecated
As of January 10 2015 the copy-paste functions in Drone are no longer
supported. Copy/Paste is:
1. Difficult to do correctly in a way which works for both Minecraft 1.7 and 1.8
due to how blocks changed in 1.8
2. Not aligned with the purpose of ScriptCraft's Drone module which is to provide
a simple set of functions for scripting and in-game building.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.copy() method
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Copies an area so it can be pasted elsewhere. The name can be used for
pasting the copied area elsewhere...
Improved documentation of the utils module and fixed bug in signs module due to changes to serialization/deserialization of locations.
2013-12-31 21:12:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Added 2 new example plugins and changed drone so that public extensions (box, sphere, etc) pass 'self' as first param to Drone constructor (part of eventual phase-out of 'self' variable).
2013-12-31 19:21:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* name - the name to be given to the copied area (used by `paste`)
* width - the width of the area to copy
* height - the height of the area to copy
* length - the length of the area (extending away from the drone) to copy
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.copy('somethingCool',10,5,10 ).right(12 ).paste('somethingCool' );
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.paste() method
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Pastes a copied area to the current location.
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To copy a 10x5x10 area (using the drone's coordinates as the starting
point) into memory. the copied area can be referenced using the name
'somethingCool'. The drone moves 12 blocks right then pastes the copy.
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.copy('somethingCool',10,5,10 )
.right(12 )
.paste('somethingCool' );
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.cylinder() method
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
A convenience method for building cylinders. Building begins radius blocks to the right and forward.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* block - the block id - e.g. 6 for an oak sapling or '6:2' for a birch sapling. Alternatively you can use any one of the `blocks` values e.g. `blocks.sapling.birch`
* radius
* height
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a cylinder of Iron 7 blocks in radius and 1 block high...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
cylinder(blocks.iron, 7 , 1);
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![cylinder example](img/cylinderex1.png)
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.cylinder0() method
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
A version of cylinder that hollows out the middle.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a hollow cylinder of Iron 7 blocks in radius and 1 block high...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
cylinder0(blocks.iron, 7, 1);
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![cylinder0 example](img/cylinder0ex1.png)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.door() method
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
create a door - if a parameter is supplied an Iron door is created otherwise a wooden door is created.
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* doorType (optional - default wood) - If a parameter is provided then the door is Iron.
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a wooden door at the crosshairs/drone's location...
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var drone = new Drone(self);
drone.door();
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create an iron door...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.door( blocks.door_iron );
added syntax-highlighting to code samples
2014-02-04 22:36:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![iron door](img/doorex1.png)
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.door_iron() method
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
create an Iron door.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.door2() method
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Create double doors (left and right side)
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* doorType (optional - default wood) - If a parameter is provided then the door is Iron.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create double-doors at the cross-hairs/drone's location...
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.door2();
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![double doors](img/door2ex1.png)
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.door2_iron() method
Create double iron doors
### Drone.firework() method
Launches a firework at the drone's location.
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To launch a firework:
update based on changes to watchDir()
2014-08-23 14:40:50 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var drone = new Drone(self);
drone.firework();
update based on changes to watchDir()
2014-08-23 14:40:50 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.garden() method
update based on changes to watchDir()
2014-08-23 14:40:50 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
places random flowers and long grass (similar to the effect of placing bonemeal on grass)
update based on changes to watchDir()
2014-08-23 14:40:50 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Added 'utils.unwatchFile()' function to fix #117
2014-02-11 22:10:56 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* width - the width of the garden
* length - how far from the drone the garden extends
Added 'utils.unwatchFile()' function to fix #117
2014-02-11 22:10:56 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a garden 10 blocks wide by 5 blocks long...
update based on changes to watchDir()
2014-08-23 14:40:50 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
garden(10,5);
update based on changes to watchDir()
2014-08-23 14:40:50 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![garden example](img/gardenex1.png)
update based on changes to watchDir()
2014-08-23 14:40:50 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.ladder() method
Improved Tab completion to work with Java Enums on JRE7 and JRE8. Added bukkit namespace.
2014-05-20 01:05:38 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a ladder extending skyward.
Improved Tab completion to work with Java Enums on JRE7 and JRE8. Added bukkit namespace.
2014-05-20 01:05:38 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
Fixed bug in creating signs in canarymod and updated minigames/scoreboard to work with example code from book.
2014-10-12 19:34:40 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* height (optional - default 1)
Fixed bug in creating signs in canarymod and updated minigames/scoreboard to work with example code from book.
2014-10-12 19:34:40 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Fixed bug in creating signs in canarymod and updated minigames/scoreboard to work with example code from book.
2014-10-12 19:34:40 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a ladder extending 10 blocks high:
Fixed bug in creating signs in canarymod and updated minigames/scoreboard to work with example code from book.
2014-10-12 19:34:40 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var drone = new Drone(self);
drone.ladder(10)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
At the in-game prompt, look at a block and then type:
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js ladder(10)
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
A ladder 10 blocks high will be created at the point you were looking at.
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Since
##### 3.0.3
### Drone Movement
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Drones can move freely in minecraft's 3-D world. You control the
Drone's movement using any of the following methods..
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* up()
* down()
* left()
* right()
* fwd()
* back()
* turn()
Added utils.worlds() and utils.stat. enums
2014-10-18 13:08:00 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... Each of these methods takes a single optional parameter
`numBlocks` - the number of blocks to move in the given direction. If
no parameter is given, the default is 1.
Added utils.worlds() and utils.stat. enums
2014-10-18 13:08:00 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To change direction use the `turn()` method which also takes a single
optional parameter (numTurns) - the number of 90 degree turns to
make. Turns are always clock-wise. If the drone is facing north, then
drone.turn() will make the turn face east. If the drone is facing east
then drone.turn(2) will make the drone turn twice so that it is facing
west.
Added utils.worlds() and utils.stat. enums
2014-10-18 13:08:00 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone Positional Info
Added utils.worlds() and utils.stat. enums
2014-10-18 13:08:00 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* getLocation() - Returns a native Java Location object for the drone
Added utils.worlds() and utils.stat. enums
2014-10-18 13:08:00 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone Markers
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Markers are useful when your Drone has to do a lot of work. You can
set a check-point and return to the check-point using the move()
method. If your drone is about to undertake a lot of work -
e.g. building a road, skyscraper or forest you should set a
check-point before doing so if you want your drone to return to its
current location.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
A 'start' checkpoint is automatically created when the Drone is first created.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Markers are created and returned to using the followng two methods...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* chkpt - Saves the drone's current location so it can be returned to later.
* move - moves the drone to a saved location. Alternatively you can provide a Java Location object or x,y,z and direction parameters.
made blocks a module rather than a plugin
2013-12-25 14:39:04 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
made blocks a module rather than a plugin
2013-12-25 14:39:04 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* name - the name of the checkpoint to save or return to.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.chkpt('town-square');
//
// the drone can now go off on a long excursion
//
for ( i = 0; i< 100; i++) {
drone.fwd(12).box(6);
}
//
// return to the point before the excursion
//
drone.move('town-square');
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.prism() method
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a prism. This is useful for roofs on houses.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* block - the block id - e.g. 6 for an oak sapling or '6:2' for a birch sapling.
Alternatively you can use any one of the `blocks` values e.g. `blocks.sapling.birch`
* width - the width of the prism
* length - the length of the prism (will be 2 time its height)
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
prism(blocks.oak,3,12);
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![prism example](img/prismex1.png)
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.prism0() method
A variation on `prism` which hollows out the inside of the prism. It
uses the same parameters as `prism`.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.rand() method
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
rand takes either an array (if each blockid has the same chance of occurring) or an object where each property is a blockid and the value is it's weight (an integer)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
place random blocks stone, mossy stone and cracked stone (each block has the same chance of being picked)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
rand( [blocks.brick.stone, blocks.brick.mossy, blocks.brick.cracked ],w,d,h)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
to place random blocks stone has a 50% chance of being picked,
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var distribution = {};
distribution[ blocks.brick.stone ] = 5;
distribution[ blocks.brick.mossy ] = 3;
distribution[ blocks.brick.cracked ] = 2;
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
rand( distribution, width, height, depth)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
regular stone has a 50% chance, mossy stone has a 30% chance and cracked stone has just a 20% chance of being picked.
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.wallsign() method
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a wall sign (A sign attached to a wall)
reorg
2013-12-24 01:15:17 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* message - can be a string or an array of strings
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.wallsign(['Welcome','to','Scriptopia']);
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![wall sign](img/signex2.png)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.signpost() method
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a free-standing signpost
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* message - can be a string or an array of strings
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.signpost(['Hello','World']);
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![ground sign](img/signex1.png)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.sign() method
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Deprecated: Use signpost() or wallsign() methods instead.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Signs must use block 63 (stand-alone signs) or 68 (signs on walls)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* message - can be a string or an array of strings.
* block - can be 63 or 68
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a free-standing sign...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.sign(["Hello","World"], blocks.sign_post);
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![ground sign](img/signex1.png)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... to create a wall mounted sign...
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
drone.sign(["Welcome","to","Scriptopia"], blocks.sign );
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![wall sign](img/signex2.png)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.sphere() method
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a sphere.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* block - The block the sphere will be made of.
* radius - The radius of the sphere.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a sphere of Iron with a radius of 10 blocks...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
sphere( blocks.iron, 10);
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![sphere example](img/sphereex1.png)
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Spheres are time-consuming to make. You *can* make large spheres (250 radius) but expect the
server to be very busy for a couple of minutes while doing so.
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.sphere0() method
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates an empty sphere.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
* block - The block the sphere will be made of.
* radius - The radius of the sphere.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a sphere of Iron with a radius of 10 blocks...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
sphere0( blocks.iron, 10);
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Spheres are time-consuming to make. You *can* make large spheres (250 radius) but expect the
server to be very busy for a couple of minutes while doing so.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.hemisphere() method
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a hemisphere. Hemispheres can be either north or south.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* block - the block the hemisphere will be made of.
* radius - the radius of the hemisphere
* northSouth - whether the hemisphere is 'north' or 'south'
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a wood 'north' hemisphere with a radius of 7 blocks...
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
hemisphere(blocks.oak, 7, 'north');
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![hemisphere example](img/hemisphereex1.png)
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.hemisphere0() method
Further testing and tweaking of Documentation.
2014-12-30 19:12:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a hollow hemisphere. Hemispheres can be either north or south.
Further testing and tweaking of Documentation.
2014-12-30 19:12:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* block - the block the hemisphere will be made of.
* radius - the radius of the hemisphere
* northSouth - whether the hemisphere is 'north' or 'south'
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create a glass 'north' hemisphere with a radius of 20 blocks...
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
hemisphere0(blocks.glass, 20, 'north');
Further testing and tweaking of Documentation.
2014-12-30 19:12:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![hemisphere example](img/hemisphereex2.png)
Further testing and tweaking of Documentation.
2014-12-30 19:12:10 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.stairs() function
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The stairs() function will build a flight of stairs
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* blockType - should be one of the following:
* blocks.stairs.oak
* blocks.stairs.cobblestone
* blocks.stairs.brick
* blocks.stairs.stone
* blocks.stairs.nether
* blocks.stairs.sandstone
* blocks.stairs.spruce
* blocks.stairs.birch
* blocks.stairs.jungle
* blocks.stairs.quartz
* width - The width of the staircase - default is 1
* height - The height of the staircase - default is 1
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To build an oak staircase 3 blocks wide and 5 blocks tall:
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js stairs(blocks.stairs.oak, 3, 5)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Staircases do not have any blocks beneath them.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone Trees methods
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* oak()
* spruce()
* birch()
* jungle()
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To create 4 trees in a row, point the cross-hairs at the ground then type `/js ` and ...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
up( ).oak( ).right(8 ).spruce( ).right(8 ).birch( ).right(8 ).jungle( );
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Trees won't always generate unless the conditions are right. You
should use the tree methods when the drone is directly above the
ground. Trees will usually grow if the drone's current location is
occupied by Air and is directly above an area of grass (That is why
the `up()` method is called first).
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![tree example](img/treeex1.png)
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
None of the tree methods require parameters. Tree methods will only be
successful if the tree is placed on grass in a setting where trees can
grow.
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.rainbow() method
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Creates a Rainbow.
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* radius (optional - default:18) - The radius of the rainbow
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
var d = new Drone();
d.rainbow(30);
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![rainbow example](img/rainbowex1.png)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Drone.spiral_stairs() method
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Constructs a spiral staircase with slabs at each corner.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* stairBlock - The block to use for stairs, should be one of the following...
- 'oak'
- 'spruce'
- 'birch'
- 'jungle'
- 'cobblestone'
- 'brick'
- 'stone'
- 'nether'
- 'sandstone'
- 'quartz'
* flights - The number of flights of stairs to build.
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![Spiral Staircase](img/spiralstair1.png)
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To construct a spiral staircase 5 floors high made of oak...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
spiral_stairs('oak', 5);
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Blocks Module
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
You hate having to lookup [Data Values][dv] when you use ScriptCraft's
Drone() functions. So do I. So I created this blocks object which is
a helper object for use in construction.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Examples
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
box( blocks.oak ); // creates a single oak wood block
box( blocks.sand, 3, 2, 1 ); // creates a block of sand 3 wide x 2 high x 1 long
box( blocks.wool.green, 2 ); // creates a block of green wool 2 blocks wide
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Color aliased properties that were a direct descendant of the blocks
object are no longer used to avoid confusion with carpet and stained
clay blocks. In addition, there's a convenience array `blocks.rainbow`
which is an array of the 7 colors of the rainbow (or closest
approximations).
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The blocks module is globally exported by the Drone module.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Fireworks Module
Drone.garden() is now non-destructive - won't destroy existing blocks.
2014-02-19 01:15:44 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The fireworks module makes it easy to create fireworks using
ScriptCraft. The module has a single function `firework` which takes
a `org.bukkit.Location` as its 1 and only parameter.
Drone.garden() is now non-destructive - won't destroy existing blocks.
2014-02-19 01:15:44 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Examples
Drone.garden() is now non-destructive - won't destroy existing blocks.
2014-02-19 01:15:44 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The module also extends the `Drone` object adding a `firework` method
so that fireworks can be created as a part of a Drone chain. For
Example....
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js firework()
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... creates a single firework, while ....
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js firework().fwd(3).times(5)
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... creates 5 fireworks in a row. Fireworks have also been added as a
possible option for the `arrow` module. To have a firework launch
where an arrow strikes...
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js arrows.firework()
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To call the fireworks.firework() function directly, you must provide a
location. For example...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js var fireworks = require('fireworks');
/js fireworks.firework( self.location );
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
![firework example](img/firework.png)
Drone.garden() is now non-destructive - won't destroy existing blocks.
2014-02-19 01:15:44 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Asynchronous Input Module
Drone.garden() is now non-destructive - won't destroy existing blocks.
2014-02-19 01:15:44 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The `input` module provides a simple way to prompt players for input at the
in-game prompt. In Javascript browser environments the `prompt()` function provides
a way to block execution and ask the user for input. Execution is blocked until the user
provides input using the modal dialog and clicks OK. Unfortunately Minecraft provides no
equivalent modal dialog which can be used to gather player text input. The only way to gather text
input from the player in Minecraft is to do so asynchronously. That is - a prompt message can be
sent to the player but the player is not obliged to provide input immediately, nor does the program
execution block until the player does so.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
So ScriptCraft has no `prompt()` implementation because `prompt()` is a synchronous function and
Minecraft's API provides no equivalent functions or classes which can be used to implement this synchronously.
The Minecraft API does however have a 'Conversation' API which allows for prompting of the player and asynchronously gathering text input from the player.
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This new `input()` function is best illustrated by example. The following code is for a number-guessing game:
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var input = require('input');
exports.numberguess = function(player){
var randomNumber = Math.ceil(Math.random() * 10);
input( player, 'Think of a number between 1 and 10 (q to quit)', function( guess, guesser, repeat ) {
if ( guess == 'q'){
return;
}
if ( +guess !== randomNumber ) {
if (+guess < randomNumber ) {
echo( guesser, 'Too low - guess again');
}
if (+guess > randomNumber ) {
echo( guesser, 'Too high - guess again');
}
repeat();
} else {
echo( guesser, 'You guessed correctly');
}
});
};
```
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The `input()` function takes 3 parameters, the player, a prompt message and a callback which will be invoked when the player has entered some text at the in-game command prompt.
The callback is bound to an object which has the following properties:
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* sender : The player who input the text
* value : The value of the text which has been input.
* message: The message prompt.
* repeat: A function which when invoked will repeat the original prompt. (this is for flow control)
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The callback function as well as being bound to an object with the above properties (so you can use this.value inside your callback to get the value which has just been input), can also take the following parameters (in exact order):
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* value
* sender
* repeat
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The `value` parameter will be the same as `this.value`, the `repeat` parameter will be the same as `this.repeat` and so on.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## The recipes module
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The Recipes module provides convenience functions for adding and removing recipes
from the game.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Example
To add an EnderBow to the game (assumes there's an enchanted Item variable called enderBow)...
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var recipes = require('recipes');
var items = require('items');
...
var enderBowRecipe = recipes.create( {
result: enderBow,
ingredients: {
E: items.enderPearl(1),
S: items.stick(1),
W: items.string(1)
},
shape: [ 'ESW',
'SEW',
'ESW' ]
} );
// add to server
var addedRecipe = server.addRecipe( enderBowRecipe );
// to remove...
server.removeRemove( addedRecipe );
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Http Module
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
For handling http requests. Not to be confused with the more robust
and functional 'http' module bundled with Node.js.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### http.request() function
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The http.request() function will fetch a web address asynchronously (on a
separate thread)and pass the URL's response to a callback function
which will be executed synchronously (on the main thread). In this
way, http.request() can be used to fetch web content without blocking the
main thread of execution.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* request: The request details either a plain URL e.g. "http://scriptcraft.js/sample.json" or an object with the following properties...
- url: The URL of the request.
- method: Should be one of the standard HTTP methods, GET, POST, PUT, DELETE (defaults to GET).
- params: A Javascript object with name-value pairs. This is for supplying parameters to the server.
* callback: The function to be called when the Web request has completed. This function takes the following parameters...
- responseCode: The numeric response code from the server. If the server did not respond with 200 OK then the response parameter will be undefined.
- response: A string (if the response is of type text) or object containing the HTTP response body.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The following example illustrates how to use http.request to make a request to a JSON web service and evaluate its response...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var jsResponse;
var http = require('./http/request');
http.request("http://scriptcraftjs.org/sample.json",function(responseCode, responseBody){
jsResponse = eval("(" + responseBody + ")");
});
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... The following example illustrates a more complex use-case POSTing parameters to a CGI process on a server...
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var http = require('./http/request');
http.request(
{
url: 'http://pixenate.com/pixenate/pxn8.pl',
method: 'POST',
params: {script: '[]'}
},
function( responseCode, responseBody ) {
var jsObj = eval('(' + responseBody + ')');
});
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## sc-mqtt module
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This module provides a simple way to communicate with devices (such as Arduino)
using the popular lightweight [MQTT protocol][mqtt].
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Usage
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This module can only be used if the separate `sc-mqtt.jar` file is
present in the CraftBukkit classpath. To use this module, you should
...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
1. Download sc-mqtt.jar from <http://scriptcraftjs.org/download/extras/>
2. Save the file to the same directory where craftbukkit.jar resides.
3. Create a new batch file (windows-only) called
craftbukkit-sc-mqtt.bat and edit it to include the following
command...
Drone.garden() is now non-destructive - won't destroy existing blocks.
2014-02-19 01:15:44 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```sh
java -classpath sc-mqtt.jar;craftbukkit.jar org.bukkit.craftbukkit.Main
```
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
If you're using Mac OS, create a new craftbukkit-sc-mqtt.command
file and edit it (using TextWrangler or another text editor) ...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```sh
java -classpath sc-mqtt.jar:craftbukkit.jar org.bukkit.craftbukkit.Main
```
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
4. Execute the craftbukkit-sc-mqtt batch file / command file to start
Craftbukkit. You can now begin using this module to send and receive
messages to/from a Net-enabled Arduino or any other device which uses
the [MQTT protocol][mqtt]
```javascript
var mqtt = require('sc-mqtt');
// create a new client
var client = mqtt.client( 'tcp://localhost:1883', 'uniqueClientId' );
// connect to the broker
client.connect( { keepAliveInterval: 15 } );
// publish a message to the broker
client.publish( 'minecraft', 'loaded' );
// subscribe to messages on 'arduino' topic
client.subscribe( 'arduino' );
// do something when an incoming message arrives...
client.onMessageArrived( function( topic, message ) {
console.log( 'Message arrived: topic=' + topic + ', message=' + message );
});
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The `sc-mqtt` module provides a very simple minimal wrapper around the
[Eclipse Paho MQTT Version 3 Client][pahodocs] java-based MQTT
library.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[pahodocs]: http://pic.dhe.ibm.com/infocenter/wmqv7/v7r5/index.jsp?topic=/com.ibm.mq.javadoc.doc/WMQMQxrClasses/org/eclipse/paho/client/mqttv3/package-summary.html
[mqtt]: http://mqtt.org/
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Signs Module
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The Signs Module can be used by plugin authors to create interactive
signs - that is - signs which display a list of choices which can be
changed by interacting (right-clicking) with the sign.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### signs.menu() function
This function is used to construct a new interactive menu on top of an
existing sign in the game world.
improved require function
2013-12-18 00:49:00 +01:00
including api
2014-12-28 16:07:32 +01:00
#### Parameters
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* Label : A string which will be displayed in the topmost line of the
sign. This label is not interactive.
* options : An array of strings which can be selected on the sign by
right-clicking/interacting.
* callback : A function which will be called whenever a player
interacts (changes selection) on a sign. This callback in turn
takes as its parameter, an object with the following properties...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* player : The player who interacted with the sign.
* sign : The [org.bukkit.block.Sign][buksign] which the player interacted with.
* text : The text for the currently selected option on the sign.
* number : The index of the currently selected option on the sign.
* selectedIndex : optional: A number (starting at 0) indicating which
of the options should be selected by default. 0 is the default.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Returns
This function does not itself do much. It does however return a
function which when invoked with a given
[org.bukkit.block.Sign][buksign] object, will convert that sign into
an interactive sign.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example: Create a sign which changes the time of day.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
##### plugins/signs/time-of-day.js
```javascript
var utils = require('utils'),
signs = require('signs');
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var onTimeChoice = function(event){
var selectedIndex = event.number;
// convert to Minecraft time 0 = Dawn, 6000 = midday, 12000 = dusk, 18000 = midnight
var time = selectedIndex * 6000;
event.player.location.world.setTime(time);
};
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
// signs.menu returns a function which can be called for one or more signs in the game.
var convertToTimeMenu = signs.menu('Time of Day',
['Dawn', 'Midday', 'Dusk', 'Midnight'],
onTimeChoice);
exports.time_sign = function( player ){
var sign = signs.getTargetedBy(player);
if ( !sign ) {
throw new Error('You must look at a sign');
}
convertToTimeMenu(sign);
};
```
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To use the above function at the in-game prompt, look at an existing
sign and type...
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js time_sign(self);
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... and the sign you're looking at will become an interactive sign
which changes the time each time you interact (right-click) with it.
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### signs.getTargetedBy() function
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This function takes a [org.bukkit.entity.LivingEntity][bukle] as a
parameter and returns a [org.bukkit.block.Sign][buksign] object which
the entity has targeted. It is a utility function for use by plugin authors.
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var signs = require('signs'),
utils = require('utils');
var player = utils.player('tom1234');
var sign = signs.getTargetedBy( player );
if ( !sign ) {
echo( player, 'Not looking at a sign');
}
```
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[buksign]: http://jd.bukkit.org/dev/apidocs/org/bukkit/block/Sign.html
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Sounds Module
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This module is a simple wrapper around the Bukkit Sound class and provides
a simpler way to play sounds. All of the org.bukkit.Sound Enum values are attached.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### Usage (Bukkit) :
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var sounds = require('sounds');
sounds.play( bukkit.sound.VILLAGER_NO , self, 1, 0); // plays VILLAGER_NO sound at full volume and medium pitch
sounds.play( bukkit.sound.VILLAGER_NO , self ); // same as previous statement
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The play() function takes either a Location object or any object which has a location.
The volume parameter is in the range 0 to 1 and the pitch parameter is in the range 0 to 4.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
In addition, a play function is provided for each possible sound using the following rules:
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
1. The sound is converted from ALL_CAPS_UNDERSCORE to camelCase so for example there is a sounds.villagerNo() function which will play the VILLAGER_NO sound.
2. Each such function can take 3 parameters: location (which can be either an actual Location object or an object which has a location), volume and pitch
3. Or... each such function can be called without parameters meaning the sound will be played for all online players to hear.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
sounds.villagerNo(self, 1, 0); // plays VILLAGER_NO sound at full volume and medium pitch at invoker's location
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
sounds.villagerNo(); // plays VILLAGER_NO sound for all players online.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
These methods are provided for convenience to help beginners explore sounds using TAB completion.
String class extensions
-----------------------
The following chat-formatting methods are added to the javascript String class..
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* aqua()
* black()
* blue()
* bold()
* brightgreen()
* darkaqua()
* darkblue()
* darkgray()
* darkgreen()
* purple()
* darkpurple()
* darkred()
* gold()
* gray()
* green()
* italic()
* lightpurple()
* indigo()
* green()
* red()
* pink()
* yellow()
* white()
* strike()
* random()
* magic()
* underline()
* reset()
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Example
-------
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
/js var boldGoldText = "Hello World".bold().gold();
/js echo(self, boldGoldText );
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
<p style="color:gold;font-weight:bold">Hello World</p>
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
## Utilities Module
doc changes - change ref of js-plugins to scriptcraft/plugins
2014-05-26 22:03:47 +02:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The `utils` module is a storehouse for various useful utility
functions which can be used by plugin and module authors. It contains
miscellaneous utility functions and classes to help with programming.
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.player() function
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The utils.player() function will return a [bukkit Player][bkpl] object
with the given name. This function takes a single parameter
`playerName` which can be either a String or a [Player][bkpl] object -
if it's a Player object, then the same object is returned. If it's a
String, then it tries to find the player with that name.
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
including api
2014-12-28 16:07:32 +01:00
#### Parameters
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* playerName : A String or Player object. If no parameter is provided
then player() will try to return the `self` variable . It is
strongly recommended to provide a parameter.
improved require function
2013-12-18 00:49:00 +01:00
including api
2014-12-28 16:07:32 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
var name = 'walterh';
var player = utils.player(name);
if ( player ) {
echo(player, 'Got ' + name);
} else {
console.log('No player named ' + name);
}
```
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[bkpl]: http://jd.bukkit.org/dev/apidocs/org/bukkit/entity/Player.html
[bkloc]: http://jd.bukkit.org/dev/apidocs/org/bukkit/Location.html
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
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 01:11:44 +01:00
### utils.world( worldName ) function
Returns a World object matching the given name
### utils.blockAt( Location ) function
Returns the Block at the given location.
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.locationToJSON() function
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
utils.locationToJSON() returns a [org.bukkit.Location][bkloc] object in JSON form...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
{ world: 'world5',
x: 56.9324,
y: 103.9954,
z: 43.1323,
yaw: 0.0,
pitch: 0.0
}
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This can be useful if you write a plugin that needs to store location data since bukkit's Location object is a Java object which cannot be serialized to JSON by default.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* location: An object of type [org.bukkit.Location][bkloc]
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Returns
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
A JSON object in the above form.
### utils.locationToString() function
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The utils.locationToString() function returns a
[org.bukkit.Location][bkloc] object in string form...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
'{"world":"world5",x:56.9324,y:103.9954,z:43.1323,yaw:0.0,pitch:0.0}'
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... which can be useful if you write a plugin which uses Locations as
keys in a lookup table.
improved require function
2013-12-18 00:49:00 +01:00
including api
2014-12-28 16:07:32 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
...
var key = utils.locationToString(player.location);
lookupTable[key] = player.name;
```
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.locationFromJSON() function
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This function reconstructs an [org.bukkit.Location][bkloc] object from
a JSON representation. This is the counterpart to the
`locationToJSON()` function. It takes a JSON object of the form
returned by locationToJSON() and reconstructs and returns a bukkit
Location object.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.getPlayerPos() function
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This function returns the player's [Location][bkloc] (x, y, z, pitch
and yaw) for a named player. If the "player" is in fact a
[org.bukkit.command.BlockCommandSender][bkbcs] then the attached
Block's location is returned.
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* player : A [org.bukkit.command.CommandSender][bkbcs] (Player or BlockCommandSender) or player name (String).
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Returns
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
An [org.bukkit.Location][bkloc] object.
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[bkbcs]: http://jd.bukkit.org/dev/apidocs/org/bukkit/command/BlockCommandSender.html
[bksndr]: http://jd.bukkit.org/dev/apidocs/index.html?org/bukkit/command/CommandSender.html
### utils.getMousePos() function
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This function returns a [org.bukkit.Location][bkloc] object (the
x,y,z) of the current block being targeted by the named player. This
is the location of the block the player is looking at (targeting).
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* player : The player whose targeted location you wish to get.
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The following code will strike lightning at the location the player is looking at...
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
var playerName = 'walterh';
var targetPos = utils.getMousePos(playerName);
if (targetPos){
targetPos.world.strikeLightning(targetPos);
}
```
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.foreach() function
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The utils.foreach() function is a utility function for iterating over
an array of objects (or a java.util.Collection of objects) and processing each object in turn. Where
utils.foreach() differs from other similar functions found in
javascript libraries, is that utils.foreach can process the array
immediately or can process it *nicely* by processing one item at a
time then delaying processing of the next item for a given number of
server ticks (there are 20 ticks per second on the minecraft main
thread). This method relies on Bukkit's [org.bukkit.scheduler][sched]
package for scheduling processing of arrays.
Automatically apply correct facing metadata if missing from certain blocks. apply this metadata as properties in 1.8. (Part of work preparing for 1.8)
2014-12-30 15:54:38 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[sched]: http://jd.bukkit.org/beta/apidocs/org/bukkit/scheduler/package-summary.html
reorg
2013-12-24 01:15:17 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* array : The array to be processed - It can be a javascript array, a java array or java.util.Collection
* callback : The function to be called to process each item in the
array. The callback function should have the following signature
`callback(item, index, object, array)`. That is the callback will
be called with the following parameters....
reorg
2013-12-24 01:15:17 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
- item : The item in the array
- index : The index at which the item can be found in the array.
- object : Additional (optional) information passed into the foreach method.
- array : The entire array.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* context (optional) : An object which may be used by the callback.
* delay (optional, numeric) : If a delay is specified (in ticks - 20
ticks = 1 second), then the processing will be scheduled so that
each item will be processed in turn with a delay between the completion of each
item and the start of the next. This is recommended for big builds (say 200 x 200 x 200
blocks) or any CPU-intensive process.
* onDone (optional, function) : A function to be executed when all processing
is complete. This parameter is only used when the processing is delayed. (It's optional even if a
delay parameter is supplied).
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
If called with a delay parameter then foreach() will return
immediately after processing just the first item in the array (all
subsequent items are processed later). If your code relies on the
completion of the array processing, then provide an `onDone` parameter
and put the code there.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The following example illustrates how to use foreach for immediate processing of an array...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
var players = ['moe', 'larry', 'curly'];
utils.foreach (players, function(item){
echo( server.getPlayer(item), 'Hi ' + item);
});
```
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... The `utils.foreach()` function can work with Arrays or any Java-style collection. This is important
because many objects in the Bukkit API use Java-style collections...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
utils.foreach( server.onlinePlayers, function(player){
player.chat('Hello!');
});
```
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
... the above code sends a 'Hello!' to every online player.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The following example is a more complex use case - The need to build an enormous structure
without hogging CPU usage...
```javascript
// build a structure 200 wide x 200 tall x 200 long
// (That's 8 Million Blocks - enough to tax any machine!)
var utils = require('utils');
var a = [];
a.length = 200;
var drone = new Drone();
var processItem = function(item, index, object, array){
// build a box 200 wide by 200 long then move up
drone.box(blocks.wood, 200, 1, 200).up();
};
// by the time the job's done 'self' might be someone else
// assume this code is within a function/closure
var player = self;
var onDone = function(){
echo( player, 'Job Done!');
};
utils.foreach (a, processItem, null, 10, onDone);
```
### utils.nicely() function
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The utils.nicely() function is for performing processing using the
[org.bukkit.scheduler][sched] package/API. utils.nicely() lets you
process with a specified delay between the completion of each `next()`
function and the start of the next `next()` function.
`utils.nicely()` is a recursive function - that is - it calls itself
(schedules itself actually) repeatedly until `hasNext` returns false.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* next : A function which will be called if processing is to be done.
* hasNext : A function which is called to determine if the `next`
callback should be invoked. This should return a boolean value -
true if the `next` function should be called (processing is not
complete), false otherwise.
* onDone : A function which is to be called when all processing is complete (hasNext returned false).
* delay : The delay (in server ticks - 20 per second) between each call.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
See the source code to utils.foreach for an example of how utils.nicely is used.
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.at() function
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The utils.at() function will perform a given task at a given time every
(minecraft) day.
updating docs for module release
2013-12-24 23:47:57 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* time24hr : The time in 24hr form - e.g. 9:30 in the morning is '09:30' while
9:30 pm is '21:30', midnight is '00:00' and midday is '12:00'
* callback : A javascript function which will be invoked at the given time.
* worlds : (optional) An array of worlds. Each world has its own clock. If no array of worlds is specified, all the server's worlds are used.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
To warn players when night is approaching...
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
utils.at( '19:00', function() {
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
utils.foreach( server.onlinePlayers, function( player ) {
player.chat( 'The night is dark and full of terrors!' );
});
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
});
```
Fix issue #193
2015-01-11 13:27:47 +01:00
### utils.time( world ) function
Returns the timeofday (in minecraft ticks) for the given world. This function is necessary because
canarymod and bukkit differ in how the timeofday is calculated.
See http://minecraft.gamepedia.com/Day-night_cycle#Conversions
### utils.time24( world ) function
Returns the timeofday for the given world using 24 hour notation. (number of minutes)
See http://minecraft.gamepedia.com/Day-night_cycle#Conversions
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.find() function
The utils.find() function will return a list of all files starting at
a given directory and recursiving trawling all sub-directories.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* dir : The starting path. Must be a string.
* filter : (optional) A [FilenameFilter][fnfltr] object to return only files matching a given pattern.
[fnfltr]: http://docs.oracle.com/javase/6/docs/api/java/io/FilenameFilter.html
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
var jsFiles = utils.find('./', function(dir,name){
return name.match(/\.js$/);
});
```
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.serverAddress() function
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
The utils.serverAddress() function returns the IP(v4) address of the server.
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
var serverAddress = utils.serverAddress();
console.log(serverAddress);
```
### utils.watchFile() function
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Watches for changes to the given file or directory and calls the function provided
when the file changes.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* File - the file to watch (can be a file or directory)
* Callback - The callback to invoke when the file has changed. The callback takes the
changed file as a parameter.
improved require function
2013-12-18 00:49:00 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
utils.watchFile( 'test.txt', function( file ) {
console.log( file + ' has changed');
});
```
### utils.watchDir() function
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Watches for changes to the given directory and calls the function provided
when the directory changes. It works by calling watchFile/watchDir for each
file/subdirectory.
reorg
2013-12-24 01:15:17 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Parameters
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* Dir - the file to watch (can be a file or directory)
* Callback - The callback to invoke when the directory has changed.
The callback takes the changed file as a parameter.
For each change inside the directory the callback will also
be called.
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
utils.watchDir( 'players/_ial', function( dir ) {
console.log( dir + ' has changed');
});
```
### utils.unwatchFile() function
Removes a file from the watch list.
updating docs for module release
2013-12-24 23:47:57 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
#### Example
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
```javascript
var utils = require('utils');
utils.unwatchFile( 'test.txt');
```
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.unwatchDir() function
updating docs for module release
2013-12-24 23:47:57 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Removes a directory from the watch list and all files inside the directory
are also "unwatched"
improved require function
2013-12-18 00:49:00 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example
```javascript
var utils = require('utils');
utils.unwatchDir ('players/_ial');
```
Would cause also
```javascript
utils.unwatchFile (file);
```
for each file inside directory (and unwatchDir for each directory inside it)
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.array() function
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
Converts Java collection objects to type Javascript array so they can avail of
all of Javascript's Array goodness.
#### Example
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var utils = require('utils');
var worlds = utils.array(server.worlds);
### utils.players() function
including api
2014-12-28 16:07:32 +01:00
Fix issue #193
2015-01-11 13:27:47 +01:00
This function returns a javascript array of all online players on the
server. You can optionally provide a function which will be invoked
with each player as a parameter. For example, to give each player the
ability to shoot arrows which launch fireworks:
```javascript
require('utils').players( arrows.firework )
```
Any players with a bow will be able to launch fireworks by shooting.
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.playerNames() function
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This function returns a javascript array of player names (as javascript strings)
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
### utils.stat() function
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This function returns a numeric value for a given player statistic.
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Parameters
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
* Player - The player object (optional - if only the statistic name parameter is provided then the statistic object is returned)
* Statistic - A string whose value should be one of the following (CanaryMod)
* ANIMALSBRED
* BOATONECM
* CLIMBONECM
* CROUCHONECM
* DAMAGEDEALT
* DAMAGETAKEN
* DEATHS
* DRIVEONECM
* DROP
* FALLONECM
* FISHCAUGHT
* FLYONECM
* HORSEONECM
* JUMP
* JUNKFISHED
* LEAVEGAME
* MINECARTONECM
* MOBKILLS
* PIGONECM
* PLAYERKILLS
* PLAYONEMINUTE
* SPRINTONECM
* SWIMONECM
* TALKEDTOVILLAGER
* TIMESINCEDEATH
* TRADEDWITHVILLAGER
* TREASUREFISHED
* WALKONECM
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
See [CanaryMod's Statistic][cmstat] class for an up-to-date list of possible stat values
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
[cmstat]: https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/api/statistics/Statistics.html
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example 1 Getting stats for a player
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var utils = require('utils');
var jumpCount = utils.stat( player, 'jump');
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
#### Example 2 Getting the JUMP statistic object (which can be used elsewhere)
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var utils = require('utils');
var JUMPSTAT = utils.stat('jump');
var jumpCount = player.getStat( JUMPSTAT ); // canary-specific code
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
This function also contains values for each possible stat so you can get at stats like this...
including api
2014-12-28 16:07:32 +01:00
moving core drone and extensions into modules folder so 3rd-party extensions/contributions can use require('drone') instead of the existing unwieldy require('../drone').Drone
2015-01-03 21:57:30 +01:00
var utils = require('utils');
var JUMPSTAT = utils.stat.JUMP; // Accessing the value
var jumpCount = player.getStat ( JUMPSTAT ); // canary-specific code
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Example Plugin #1 - A simple extension to Minecraft.
reorg
2013-12-24 01:15:17 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
A simple minecraft plugin. The most basic module.
made 'events' global
2013-12-26 16:38:24 +01:00
Documentation tweaks. Changed heading levels for the arrows and commando modules.
2013-12-29 00:02:50 +01:00
### Usage:
made 'events' global
2013-12-26 16:38:24 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
At the in-game prompt type ...
/js hello(self)
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
... and a message `Hello {player-name}` will appear (where
{player-name} is replaced by your own name).
This example demonstrates the basics of adding new functionality which
is only usable by server operators or users with the
scriptcraft.evaluate permission. By default, only ops are granted this
permission.
The `hello` function below is only usable by players with the scriptcraft.evaluate
permission since it relies on the `/js` command to execute.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
exports.hello = function(player){
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( player, 'Hello ' + player.name);
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
};
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Example Plugin #2 - Making extensions available for all players.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
A simple minecraft plugin. Commands for other players.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
### Usage:
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
At the in-game prompt type ...
/jsp hello
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
... and a message `Hello {player-name}` will appear (where {player-name} is
replaced by your own name).
This example demonstrates the basics of adding new functionality
which is usable all players or those with the scriptcraft.proxy
permission. By default, all players are granted this permission.
This differs from example 1 in that a new 'jsp ' command extension
is defined. Since all players can use the `jsp` command, all players
can use the new extension. Unlike the previous example, the `jsp hello`
command does not evaluate javascript code so this command is much more secure.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
command('hello', function (parameters, player) {
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( player, 'Hello ' + player.name);
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
});
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Example Plugin #3 - Limiting use of commands to operators only.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
A simple minecraft plugin. Commands for operators only.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
### Usage:
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
At the in-game prompt type ...
/jsp op-hello
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
... and a message `Hello {player-name}` will appear (where {player-name} is
replaced by your own name).
This example demonstrates the basics of adding new functionality
which is usable all players or those with the scriptcraft.proxy
permission. By default, all players are granted this permission. In
this command though, the function checks to see if the player is an
operator and if they aren't will return immediately.
This differs from example 2 in that the function will only print a
message for operators.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
command('op-hello', function (parameters, player) {
apply frank's changes to templates/ypgpm.md
2014-12-22 16:23:06 +01:00
if ( !isOp(player) ){
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( player, 'Only operators can do this.');
return;
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
}
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( player, 'Hello ' + player.name);
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
});
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Example Plugin #4 - Using parameters in commands.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
A simple minecraft plugin. Handling parameters.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
### Usage:
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
At the in-game prompt type ...
/jsp hello-params Hi
/jsp hello-params Saludos
/jsp hello-params Greetings
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
... and a message `Hi {player-name}` or `Saludos {player-name}` etc
will appear (where {player-name} is replaced by your own name).
This example demonstrates adding and using parameters in commands.
This differs from example 3 in that the greeting can be changed from
a fixed 'Hello ' to anything you like by passing a parameter.
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Changed formatting to use idiomatic style. (like glasses-mode in emacs)
2014-01-29 20:49:15 +01:00
command( 'hello-params', function ( parameters, player ) {
var salutation = parameters[0] ;
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( player, salutation + ' ' + player.name );
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
});
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Example Plugin #5 - Re-use - Using your own and others modules.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
A simple minecraft plugin. Using Modules.
reorg
2013-12-24 01:15:17 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
### Usage:
reorg
2013-12-24 01:15:17 +01:00
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
At the in-game prompt type ...
/jsp hello-module
... and a message `Hello {player-name}` will appear (where {player-name} is
replaced by your own name).
This example demonstrates the use of modules. In
example-1-hello-module.js we created a new javascript module. In
this example, we use that module...
* We load the module using the `require()` function. Because this
module and the module we require are n the same directory, we
specify `'./example-1-hello-module'` as the path (when loading a
module from the same directory, `./` at the start of the path
indicates that the file should be searched for in the same
directory.
* We assign the loaded module to a variable (`greetings`) and then
use the module's `hello` method to display the message.
Source Code...
var greetings = require('./example-1-hello-module');
Changed formatting to use idiomatic style. (like glasses-mode in emacs)
2014-01-29 20:49:15 +01:00
command( 'hello-module', function( parameters, player ) {
greetings.hello( player );
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
});
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Example Plugin #6 - Re-use - Using 'utils' to get Player objects.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
A simple minecraft plugin. Finding players by name.
### Usage:
At the in-game prompt type ...
/jsp hello-byname {player-name}
... substituting {player-name} with the name of a player currently
online and a message `Hello ...` will be sent to the named
player.
This example builds on example-5 and also introduces a new concept -
use of shared modules. That is : modules which are not specific to
any one plugin or set of plugins but which can be used by all
plugins. Shared modules should be placed in the
`scriptcraft/modules` directory.
* The utils module is used. Because the 'utils' module is
located in the modules folder we don't need to specify an exact
path, just 'utils' will do.
* The `utils.player()` function is used to obtain a player object
matching the player name. Once a player object is obtained, a
message is sent to that player.
Source Code ...
var utils = require('utils');
var greetings = require('./example-1-hello-module');
Changed formatting to use idiomatic style. (like glasses-mode in emacs)
2014-01-29 20:49:15 +01:00
command( 'hello-byname', function( parameters, sender ) {
var playerName = parameters[0];
var recipient = utils.player( playerName );
if ( recipient ) {
greetings.hello( recipient );
} else {
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( sender, 'Player ' + playerName + ' not found.' );
Changed formatting to use idiomatic style. (like glasses-mode in emacs)
2014-01-29 20:49:15 +01:00
}
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
});
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Example Plugin #7 - Listening for events, Greet players when they join the game.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
A simple event-driven minecraft plugin. How to handle Events.
This example demonstrates event-driven programming. The code below
will display the version of ScriptCraft every time an operator joins
the game. This module is notable from previous modules for the
following reasons...
1. It does not export any functions or variables. That's fine. Not
all modules need export stuff. Code in this module will be
executed when the module is first loaded. Because it is in the
`/scriptcraft/plugins` directory, it will be loaded automatically
when the server starts up.
2. It uses ScriptCraft's `events.on()` function to add a new *Event
Handler*. An *Event Handler* is a just a function which gets
called whenever a particular *event* happens in the game. The
function defined below will only be executed whenever a player
joins the game. This style of program is sometimes refered to as
*Event-Driven Programming*.
Adding new *Event Handlers* in ScriptCraft is relatively easy. Use the
`events.on()` function to add a new event handler. It takes 2
parameters...
1. The Event Name, in this case `'player.PlayerJoinEvent'`. You can
browse [all possible Bukkit events][bkevts] (click the 'Next
Package' and 'Previous Package' links to browse).
2. The event handling function (also sometimes refered to as a
Event handling rework. Simplified event handling and unregistering.
2014-03-15 19:06:23 +01:00
'callback'). In ScriptCraft, this function takes a single
parameter, an event object. All of the information about the event
is in the event object.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
In the example below, if a player joins the server and is an operator,
then the ScriptCraft plugin information will be displayed to that
player.
apply frank's changes to templates/ypgpm.md
2014-12-22 16:23:06 +01:00
What's also notable about this example is how it uses the `isOp()` function. The code...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
apply frank's changes to templates/ypgpm.md
2014-12-22 16:23:06 +01:00
if ( isOp(event.player) )
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
apply frank's changes to templates/ypgpm.md
2014-12-22 16:23:06 +01:00
ScriptCraft uses a special version of JavaScript which comes
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
bundled with Java (Minecraft is written in Java) and JavaScript in
Java can access properties of Java objects more succinctly than in
Java itself. What this means in practice is that when you're perusing
the [Bukkit API Reference][bkapi] and come across a method like
[Player.getAllowFlight()][bkgaf], you can write code like this...
var allowFlight = player.getAllowFlight(); // java style
... or the more succinct ...
var allowFlight = player.allowFlight; // javascript style
... Which style you choose is up to you but `player.allowFlight` is
cleaner and more readable. Similarly where you see a method like
[Player.setAllowFlight()][bksaf], you can write ...
player.setAllowFlight(true); // java style
... or the more readable...
player.allowFlight = true; // javascript style
... Which style you choose is up to you.
[bkevts]: http://jd.bukkit.org/dev/apidocs/org/bukkit/event/package-summary.html
[bkgaf]: http://jd.bukkit.org/dev/apidocs/org/bukkit/entity/Player.html#getAllowFlight()
[bksaf]: http://jd.bukkit.org/dev/apidocs/org/bukkit/entity/Player.html#setAllowFlight()
[bkapi]: http://jd.bukkit.org/dev/apidocs/
Event handling rework. Simplified event handling and unregistering.
2014-03-15 19:06:23 +01:00
events.on( 'player.PlayerJoinEvent', function( event ) {
apply frank's changes to templates/ypgpm.md
2014-12-22 16:23:06 +01:00
if ( isOp(event.player) ) {
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( event.player, 'Welcome to ' + __plugin);
Changed formatting to use idiomatic style. (like glasses-mode in emacs)
2014-01-29 20:49:15 +01:00
}
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
});
Omit abstract event classes from events-helper. Improved tab completion for jre8
2014-04-26 21:20:10 +02:00
Update: Since version 2.0.8 the above code can be replaced by the more succinct:
events.playerJoin( function( event ) {
if ( event.player.op ) {
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( event.player, 'Welcome to ' + __plugin);
Omit abstract event classes from events-helper. Improved tab completion for jre8
2014-04-26 21:20:10 +02:00
}
});
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Arrows Plugin
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
The arrows mod adds fancy arrows to the game. Arrows which...
* Launch fireworks.
* Explode on impact.
* Force Lightning to strike where they land.
* Teleport the player to the landing spot.
* Spawn Trees at the landing spot.
### Usage:
* `/js arrows.firework(self)` - A firework launches where the the arrow lands.
* `/js arrows.lightning(self)` - lightning strikes where the arrow lands.
* `/js arrows.teleport(self)` - makes player teleport to where arrow has landed.
* `/js arrows.flourish(self)` - makes a tree grow where the arrow lands.
* `/js arrows.explosive(self)` - makes arrows explode.
* `/js arrows.normal(self)` sets arrow type to normal.
* `/js arrows.sign(self)` turns a targeted sign into a Arrows menu
All of the above functions can take an optional player object or name
as a parameter. For example: `/js arrows.explosive('player23')` makes
player23's arrows explosive.
Fix issue #111, reorg of lib/ and (undoc'd) persistence
2014-01-12 12:26:26 +01:00
## Spawn Plugin
Allows in-game operators to easily spawn creatures at current location.
### Usage
/jsp spawn cow
/jsp spawn sheep
/jsp spawn wolf
updated young persons template and refactored minigame scoreboard.
2014-01-12 13:06:30 +01:00
This command supports TAB completion so to see a list of possible
entitities, type `/jsp spawn ' at the in-game command prompt, then
press TAB. Visit
<http://jd.bukkit.org/beta/apidocs/org/bukkit/entity/EntityType.html>
for a list of possible entities (creatures) which can be spawned.
Fix issue #111, reorg of lib/ and (undoc'd) persistence
2014-01-12 12:26:26 +01:00
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## alias Plugin
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
The alias module lets players and server admins create their own
per-player or global custom in-game command aliases.
### Examples
To set a command alias which is only visible to the current player
(per-player alias)...
/jsp alias set cw = time set {1} ; weather {2}
... Creates a new custom command only usable by the player who set
it called `cw` (short for set Clock and Weather) which when invoked...
/cw 4000 sun
... will perform the following commands...
/time set 4000
/weather sun
Aliases can use paramters as above. On the right hand side of the `=`, the
`{1}` refers to the first parameter provided with the `cw` alias, `{2}`
refers to the second parameter and so on. So `cw 4000 sun` is converted to
`time set 4000` and `weather sun`.
To set a global command alias usable by all (only operators can create
such an alias)...
/jsp alias global stormy = time 18000; weather storm
Workaround for stupid array index notation access bug in Nashorn.
2014-01-23 00:57:27 +01:00
To remove an alias ...
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
Workaround for stupid array index notation access bug in Nashorn.
2014-01-23 00:57:27 +01:00
/jsp alias remove cw
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
Workaround for stupid array index notation access bug in Nashorn.
2014-01-23 00:57:27 +01:00
... removes the 'cw' alias from the appropriate alias map.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
To get a list of aliases currently defined...
/jsp alias list
To get help on the `jsp alias` command:
/jsp alias help
Aliases can be used at the in-game prompt by players or in the server
console. Aliases will not be able to avail of command autocompletion
(pressing the TAB key will have no effect).
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## Classroom Plugin
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
The `classroom` object contains a couple of utility functions for use
in a classroom setting. The goal of these functions is to make it
easier for tutors to facilitate ScriptCraft for use by students in a
classroom environment. Although granting ScriptCraft access to
students on a shared server is potentially risky (Students can
potentially abuse it), it is slighlty less risky than granting
operator privileges to each student. (Enterprising students will
quickly realise how to grant themselves and others operator privileges
once they have access to ScriptCraft).
The goal of this module is not so much to enforce restrictions
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
(security or otherwise) but to make it easier for tutors to setup a
shared server so students can learn Javascript. When scripting is
turned on, every player who joins the server will have a dedicated
directory into which they can save scripts. All scripts in such
directories are automatically watched and loaded into a global
variable named after the player.
So for example, if player 'walterh' joins the server, a `walterh`
global variable is created. If a file `greet.js` with the following
Fix classroom module for use with CanaryMod
2015-01-01 19:24:44 +01:00
content is dropped into the `scriptcraft/players/walterh`
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
directory...
```javascript
exports.hi = function( player ){
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( player, 'Hi ' + player.name);
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
};
```
... then it can be invoked like this: `/js walterh.hi( self )` . This
lets every player/student create their own functions without having
naming collisions.
It's strongly recommended that the
Fix classroom module for use with CanaryMod
2015-01-01 19:24:44 +01:00
`scriptcraft/players/` directory is shared so that
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
others can connect to it and drop .js files into their student
directories. On Ubuntu, select the folder in Nautilus (the default
file browser) then right-click and choose *Sharing Options*, check the
*Share this folder* checkbox and the *Allow others to create and
delete files* and *Guest access* checkboxes. Click *Create Share*
button to close the sharing options dialog. Students can then access
the shared folder as follows...
* Windows: Open Explorer, Go to \\{serverAddress}\players\
* Macintosh: Open Finder, Go to smb://{serverAddress}/players/
* Linux: Open Nautilus, Go to smb://{serverAddress}/players/
... where {serverAddress} is the ip address of the server (this is
displayed to whoever invokes the classroom.allowScripting() function.)
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
### classroom.allowScripting() function
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
reorg
2013-12-24 01:15:17 +01:00
Allow or disallow anyone who connects to the server (or is already
connected) to use ScriptCraft. This function is preferable to granting 'ops' privileges
to every student in a Minecraft classroom environment.
Improvements to classroom.js module (added players/ directory into which players can drop their custom scripts when classroom.allowScripting(true) is called.
2014-02-10 21:55:32 +01:00
Whenever any file is added/edited or removed from any of the players/
directories the contents are automatically reloaded. This is to
facilitate quick turnaround time for students getting to grips with
Javascript.
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Parameters
reorg
2013-12-24 01:15:17 +01:00
* canScript : true or false
improved require function
2013-12-18 00:49:00 +01:00
Cleaning up markdown documentation.
2013-12-28 09:44:40 +01:00
#### Example
reorg
2013-12-24 01:15:17 +01:00
To allow all players (and any players who connect to the server) to
use the `js` and `jsp` commands...
improved require function
2013-12-18 00:49:00 +01:00
Changed formatting to use idiomatic style. (like glasses-mode in emacs)
2014-01-29 20:49:15 +01:00
/js classroom.allowScripting( true, self )
improved require function
2013-12-18 00:49:00 +01:00
reorg
2013-12-24 01:15:17 +01:00
To disallow scripting (and prevent players who join the server from using the commands)...
Changed formatting to use idiomatic style. (like glasses-mode in emacs)
2014-01-29 20:49:15 +01:00
/js classroom.allowScripting( false, self )
reorg
2013-12-24 01:15:17 +01:00
Only ops users can run the classroom.allowScripting() function - this is so that students
don't try to bar themselves and each other from scripting.
improved require function
2013-12-18 00:49:00 +01:00
Documentation tweaks. Changed heading levels for the arrows and commando modules.
2013-12-29 00:02:50 +01:00
## Commando Plugin
made 'events' global
2013-12-26 16:38:24 +01:00
Documentation tweaks. Changed heading levels for the arrows and commando modules.
2013-12-29 00:02:50 +01:00
### Description
made 'events' global
2013-12-26 16:38:24 +01:00
commando is a plugin which can be used to add completely new commands
to Minecraft. Normally ScriptCraft only allows for provision of new
commands as extensions to the jsp command. For example, to create a
new simple command for use by all players...
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
/js command('hi', function(args,player){ echo( player, 'Hi ' + player.name); });
made 'events' global
2013-12-26 16:38:24 +01:00
... then players can use this command by typing...
/jsp hi
... A couple of ScriptCraft users have asked for the ability to take
this a step further and allow the global command namespace to be
populated so that when a developer creates a new command using the
'command' function, then the command is added to the global command
namespace so that players can use it simply like this...
/hi
... There are good reasons why ScriptCraft's core `command()` function
does not do this. Polluting the global namespace with commands would
make ScriptCraft a bad citizen in that Plugins should be able to work
together in the same server and - as much as possible - not step on
each others' toes. The CraftBukkit team have very good reasons for
forcing Plugins to declare their commands in the plugin.yml
configuration file. It makes approving plugins easier and ensures that
craftbukkit plugins behave well together. While it is possible to
override other plugins' commands, the CraftBukkit team do not
recommend this. However, as ScriptCraft users have suggested, it
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
should be at the discretion of server administrators as to when
overriding or adding new commands to the global namespace is good.
made 'events' global
2013-12-26 16:38:24 +01:00
So this is where `commando()` comes in. It uses the exact same
signature as the core `command()` function but will also make the
command accessible without the `jsp` prefix so instead of having to
type `/jsp hi` for the above command example, players simply type
`/hi` . This functionality is provided as a plugin rather than as part
of the ScriptCraft core.
Documentation tweaks. Changed heading levels for the arrows and commando modules.
2013-12-29 00:02:50 +01:00
### Example hi-command.js
made 'events' global
2013-12-26 16:38:24 +01:00
var commando = require('../commando');
'Buddha' Release : The annihilation of 'self' variable. use of 'self' should be limited only to in-game or console commands. It should not be used in the context of a module.
2013-12-30 22:33:12 +01:00
commando('hi', function(args,player){
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
echo( player, 'Hi ' + player.name);
made 'events' global
2013-12-26 16:38:24 +01:00
});
...Displays a greeting to any player who issues the `/hi` command.
Documentation tweaks. Changed heading levels for the arrows and commando modules.
2013-12-29 00:02:50 +01:00
### Example - timeofday-command.js
made 'events' global
2013-12-26 16:38:24 +01:00
var times = {Dawn: 0, Midday: 6000, Dusk: 12000, Midnight:18000};
'Buddha' Release : The annihilation of 'self' variable. use of 'self' should be limited only to in-game or console commands. It should not be used in the context of a module.
2013-12-30 22:33:12 +01:00
commando('timeofday', function(params,player){
player.location.world.setTime(times[params[0]]);
Updated alias command to create aliases without 'jsp' prefix and added 'console' global variable
2013-12-27 23:52:16 +01:00
},
made 'events' global
2013-12-26 16:38:24 +01:00
['Dawn','Midday','Dusk','Midnight']);
... changes the time of day using a new `/timeofday` command (options are Dawn, Midday, Dusk, Midnight)
Documentation tweaks. Changed heading levels for the arrows and commando modules.
2013-12-29 00:02:50 +01:00
### Caveats
made 'events' global
2013-12-26 16:38:24 +01:00
Since commands registered using commando are really just appendages to
the `/jsp` command and are not actually registered globally (it just
looks like that to the player), you won't be able to avail of tab
completion for the command itself or its parameters (unless you go the
traditional route of adding the `jsp` prefix). This plugin uses the
[PlayerCommandPreprocessEvent][pcppevt] which allows plugins to
intercepts all commands and inject their own commands instead. If
anyone reading this knows of a better way to programmatically add new
global commands for a plugin, please let me know.
[pcppevt]: http://jd.bukkit.org/dev/apidocs/org/bukkit/event/player/PlayerCommandPreprocessEvent.html
Added Table of Contents to API Reference - Issue #104
2014-01-04 19:39:49 +01:00
## homes Plugin
made 'events' global
2013-12-26 16:38:24 +01:00
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
The homes plugin lets players set a location as home and return to the
location, invite other players to their home and also visit other
player's homes.
This module is a good example of how to create a javascript-based
minecraft mod which provides...
* A programmatic interface (API) and
* A command extension which uses that API to provide new functionality for players.
The module uses the `plugin()` function to specify an object and
methods, and the `command()` function to expose functionality to
players through a new `jsp home` command. This module also
demonstrates how to enable autocompletion for custom commands (to see
this in action, at the in-game prompt or server console prompt type
`jsp home ` then press the TAB key - you should see a list of further
possible options).
The `jsp home` command has the following options...
### Basic options
* `/jsp home set` Will set your current location as your
'home' location to which you can return at any time using the ...
* `/jsp home` ..command will return you to your home, if you have set one.
added docs for chat/color plugn
2014-02-04 21:53:59 +01:00
* `/jsp home {player}` Will take you to the home of {player} (where
{player} is the name of the player whose home you wish to visit.
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
* `/jsp home delete` Deletes your home location from the location
database. This does not actually remove the home from the world or
change the world in any way. This command is completely
non-destructive and cannot be used for griefing. No blocks will be
destroyed by this command.
### Social options
The following options allow players to open their homes to all or some
players, invite players to their home and see a list of homes they can
visit.
* `/jsp home list` Lists home which you can visit.
* `/jsp home ilist` Lists players who can visit your home.
added docs for chat/color plugn
2014-02-04 21:53:59 +01:00
* `/jsp home invite {player}` Invites the named player to your home.
* `/jsp home uninvite {player}` Uninvites (revokes invitation) the named player to your home.
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
* `/jsp home public` Opens your home to all players (all players can visit your home).
* `/jsp home private` Makes your home private (no longer visitable by all).
### Administration options
The following administration options can only be used by server operators...
* `/jsp home listall` List all of the homes
added docs for chat/color plugn
2014-02-04 21:53:59 +01:00
* `/jsp home clear {player}` Removes the player's home
Added documentation for the 'homes' module ( issue #105)
2013-12-28 23:49:13 +01:00
location. Again, this command does not destroy any structures in
the world, it simply removes the location from the database. No
blocks are destroyed by this command.
Tweaks to documentation (examples and all files in same directory sorted alphabetically except where precedence regexp present)
2013-12-31 22:09:50 +01:00
## NumberGuess mini-game:
### Description
This is a very simple number guessing game. Minecraft will ask you to
guess a number between 1 and 10 and you will tell you if you're too
hight or too low when you guess wrong. The purpose of this mini-game
code is to demonstrate use of Bukkit's Conversation API.
### Example
/js Game_NumberGuess.start(self)
Once the game begins, guess a number by typing the `/` character
followed by a number between 1 and 10.
Fix issue #111, reorg of lib/ and (undoc'd) persistence
2014-01-12 12:26:26 +01:00
## Cow Clicker Mini-Game
### How to Play
At the in-game prompt type `jsp cowclicker` to start or stop
playing. Right-Click on Cows to score points. No points for killing
cows (hint: use the same keyboard keys you'd use for opening doors).
Every time you click a cow your score increases by 1 point. Your score
is displayed in a side-bar along the right edge of of the screen.
![cow clicker](img/cowclicker.png)
### Rules
* You can join and leave the Cow Clicker game at any time by typing
`/jsp cowclicker` at the in-game prompt.
* Once you leave the game, your score is reset to zero.
updated young persons template and refactored minigame scoreboard.
2014-01-12 13:06:30 +01:00
* When you disconnect from the server, your score will be reset to zero.
Fix issue #111, reorg of lib/ and (undoc'd) persistence
2014-01-12 12:26:26 +01:00
### Gameplay Mechanics
This is meant as a trivially simple use of the [Bukkit Scoreboard
API][bukscore]. There are many things you'll want to consider when constructing
your own mini-game...
* Is the game itself a long-lived game - that is - should players and
scores be persisted (stored) between server restarts?
* What should happen when a player quits the server - should this also be
understood as quitting the mini-game?
* What should happen when a player who was previously playing the
mini-game, joins the server - should they automatically resume the
mini-game?
[bukscore]: http://jd.bukkit.org/beta/apidocs/org/bukkit/scoreboard/package-summary.html
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
/*********************
## 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:
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 01:11:44 +01:00
* acaciaDoor()
* acaciaFence()
* acaciaFenceGate()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* acaciaLeaves()
* acaciaLog()
* acaciaSapling()
* acaciaStairs()
* acaciaWood()
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 01:11:44 +01:00
* acaciaWoodSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* activatorRail()
* allium()
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 01:11:44 +01:00
* andesite()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* anvil()
* apple()
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 01:11:44 +01:00
* armorStand()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* arrow()
* azureBluet()
* bakedPotato()
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 01:11:44 +01:00
* banner()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* beacon()
* bed()
* bedrock()
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 01:11:44 +01:00
* birchDoor()
* birchFence()
* birchFenceGate()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* birchLeaves()
* birchLog()
* birchSapling()
* birchWood()
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 01:11:44 +01:00
* birchWoodSlab()
* birchWoodStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* blackCarpet()
* blackGlass()
* blackGlassPane()
* blackStainedClay()
* blazePowder()
* blazeRod()
* blocksRecord()
* blueCarpet()
* blueGlass()
* blueGlassPane()
* blueOrchid()
* blueStainedClay()
* boat()
* bone()
* bonemeal()
* book()
* bookAndQuill()
* bookshelf()
* bottleOEnchanting()
* bow()
* bowl()
* bread()
* brewingStand()
* brickBlock()
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 01:11:44 +01:00
* brickSlab()
* brickStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* brownCarpet()
* brownGlass()
* brownGlassPane()
* brownMushroom()
* brownStainedClay()
* bucket()
* burningFurnace()
* cactus()
* cactusGreen()
* cake()
* carrot()
* carrotOnAStick()
* carrots()
* cauldron()
* chainmailBoots()
* chainmailChestplate()
* chainmailHelmet()
* chainmailLeggings()
* charcoal()
* chest()
* chirpRecord()
* clay()
* clayBall()
* clayBrick()
* clownFish()
* coal()
* coalBlock()
* coalOre()
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 01:11:44 +01:00
* coarseDirt()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* cobble()
* cobbleSilverFishBlock()
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 01:11:44 +01:00
* cobbleSlab()
* cobbleStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* cobblestoneWall()
* cocoaBeans()
* cocoaPlant()
* commandBlock()
* compass()
* cookedChicken()
* cookedClownFish()
* cookedFish()
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 01:11:44 +01:00
* cookedMutton()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* cookedPufferFish()
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 01:11:44 +01:00
* cookedRabbit()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* cookedSalmon()
* cookie()
* crackedSilverFishBlock()
* crackedStoneBrick()
* creeperHead()
* cyanCarpet()
* cyanDye()
* cyanGlass()
* cyanGlassPane()
* cyanStainedClay()
* dandelionYellow()
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 01:11:44 +01:00
* darkOakDoor()
* darkOakFence()
* darkOakFenceGate()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* darkOakLeaves()
* darkOakLog()
* darkOakSapling()
* darkOakStairs()
* darkOakWood()
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 01:11:44 +01:00
* darkOakWoodSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* daylightSensor()
* deadBush()
* detectorRail()
* diamond()
* diamondAxe()
* diamondBlock()
* diamondBoots()
* diamondChestplate()
* diamondHelmet()
* diamondHoe()
* diamondHorseArmor()
* diamondLeggings()
* diamondOre()
* diamondPickaxe()
* diamondSpade()
* diamondSword()
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 01:11:44 +01:00
* diorite()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* dirt()
* dispenser()
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 01:11:44 +01:00
* doubleAcaciaWoodSlab()
* doubleBirchWoodSlab()
* doubleBrickBlockSlab()
* doubleCobbleSlab()
* doubleDarkOakWoodSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* doubleGrass()
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 01:11:44 +01:00
* doubleJungleWoodSlab()
* doubleNetherBrickSlab()
* doubleOakWoodSlab()
* doubleOrnateStoneSlab()
* doubleQuartzSlab()
* doubleRedSandstoneSlab()
* doubleSandStoneTrimSlab()
* doubleSandstoneSlab()
* doubleSpruceWoodSlab()
* doubleStoneBricksSlab()
* doubleStoneSlab()
* doubleWoodSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* dropper()
* egg()
* elevenRecord()
* emerald()
* emeraldBlock()
* emeraldOre()
* emptyMap()
* enchantedBook()
* enchantmentTable()
* endPortal()
* endPortalFrame()
* endStone()
* enderChest()
* enderDragonEgg()
* enderPearl()
* eyeofEnder()
* farRecord()
* feather()
* fence()
* fenceGate()
* fermentedSpiderEye()
* fireBlock()
* fireCharge()
* fireworkRocket()
* fireworkStar()
* fishingRod()
* flint()
* flintAndSteel()
* flowerPot()
* furnace()
* ghastTear()
* glass()
* glassBottle()
* glassPane()
* glisteringMelon()
* glowStone()
* glowstoneDust()
* goldAxe()
* goldBlock()
* goldBoots()
* goldChestplate()
* goldHelmet()
* goldHoe()
* goldHorseArmor()
* goldIngot()
* goldLeggings()
* goldNugget()
* goldOre()
* goldPickaxe()
* goldRecord()
* goldSpade()
* goldSword()
* goldenApple()
* goldenCarrot()
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 01:11:44 +01:00
* granite()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* grass()
* gravel()
* grayCarpet()
* grayDye()
* grayGlass()
* grayGlassPane()
* grayStainedClay()
* greenCarpet()
* greenGlass()
* greenGlassPane()
* greenRecord()
* greenStainedClay()
* grilledPork()
* gunpowder()
* hardenedClay()
* hayBale()
* heavyWeightedPressurePlate()
* hopper()
* hugeBrownMushroom()
* hugeRedMushroom()
* humanHead()
* ice()
* inkSack()
* ironAxe()
* ironBars()
* ironBlock()
* ironBoots()
* ironChestplate()
* ironDoor()
* ironHelmet()
* ironHoe()
* ironHorseArmor()
* ironIngot()
* ironLeggings()
* ironOre()
* ironPickaxe()
* ironSpade()
* ironSword()
* itemFrame()
* jackOLantern()
* jukebox()
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 01:11:44 +01:00
* jungleDoor()
* jungleFence()
* jungleFenceGate()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* jungleLeaves()
* jungleLog()
* jungleSapling()
* jungleWood()
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 01:11:44 +01:00
* jungleWoodSlab()
* jungleWoodStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* ladder()
* lapisBlock()
* lapisLazuli()
* lapislazuliOre()
* largeFern()
* lava()
* lavaBucket()
* lavaFlowing()
* lead()
* leather()
* leatherBoots()
* leatherChestplate()
* leatherHelmet()
* leatherLeggings()
* lever()
* lightBlueCarpet()
* lightBlueDye()
* lightBlueGlass()
* lightBlueGlassPane()
* lightBlueStainedClay()
* lightGrayCarpet()
* lightGrayDye()
* lightGrayGlass()
* lightGrayGlassPane()
* lightGrayStainedClay()
* lightWeightedPressurePlate()
* lilac()
* lilypad()
* limeCarpet()
* limeDye()
* limeGlass()
* limeGlassPane()
* limeStainedClay()
* magentaCarpet()
* magentaDye()
* magentaGlass()
* magentaGlassPane()
* magentaStainedClay()
* magmaCream()
* mallRecord()
* map()
* mellohiRecord()
* melon()
* melonSeeds()
* melonSlice()
* milkBucket()
* minecart()
* minecartCommandBlock()
* minecartHopper()
* minecartTNT()
* mobSpawner()
* mossyBrickSilverFishBlock()
* mossyCobble()
* mossyCobbleWall()
* mossyStoneBrick()
* mushroomSoup()
* mycelium()
* nameTag()
* netherBrick()
* netherBrickFence()
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 01:11:44 +01:00
* netherBrickStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* netherBricks()
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 01:11:44 +01:00
* netherBricksSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* netherQuartz()
* netherQuartzOre()
* netherStar()
* netherWart()
* netherrack()
* noteBlock()
* oakLeaves()
* oakLog()
* oakSapling()
* oakWood()
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 01:11:44 +01:00
* oakWoodSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* obsidian()
* orangeCarpet()
* orangeDye()
* orangeGlass()
* orangeGlassPane()
* orangeStainedClay()
* orangeTulip()
* ornateQuartzBlock()
* ornateSilverFishBlock()
* ornateStoneBrick()
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 01:11:44 +01:00
* ornateStoneSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* oxeyeDaisy()
* packedIce()
* painting()
* paper()
* peony()
* pineLeaves()
* pineLog()
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 01:11:44 +01:00
* pineWoodStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* pinkCarpet()
* pinkDye()
* pinkGlass()
* pinkGlassPane()
* pinkStainedClay()
* pinkTulip()
* piston()
* podzol()
* poisonousPotato()
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 01:11:44 +01:00
* polishedAndesite()
* polishedDiorite()
* polishedGranite()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* poppy()
* pork()
* portal()
* potato()
* potatoes()
* potion()
* poweredMinecart()
* poweredRail()
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 01:11:44 +01:00
* prismarineCrystals()
* prismarineShard()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* pufferFish()
* pumpkin()
* pumpkinPie()
* pumpkinSeeds()
* purpleCarpet()
* purpleDye()
* purpleGlass()
* purpleGlassPane()
* purpleStainedClay()
* quartzBlock()
* quartzPillarCap()
* quartzPillarHorizontal()
* quartzPillarVertical()
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 01:11:44 +01:00
* quartzSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* quartzStairs()
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 01:11:44 +01:00
* rabbitFoot()
* rabbitHide()
* rabbitStew()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* rail()
* rawBeef()
* rawChicken()
* rawFish()
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 01:11:44 +01:00
* rawMutton()
* rawRabbit()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* rawSalmon()
* redCarpet()
* redGlass()
* redGlassPane()
* redMushroom()
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 01:11:44 +01:00
* redSandstone()
* redSandstoneBlank()
* redSandstoneOrnate()
* redSandstoneSlab()
* redSandstoneStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* redStainedClay()
* redStone()
* redTulip()
* redstoneBlock()
* redstoneComparator()
* redstoneLampOff()
* redstoneOre()
* redstoneRepeater()
* redstoneTorchOn()
* reed()
* roseBush()
* roseRed()
* rottenFlesh()
* saddle()
* sand()
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 01:11:44 +01:00
* sandStoneTrimSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* sandstone()
* sandstoneBlank()
* sandstoneOrnate()
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 01:11:44 +01:00
* sandstoneSlab()
* sandstoneStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* seeds()
* shears()
* shrub()
* sign()
* skeletonHead()
* slimeBall()
* snow()
* snowBall()
* snowBlock()
* soil()
* soulSand()
* spawnEgg()
* spiderEye()
* spiderWeb()
* sponge()
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 01:11:44 +01:00
* spruceDoor()
* spruceFence()
* spruceFenceGate()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* spruceSapling()
* spruceWood()
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 01:11:44 +01:00
* spruceWoodSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* stalRecord()
* steak()
* stick()
* stickyPiston()
* stone()
* stoneAxe()
* stoneBrick()
* stoneBrickSilverFishBlock()
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 01:11:44 +01:00
* stoneBrickStairs()
* stoneBricksSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* stoneButton()
* stoneHoe()
* stonePickaxe()
* stonePlate()
* stoneSilverFishBlock()
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 01:11:44 +01:00
* stoneSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* stoneSpade()
* stoneSword()
* storageMinecart()
* stradRecord()
* string()
* sugar()
* sunflower()
* tallFern()
* tallGrass()
* tnt()
* torch()
* trapdoor()
* trappedChest()
* tripwireHook()
* vines()
* waitRecord()
* wardRecord()
* watch()
* water()
* waterBucket()
* waterFlowing()
* wheat()
* whiteCarpet()
* whiteGlass()
* whiteGlassPane()
* whiteStainedClay()
* whiteTulip()
* witherSkeletonHead()
* woodAxe()
* woodDoor()
* woodHoe()
* woodPickaxe()
* woodPlate()
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 01:11:44 +01:00
* woodSlab()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* woodSpade()
* woodSword()
* woodenButton()
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 01:11:44 +01:00
* woodenStairs()
Added items to API docs, added recipes. added utils.players() and utils.playerNames() functions.
2014-10-05 18:29:04 +02:00
* woolBlack()
* woolBlue()
* woolBrown()
* woolCyan()
* woolDarkGreen()
* woolGray()
* woolLightBlue()
* woolLightGray()
* woolLightGreen()
* woolMagenta()
* woolOrange()
* woolPink()
* woolPurple()
* woolRed()
* woolWhite()
* woolYellow()
* workbench()
* writtenBook()
* yellowCarpet()
* yellowFlower()
* yellowGlass()
* yellowGlassPane()
* yellowStainedClay()
* zombieHead()
***/
Reference in a new issue Copy permalink