From 4887fab4bf071d854389f2b8e991f1457c4338b9 Mon Sep 17 00:00:00 2001 From: BuildTools Date: Tue, 20 Dec 2016 14:40:00 +0000 Subject: [PATCH] fix spawn doc links and support entities autocomplete --- docs/API-Reference.md | 2997 +++++++++++++++++----------------- src/main/js/modules/spawn.js | 3 + src/main/js/plugins/spawn.js | 4 +- 3 files changed, 1525 insertions(+), 1479 deletions(-) diff --git a/docs/API-Reference.md b/docs/API-Reference.md index 30875ce..0a4f849 100644 --- a/docs/API-Reference.md +++ b/docs/API-Reference.md @@ -173,183 +173,184 @@ Walter Higgins * [events.serverShutdown()](#eventsservershutdown) * [Events Helper Module (SpigotMC version)](#events-helper-module-spigotmc-version) * [Usage](#usage-1) + * [events.blockFade()](#eventsblockfade) + * [events.blockFromTo()](#eventsblockfromto) + * [events.notePlay()](#eventsnoteplay) + * [events.blockPlace()](#eventsblockplace-1) + * [events.blockGrow()](#eventsblockgrow-1) + * [events.entityBlockForm()](#eventsentityblockform) + * [events.blockPistonExtend()](#eventsblockpistonextend) + * [events.blockPistonRetract()](#eventsblockpistonretract) + * [events.blockSpread()](#eventsblockspread) + * [events.blockBurn()](#eventsblockburn) + * [events.blockDamage()](#eventsblockdamage) + * [events.leavesDecay()](#eventsleavesdecay) + * [events.blockDispense()](#eventsblockdispense) + * [events.blockForm()](#eventsblockform) + * [events.blockMultiPlace()](#eventsblockmultiplace) + * [events.blockIgnite()](#eventsblockignite) + * [events.blockPhysics()](#eventsblockphysics-1) + * [events.blockRedstone()](#eventsblockredstone) + * [events.cauldronLevelChange()](#eventscauldronlevelchange) + * [events.blockCanBuild()](#eventsblockcanbuild) + * [events.signChange()](#eventssignchange-1) + * [events.blockExp()](#eventsblockexp) + * [events.blockExplode()](#eventsblockexplode) + * [events.blockBreak()](#eventsblockbreak) + * [events.prepareAnvil()](#eventsprepareanvil) + * [events.brew()](#eventsbrew) + * [events.inventoryClose()](#eventsinventoryclose) + * [events.inventoryDrag()](#eventsinventorydrag) + * [events.inventoryCreative()](#eventsinventorycreative) + * [events.prepareItemCraft()](#eventsprepareitemcraft) + * [events.craftItem()](#eventscraftitem) + * [events.inventoryClick()](#eventsinventoryclick) + * [events.brewingStandFuel()](#eventsbrewingstandfuel) + * [events.inventoryPickupItem()](#eventsinventorypickupitem) + * [events.furnaceExtract()](#eventsfurnaceextract) + * [events.inventory()](#eventsinventory-1) + * [events.furnaceBurn()](#eventsfurnaceburn) + * [events.furnaceSmelt()](#eventsfurnacesmelt) + * [events.inventoryOpen()](#eventsinventoryopen) + * [events.inventoryMoveItem()](#eventsinventorymoveitem) + * [events.hangingPlace()](#eventshangingplace) + * [events.hangingBreak()](#eventshangingbreak) + * [events.hangingBreakByEntity()](#eventshangingbreakbyentity) + * [events.entityToggleGlide()](#eventsentitytoggleglide) + * [events.itemSpawn()](#eventsitemspawn) + * [events.spawnerSpawn()](#eventsspawnerspawn) + * [events.foodLevelChange()](#eventsfoodlevelchange) + * [events.lingeringPotionSplash()](#eventslingeringpotionsplash) + * [events.entityShootBow()](#eventsentityshootbow) + * [events.entityTargetLivingEntity()](#eventsentitytargetlivingentity) + * [events.entityCombust()](#eventsentitycombust) + * [events.entityBreed()](#eventsentitybreed) + * [events.expBottle()](#eventsexpbottle) + * [events.slimeSplit()](#eventsslimesplit-1) + * [events.entityDeath()](#eventsentitydeath-1) + * [events.entityAirChange()](#eventsentityairchange) + * [events.projectileLaunch()](#eventsprojectilelaunch) + * [events.entityPortal()](#eventsentityportal) + * [events.horseJump()](#eventshorsejump) + * [events.fireworkExplode()](#eventsfireworkexplode-1) + * [events.entityExplode()](#eventsentityexplode) + * [events.itemMerge()](#eventsitemmerge) + * [events.entitySpawn()](#eventsentityspawn-1) + * [events.projectileHit()](#eventsprojectilehit-1) + * [events.creatureSpawn()](#eventscreaturespawn) + * [events.entityPortalExit()](#eventsentityportalexit) + * [events.entityTame()](#eventsentitytame-1) + * [events.entityPortalEnter()](#eventsentityportalenter) + * [events.playerLeashEntity()](#eventsplayerleashentity) + * [events.entityDamage()](#eventsentitydamage) + * [events.pigZap()](#eventspigzap) + * [events.entityCombustByEntity()](#eventsentitycombustbyentity) + * [events.entityChangeBlock()](#eventsentitychangeblock) + * [events.areaEffectCloudApply()](#eventsareaeffectcloudapply) + * [events.creeperPower()](#eventscreeperpower) + * [events.sheepDyeWool()](#eventssheepdyewool) + * [events.playerDeath()](#eventsplayerdeath-1) + * [events.villagerReplenishTrade()](#eventsvillagerreplenishtrade) + * [events.entityCombustByBlock()](#eventsentitycombustbyblock) + * [events.entityResurrect()](#eventsentityresurrect) + * [events.villagerAcquireTrade()](#eventsvillageracquiretrade) + * [events.enderDragonChangePhase()](#eventsenderdragonchangephase) + * [events.entityCreatePortal()](#eventsentitycreateportal) + * [events.sheepRegrowWool()](#eventssheepregrowwool) + * [events.entityRegainHealth()](#eventsentityregainhealth) + * [events.entityInteract()](#eventsentityinteract) + * [events.potionSplash()](#eventspotionsplash) + * [events.entityTarget()](#eventsentitytarget) + * [events.entityBreakDoor()](#eventsentitybreakdoor) + * [events.entityUnleash()](#eventsentityunleash) + * [events.entityDamageByBlock()](#eventsentitydamagebyblock) + * [events.entityTeleport()](#eventsentityteleport) + * [events.itemDespawn()](#eventsitemdespawn) + * [events.explosionPrime()](#eventsexplosionprime) + * [events.entityDamageByEntity()](#eventsentitydamagebyentity) + * [events.portalCreate()](#eventsportalcreate-1) + * [events.worldSave()](#eventsworldsave) + * [events.worldLoad()](#eventsworldload) + * [events.chunkLoad()](#eventschunkload) + * [events.chunkPopulate()](#eventschunkpopulate) + * [events.chunkUnload()](#eventschunkunload-1) + * [events.structureGrow()](#eventsstructuregrow) + * [events.worldInit()](#eventsworldinit) + * [events.spawnChange()](#eventsspawnchange) + * [events.worldUnload()](#eventsworldunload) + * [events.playerShearEntity()](#eventsplayershearentity) + * [events.playerVelocity()](#eventsplayervelocity) + * [events.playerBucketFill()](#eventsplayerbucketfill) + * [events.playerFish()](#eventsplayerfish) + * [events.playerGameModeChange()](#eventsplayergamemodechange) + * [events.playerCommandPreprocess()](#eventsplayercommandpreprocess) + * [events.playerInteract()](#eventsplayerinteract) + * [events.playerInteractAtEntity()](#eventsplayerinteractatentity) + * [events.playerPortal()](#eventsplayerportal) + * [events.playerPreLogin()](#eventsplayerprelogin) + * [events.playerMove()](#eventsplayermove-1) + * [events.playerQuit()](#eventsplayerquit) + * [events.playerToggleSneak()](#eventsplayertogglesneak) + * [events.playerPickupArrow()](#eventsplayerpickuparrow) + * [events.playerBedLeave()](#eventsplayerbedleave) + * [events.playerChangedMainHand()](#eventsplayerchangedmainhand) + * [events.playerEditBook()](#eventsplayereditbook) + * [events.playerAnimation()](#eventsplayeranimation) + * [events.playerResourcePackStatus()](#eventsplayerresourcepackstatus) + * [events.playerItemDamage()](#eventsplayeritemdamage) + * [events.playerBucketEmpty()](#eventsplayerbucketempty) + * [events.playerExpChange()](#eventsplayerexpchange) + * [events.asyncPlayerChat()](#eventsasyncplayerchat) + * [events.playerItemBreak()](#eventsplayeritembreak) + * [events.playerUnleashEntity()](#eventsplayerunleashentity) + * [events.playerRespawn()](#eventsplayerrespawn) + * [events.playerDropItem()](#eventsplayerdropitem) + * [events.playerItemHeld()](#eventsplayeritemheld) + * [events.playerTeleport()](#eventsplayerteleport) + * [events.playerInteractEntity()](#eventsplayerinteractentity) + * [events.playerEggThrow()](#eventsplayereggthrow) + * [events.playerChat()](#eventsplayerchat) + * [events.playerRegisterChannel()](#eventsplayerregisterchannel) + * [events.playerSwapHandItems()](#eventsplayerswaphanditems) + * [events.playerChangedWorld()](#eventsplayerchangedworld) + * [events.playerLevelChange()](#eventsplayerlevelchange) + * [events.playerPickupItem()](#eventsplayerpickupitem) + * [events.asyncPlayerPreLogin()](#eventsasyncplayerprelogin) + * [events.playerUnregisterChannel()](#eventsplayerunregisterchannel) + * [events.playerStatisticIncrement()](#eventsplayerstatisticincrement) + * [events.playerBedEnter()](#eventsplayerbedenter) + * [events.playerKick()](#eventsplayerkick) + * [events.playerToggleSprint()](#eventsplayertogglesprint) + * [events.playerAchievementAwarded()](#eventsplayerachievementawarded) + * [events.playerJoin()](#eventsplayerjoin) + * [events.playerToggleFlight()](#eventsplayertoggleflight) + * [events.playerArmorStandManipulate()](#eventsplayerarmorstandmanipulate) + * [events.playerLogin()](#eventsplayerlogin) + * [events.playerItemConsume()](#eventsplayeritemconsume) + * [events.playerChatTabComplete()](#eventsplayerchattabcomplete) * [events.weatherChange()](#eventsweatherchange-1) - * [events.lightningStrike()](#eventslightningstrike-1) * [events.thunderChange()](#eventsthunderchange) + * [events.lightningStrike()](#eventslightningstrike-1) * [events.vehicleMove()](#eventsvehiclemove-1) + * [events.vehicleDamage()](#eventsvehicledamage-1) * [events.vehicleDestroy()](#eventsvehicledestroy-1) - * [events.vehicleExit()](#eventsvehicleexit-1) + * [events.vehicleUpdate()](#eventsvehicleupdate) + * [events.vehicleCreate()](#eventsvehiclecreate) * [events.vehicleEntityCollision()](#eventsvehicleentitycollision) * [events.vehicleBlockCollision()](#eventsvehicleblockcollision) * [events.vehicleEnter()](#eventsvehicleenter-1) - * [events.vehicleDamage()](#eventsvehicledamage-1) - * [events.vehicleUpdate()](#eventsvehicleupdate) - * [events.vehicleCreate()](#eventsvehiclecreate) - * [events.enchantItem()](#eventsenchantitem) + * [events.vehicleExit()](#eventsvehicleexit-1) * [events.prepareItemEnchant()](#eventsprepareitemenchant) - * [events.playerInteractEntity()](#eventsplayerinteractentity) - * [events.playerPickupArrow()](#eventsplayerpickuparrow) - * [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.playerArmorStandManipulate()](#eventsplayerarmorstandmanipulate) - * [events.playerChat()](#eventsplayerchat) - * [events.playerShearEntity()](#eventsplayershearentity) - * [events.playerItemDamage()](#eventsplayeritemdamage) - * [events.asyncPlayerChat()](#eventsasyncplayerchat) - * [events.playerDropItem()](#eventsplayerdropitem) - * [events.playerRegisterChannel()](#eventsplayerregisterchannel) - * [events.playerMove()](#eventsplayermove-1) - * [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.playerResourcePackStatus()](#eventsplayerresourcepackstatus) - * [events.playerPreLogin()](#eventsplayerprelogin) - * [events.playerJoin()](#eventsplayerjoin) - * [events.playerAnimation()](#eventsplayeranimation) - * [events.playerEditBook()](#eventsplayereditbook) - * [events.playerPickupItem()](#eventsplayerpickupitem) - * [events.playerInteractAtEntity()](#eventsplayerinteractatentity) - * [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.playerSwapHandItems()](#eventsplayerswaphanditems) - * [events.playerKick()](#eventsplayerkick) - * [events.playerToggleSprint()](#eventsplayertogglesprint) - * [events.playerCommandPreprocess()](#eventsplayercommandpreprocess) - * [events.playerChangedMainHand()](#eventsplayerchangedmainhand) - * [events.playerGameModeChange()](#eventsplayergamemodechange) - * [events.furnaceSmelt()](#eventsfurnacesmelt) - * [events.prepareAnvil()](#eventsprepareanvil) - * [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) - * [events.inventory()](#eventsinventory-1) - * [events.prepareItemCraft()](#eventsprepareitemcraft) - * [events.furnaceExtract()](#eventsfurnaceextract) - * [events.brew()](#eventsbrew) - * [events.serverCommand()](#eventsservercommand) + * [events.enchantItem()](#eventsenchantitem) + * [events.pluginDisable()](#eventsplugindisable-1) * [events.serverListPing()](#eventsserverlistping-1) * [events.serviceRegister()](#eventsserviceregister) - * [events.pluginDisable()](#eventsplugindisable-1) + * [events.serverCommand()](#eventsservercommand) * [events.remoteServerCommand()](#eventsremoteservercommand) - * [events.mapInitialize()](#eventsmapinitialize) - * [events.tabComplete()](#eventstabcomplete) - * [events.serviceUnregister()](#eventsserviceunregister) * [events.pluginEnable()](#eventspluginenable-1) - * [events.villagerAcquireTrade()](#eventsvillageracquiretrade) - * [events.entityBreed()](#eventsentitybreed) - * [events.entityAirChange()](#eventsentityairchange) - * [events.playerDeath()](#eventsplayerdeath-1) - * [events.enderDragonChangePhase()](#eventsenderdragonchangephase) - * [events.entityCreatePortal()](#eventsentitycreateportal) - * [events.entityCombust()](#eventsentitycombust) - * [events.sheepDyeWool()](#eventssheepdyewool) - * [events.expBottle()](#eventsexpbottle) - * [events.entityTame()](#eventsentitytame-1) - * [events.projectileLaunch()](#eventsprojectilelaunch) - * [events.entityDamage()](#eventsentitydamage) - * [events.itemSpawn()](#eventsitemspawn) - * [events.projectileHit()](#eventsprojectilehit-1) - * [events.foodLevelChange()](#eventsfoodlevelchange) - * [events.itemDespawn()](#eventsitemdespawn) - * [events.villagerReplenishTrade()](#eventsvillagerreplenishtrade) - * [events.entityPortalEnter()](#eventsentityportalenter) - * [events.areaEffectCloudApply()](#eventsareaeffectcloudapply) - * [events.entityPortal()](#eventsentityportal) - * [events.entityTarget()](#eventsentitytarget) - * [events.entityDeath()](#eventsentitydeath-1) - * [events.entitySpawn()](#eventsentityspawn-1) - * [events.lingeringPotionSplash()](#eventslingeringpotionsplash) - * [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.entityToggleGlide()](#eventsentitytoggleglide) - * [events.explosionPrime()](#eventsexplosionprime) - * [events.horseJump()](#eventshorsejump) - * [events.creatureSpawn()](#eventscreaturespawn) - * [events.entityCombustByEntity()](#eventsentitycombustbyentity) - * [events.entityDamageByBlock()](#eventsentitydamagebyblock) - * [events.entityTargetLivingEntity()](#eventsentitytargetlivingentity) - * [events.entityTeleport()](#eventsentityteleport) - * [events.playerLeashEntity()](#eventsplayerleashentity) - * [events.spawnerSpawn()](#eventsspawnerspawn) - * [events.itemMerge()](#eventsitemmerge) - * [events.slimeSplit()](#eventsslimesplit-1) - * [events.pigZap()](#eventspigzap) - * [events.fireworkExplode()](#eventsfireworkexplode-1) - * [events.potionSplash()](#eventspotionsplash) - * [events.entityChangeBlock()](#eventsentitychangeblock) - * [events.entityPortalExit()](#eventsentityportalexit) - * [events.entityRegainHealth()](#eventsentityregainhealth) - * [events.entityBlockForm()](#eventsentityblockform) - * [events.blockSpread()](#eventsblockspread) - * [events.blockMultiPlace()](#eventsblockmultiplace) - * [events.blockExplode()](#eventsblockexplode) - * [events.notePlay()](#eventsnoteplay) - * [events.cauldronLevelChange()](#eventscauldronlevelchange) - * [events.blockFade()](#eventsblockfade) - * [events.blockPlace()](#eventsblockplace-1) - * [events.blockPhysics()](#eventsblockphysics-1) - * [events.blockIgnite()](#eventsblockignite) - * [events.blockBreak()](#eventsblockbreak) - * [events.blockBurn()](#eventsblockburn) - * [events.blockFromTo()](#eventsblockfromto) - * [events.blockRedstone()](#eventsblockredstone) - * [events.blockPistonRetract()](#eventsblockpistonretract) - * [events.blockDispense()](#eventsblockdispense) - * [events.signChange()](#eventssignchange-1) - * [events.blockPistonExtend()](#eventsblockpistonextend) - * [events.blockCanBuild()](#eventsblockcanbuild) - * [events.blockGrow()](#eventsblockgrow-1) - * [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) - * [events.chunkUnload()](#eventschunkunload-1) - * [events.chunkPopulate()](#eventschunkpopulate) - * [events.portalCreate()](#eventsportalcreate-1) - * [events.chunkLoad()](#eventschunkload) + * [events.serviceUnregister()](#eventsserviceunregister) + * [events.tabComplete()](#eventstabcomplete) + * [events.mapInitialize()](#eventsmapinitialize) * [console global variable](#console-global-variable) * [Example](#example) * [Using string substitutions](#using-string-substitutions) @@ -413,11 +414,11 @@ Walter Higgins * [Examples](#examples) * [Fireworks Module](#fireworks-module) * [Examples](#examples-1) - * [Inventory Module](#inventory-module) - * [Usage](#usage-2) * [Classroom Plugin](#classroom-plugin) * [jsp classroom command](#jsp-classroom-command) * [classroom.allowScripting() function](#classroomallowscripting-function) + * [Inventory Module](#inventory-module) + * [Usage](#usage-2) * [Asynchronous Input Module](#asynchronous-input-module) * [Lightning module](#lightning-module) * [Usage](#usage-3) @@ -2058,6 +2059,1246 @@ to choose from any of the approx. 160 different event types to listen to. 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. +### events.blockFade() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockFadeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockFadeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockFromTo() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockFromToEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockFromToEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.notePlay() + +#### Parameters + + * callback - A function which is called whenever the [block.NotePlayEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/NotePlayEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockPlace() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockPlaceEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPlaceEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockGrow() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockGrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockGrowEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityBlockForm() + +#### Parameters + + * callback - A function which is called whenever the [block.EntityBlockFormEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/EntityBlockFormEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockPistonExtend() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockPistonExtendEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPistonExtendEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockPistonRetract() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockPistonRetractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPistonRetractEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockSpread() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockSpreadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockSpreadEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockBurn() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockBurnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockBurnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockDamage() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockDamageEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.leavesDecay() + +#### Parameters + + * callback - A function which is called whenever the [block.LeavesDecayEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/LeavesDecayEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockDispense() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockDispenseEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockDispenseEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockForm() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockFormEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockFormEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockMultiPlace() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockMultiPlaceEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockMultiPlaceEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockIgnite() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockIgniteEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockIgniteEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockPhysics() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockPhysicsEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPhysicsEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockRedstone() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockRedstoneEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockRedstoneEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.cauldronLevelChange() + +#### Parameters + + * callback - A function which is called whenever the [block.CauldronLevelChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/CauldronLevelChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockCanBuild() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockCanBuildEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockCanBuildEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.signChange() + +#### Parameters + + * callback - A function which is called whenever the [block.SignChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/SignChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockExp() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockExpEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockExpEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockExplode() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockExplodeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockExplodeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.blockBreak() + +#### Parameters + + * callback - A function which is called whenever the [block.BlockBreakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockBreakEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.prepareAnvil() + +#### Parameters + + * callback - A function which is called whenever the [inventory.PrepareAnvilEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/PrepareAnvilEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.brew() + +#### Parameters + + * callback - A function which is called whenever the [inventory.BrewEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/BrewEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventoryClose() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryCloseEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryCloseEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventoryDrag() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryDragEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryDragEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventoryCreative() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryCreativeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryCreativeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.prepareItemCraft() + +#### Parameters + + * callback - A function which is called whenever the [inventory.PrepareItemCraftEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/PrepareItemCraftEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.craftItem() + +#### Parameters + + * callback - A function which is called whenever the [inventory.CraftItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/CraftItemEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventoryClick() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryClickEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryClickEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.brewingStandFuel() + +#### Parameters + + * callback - A function which is called whenever the [inventory.BrewingStandFuelEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/BrewingStandFuelEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventoryPickupItem() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryPickupItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryPickupItemEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.furnaceExtract() + +#### Parameters + + * callback - A function which is called whenever the [inventory.FurnaceExtractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/FurnaceExtractEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventory() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.furnaceBurn() + +#### Parameters + + * callback - A function which is called whenever the [inventory.FurnaceBurnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/FurnaceBurnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.furnaceSmelt() + +#### Parameters + + * callback - A function which is called whenever the [inventory.FurnaceSmeltEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/FurnaceSmeltEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventoryOpen() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryOpenEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryOpenEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.inventoryMoveItem() + +#### Parameters + + * callback - A function which is called whenever the [inventory.InventoryMoveItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryMoveItemEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.hangingPlace() + +#### Parameters + + * callback - A function which is called whenever the [hanging.HangingPlaceEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/hanging/HangingPlaceEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.hangingBreak() + +#### Parameters + + * callback - A function which is called whenever the [hanging.HangingBreakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/hanging/HangingBreakEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.hangingBreakByEntity() + +#### Parameters + + * callback - A function which is called whenever the [hanging.HangingBreakByEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/hanging/HangingBreakByEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityToggleGlide() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityToggleGlideEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityToggleGlideEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.itemSpawn() + +#### Parameters + + * callback - A function which is called whenever the [entity.ItemSpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ItemSpawnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.spawnerSpawn() + +#### Parameters + + * callback - A function which is called whenever the [entity.SpawnerSpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SpawnerSpawnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.foodLevelChange() + +#### Parameters + + * callback - A function which is called whenever the [entity.FoodLevelChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/FoodLevelChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.lingeringPotionSplash() + +#### Parameters + + * callback - A function which is called whenever the [entity.LingeringPotionSplashEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/LingeringPotionSplashEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityShootBow() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityShootBowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityShootBowEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityTargetLivingEntity() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityTargetLivingEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTargetLivingEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityCombust() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityCombustEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCombustEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityBreed() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityBreedEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityBreedEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.expBottle() + +#### Parameters + + * callback - A function which is called whenever the [entity.ExpBottleEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ExpBottleEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.slimeSplit() + +#### Parameters + + * callback - A function which is called whenever the [entity.SlimeSplitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SlimeSplitEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityDeath() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityDeathEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDeathEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityAirChange() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityAirChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityAirChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.projectileLaunch() + +#### Parameters + + * callback - A function which is called whenever the [entity.ProjectileLaunchEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ProjectileLaunchEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityPortal() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityPortalEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityPortalEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.horseJump() + +#### Parameters + + * callback - A function which is called whenever the [entity.HorseJumpEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/HorseJumpEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.fireworkExplode() + +#### Parameters + + * callback - A function which is called whenever the [entity.FireworkExplodeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/FireworkExplodeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityExplode() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityExplodeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityExplodeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.itemMerge() + +#### Parameters + + * callback - A function which is called whenever the [entity.ItemMergeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ItemMergeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entitySpawn() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntitySpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntitySpawnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.projectileHit() + +#### Parameters + + * callback - A function which is called whenever the [entity.ProjectileHitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ProjectileHitEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.creatureSpawn() + +#### Parameters + + * callback - A function which is called whenever the [entity.CreatureSpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityPortalExit() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityPortalExitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityPortalExitEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityTame() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityTameEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTameEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityPortalEnter() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityPortalEnterEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityPortalEnterEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerLeashEntity() + +#### Parameters + + * callback - A function which is called whenever the [entity.PlayerLeashEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PlayerLeashEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityDamage() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.pigZap() + +#### Parameters + + * callback - A function which is called whenever the [entity.PigZapEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PigZapEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityCombustByEntity() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityCombustByEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCombustByEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityChangeBlock() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityChangeBlockEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityChangeBlockEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.areaEffectCloudApply() + +#### Parameters + + * callback - A function which is called whenever the [entity.AreaEffectCloudApplyEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/AreaEffectCloudApplyEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.creeperPower() + +#### Parameters + + * callback - A function which is called whenever the [entity.CreeperPowerEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreeperPowerEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.sheepDyeWool() + +#### Parameters + + * callback - A function which is called whenever the [entity.SheepDyeWoolEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SheepDyeWoolEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerDeath() + +#### Parameters + + * callback - A function which is called whenever the [entity.PlayerDeathEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PlayerDeathEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.villagerReplenishTrade() + +#### Parameters + + * callback - A function which is called whenever the [entity.VillagerReplenishTradeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/VillagerReplenishTradeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityCombustByBlock() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityCombustByBlockEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCombustByBlockEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityResurrect() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityResurrectEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityResurrectEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.villagerAcquireTrade() + +#### Parameters + + * callback - A function which is called whenever the [entity.VillagerAcquireTradeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/VillagerAcquireTradeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.enderDragonChangePhase() + +#### Parameters + + * callback - A function which is called whenever the [entity.EnderDragonChangePhaseEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EnderDragonChangePhaseEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityCreatePortal() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityCreatePortalEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCreatePortalEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.sheepRegrowWool() + +#### Parameters + + * callback - A function which is called whenever the [entity.SheepRegrowWoolEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SheepRegrowWoolEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityRegainHealth() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityRegainHealthEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityRegainHealthEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityInteract() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityInteractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityInteractEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.potionSplash() + +#### Parameters + + * callback - A function which is called whenever the [entity.PotionSplashEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PotionSplashEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityTarget() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityTargetEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTargetEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityBreakDoor() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityBreakDoorEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityBreakDoorEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityUnleash() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityUnleashEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityUnleashEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityDamageByBlock() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityDamageByBlockEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageByBlockEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityTeleport() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityTeleportEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTeleportEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.itemDespawn() + +#### Parameters + + * callback - A function which is called whenever the [entity.ItemDespawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ItemDespawnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.explosionPrime() + +#### Parameters + + * callback - A function which is called whenever the [entity.ExplosionPrimeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ExplosionPrimeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.entityDamageByEntity() + +#### Parameters + + * callback - A function which is called whenever the [entity.EntityDamageByEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageByEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.portalCreate() + +#### Parameters + + * callback - A function which is called whenever the [world.PortalCreateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/PortalCreateEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.worldSave() + +#### Parameters + + * callback - A function which is called whenever the [world.WorldSaveEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldSaveEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.worldLoad() + +#### Parameters + + * callback - A function which is called whenever the [world.WorldLoadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldLoadEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.chunkLoad() + +#### Parameters + + * callback - A function which is called whenever the [world.ChunkLoadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/ChunkLoadEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.chunkPopulate() + +#### Parameters + + * callback - A function which is called whenever the [world.ChunkPopulateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/ChunkPopulateEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.chunkUnload() + +#### Parameters + + * callback - A function which is called whenever the [world.ChunkUnloadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/ChunkUnloadEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.structureGrow() + +#### Parameters + + * callback - A function which is called whenever the [world.StructureGrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/StructureGrowEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.worldInit() + +#### Parameters + + * callback - A function which is called whenever the [world.WorldInitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldInitEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.spawnChange() + +#### Parameters + + * callback - A function which is called whenever the [world.SpawnChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/SpawnChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.worldUnload() + +#### Parameters + + * callback - A function which is called whenever the [world.WorldUnloadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldUnloadEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerShearEntity() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerShearEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerShearEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerVelocity() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerVelocityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerVelocityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerBucketFill() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerBucketFillEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBucketFillEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerFish() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerFishEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerFishEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerGameModeChange() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerGameModeChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerGameModeChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerCommandPreprocess() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerCommandPreprocessEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerCommandPreprocessEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerInteract() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerInteractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerInteractEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerInteractAtEntity() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerInteractAtEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerInteractAtEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerPortal() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerPortalEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPortalEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerPreLogin() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerPreLoginEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPreLoginEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerMove() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerMoveEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerMoveEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerQuit() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerQuitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerQuitEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerToggleSneak() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerToggleSneakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerToggleSneakEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerPickupArrow() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerPickupArrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPickupArrowEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerBedLeave() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerBedLeaveEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBedLeaveEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerChangedMainHand() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerChangedMainHandEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChangedMainHandEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerEditBook() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerEditBookEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerEditBookEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerAnimation() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerAnimationEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerAnimationEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerResourcePackStatus() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerResourcePackStatusEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerResourcePackStatusEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerItemDamage() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerItemDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemDamageEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerBucketEmpty() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerBucketEmptyEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBucketEmptyEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerExpChange() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerExpChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerExpChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.asyncPlayerChat() + +#### Parameters + + * callback - A function which is called whenever the [player.AsyncPlayerChatEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/AsyncPlayerChatEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerItemBreak() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerItemBreakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemBreakEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerUnleashEntity() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerUnleashEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerUnleashEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerRespawn() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerRespawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerRespawnEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerDropItem() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerDropItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerDropItemEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerItemHeld() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerItemHeldEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemHeldEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerTeleport() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerTeleportEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerTeleportEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerInteractEntity() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerInteractEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerInteractEntityEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerEggThrow() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerEggThrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerEggThrowEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerChat() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerChatEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChatEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerRegisterChannel() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerRegisterChannelEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerRegisterChannelEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerSwapHandItems() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerSwapHandItemsEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerSwapHandItemsEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerChangedWorld() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerChangedWorldEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChangedWorldEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerLevelChange() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerLevelChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerLevelChangeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerPickupItem() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerPickupItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPickupItemEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.asyncPlayerPreLogin() + +#### Parameters + + * callback - A function which is called whenever the [player.AsyncPlayerPreLoginEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/AsyncPlayerPreLoginEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerUnregisterChannel() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerUnregisterChannelEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerUnregisterChannelEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerStatisticIncrement() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerStatisticIncrementEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerStatisticIncrementEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerBedEnter() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerBedEnterEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBedEnterEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerKick() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerKickEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerKickEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerToggleSprint() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerToggleSprintEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerToggleSprintEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerAchievementAwarded() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerAchievementAwardedEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerAchievementAwardedEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerJoin() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerJoinEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerJoinEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerToggleFlight() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerToggleFlightEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerToggleFlightEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerArmorStandManipulate() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerArmorStandManipulateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerArmorStandManipulateEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerLogin() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerLoginEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerLoginEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerItemConsume() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerItemConsumeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemConsumeEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.playerChatTabComplete() + +#### Parameters + + * callback - A function which is called whenever the [player.PlayerChatTabCompleteEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChatTabCompleteEvent.html) is fired + + * priority - optional - see events.on() for more information. + ### events.weatherChange() #### Parameters @@ -2066,14 +3307,6 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. -### events.lightningStrike() - -#### Parameters - - * callback - A function which is called whenever the [weather.LightningStrikeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/weather/LightningStrikeEvent.html) is fired - - * priority - optional - see events.on() for more information. - ### events.thunderChange() #### Parameters @@ -2082,6 +3315,14 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. +### events.lightningStrike() + +#### Parameters + + * callback - A function which is called whenever the [weather.LightningStrikeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/weather/LightningStrikeEvent.html) is fired + + * priority - optional - see events.on() for more information. + ### events.vehicleMove() #### Parameters @@ -2090,6 +3331,14 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. +### events.vehicleDamage() + +#### Parameters + + * callback - A function which is called whenever the [vehicle.VehicleDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleDamageEvent.html) is fired + + * priority - optional - see events.on() for more information. + ### events.vehicleDestroy() #### Parameters @@ -2098,11 +3347,19 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. -### events.vehicleExit() +### events.vehicleUpdate() #### Parameters - * callback - A function which is called whenever the [vehicle.VehicleExitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleExitEvent.html) is fired + * callback - A function which is called whenever the [vehicle.VehicleUpdateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleUpdateEvent.html) is fired + + * priority - optional - see events.on() for more information. + +### events.vehicleCreate() + +#### Parameters + + * callback - A function which is called whenever the [vehicle.VehicleCreateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleCreateEvent.html) is fired * priority - optional - see events.on() for more information. @@ -2130,35 +3387,11 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. -### events.vehicleDamage() +### events.vehicleExit() #### Parameters - * callback - A function which is called whenever the [vehicle.VehicleDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleDamageEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.vehicleUpdate() - -#### Parameters - - * callback - A function which is called whenever the [vehicle.VehicleUpdateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleUpdateEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.vehicleCreate() - -#### Parameters - - * callback - A function which is called whenever the [vehicle.VehicleCreateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleCreateEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.enchantItem() - -#### Parameters - - * callback - A function which is called whenever the [enchantment.EnchantItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/enchantment/EnchantItemEvent.html) is fired + * callback - A function which is called whenever the [vehicle.VehicleExitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/vehicle/VehicleExitEvent.html) is fired * priority - optional - see events.on() for more information. @@ -2170,539 +3403,19 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. -### events.playerInteractEntity() +### events.enchantItem() #### Parameters - * callback - A function which is called whenever the [player.PlayerInteractEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerInteractEntityEvent.html) is fired + * callback - A function which is called whenever the [enchantment.EnchantItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/enchantment/EnchantItemEvent.html) is fired * priority - optional - see events.on() for more information. -### events.playerPickupArrow() +### events.pluginDisable() #### Parameters - * callback - A function which is called whenever the [player.PlayerPickupArrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPickupArrowEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerEggThrow() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerEggThrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerEggThrowEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerUnleashEntity() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerUnleashEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerUnleashEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerInventory() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerInventoryEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerInventoryEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerLevelChange() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerLevelChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerLevelChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerPortal() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerPortalEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPortalEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerItemConsume() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerItemConsumeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemConsumeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerTeleport() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerTeleportEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerTeleportEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerBedEnter() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerBedEnterEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBedEnterEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerUnregisterChannel() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerUnregisterChannelEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerUnregisterChannelEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerArmorStandManipulate() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerArmorStandManipulateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerArmorStandManipulateEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerChat() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerChatEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChatEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerShearEntity() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerShearEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerShearEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerItemDamage() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerItemDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemDamageEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.asyncPlayerChat() - -#### Parameters - - * callback - A function which is called whenever the [player.AsyncPlayerChatEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/AsyncPlayerChatEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerDropItem() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerDropItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerDropItemEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerRegisterChannel() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerRegisterChannelEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerRegisterChannelEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerMove() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerMoveEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerMoveEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerItemBreak() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerItemBreakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemBreakEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerBucketEmpty() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerBucketEmptyEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBucketEmptyEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerStatisticIncrement() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerStatisticIncrementEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerStatisticIncrementEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerToggleFlight() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerToggleFlightEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerToggleFlightEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerItemHeld() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerItemHeldEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerItemHeldEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerAchievementAwarded() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerAchievementAwardedEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerAchievementAwardedEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerToggleSneak() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerToggleSneakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerToggleSneakEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerExpChange() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerExpChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerExpChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerResourcePackStatus() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerResourcePackStatusEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerResourcePackStatusEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerPreLogin() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerPreLoginEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPreLoginEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerJoin() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerJoinEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerJoinEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerAnimation() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerAnimationEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerAnimationEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerEditBook() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerEditBookEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerEditBookEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerPickupItem() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerPickupItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerPickupItemEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerInteractAtEntity() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerInteractAtEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerInteractAtEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerChangedWorld() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerChangedWorldEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChangedWorldEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerFish() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerFishEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerFishEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerChatTabComplete() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerChatTabCompleteEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChatTabCompleteEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerRespawn() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerRespawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerRespawnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerBedLeave() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerBedLeaveEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBedLeaveEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.asyncPlayerPreLogin() - -#### Parameters - - * callback - A function which is called whenever the [player.AsyncPlayerPreLoginEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/AsyncPlayerPreLoginEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerInteract() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerInteractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerInteractEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerBucketFill() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerBucketFillEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerBucketFillEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerVelocity() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerVelocityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerVelocityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerQuit() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerQuitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerQuitEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerLogin() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerLoginEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerLoginEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerSwapHandItems() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerSwapHandItemsEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerSwapHandItemsEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerKick() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerKickEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerKickEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerToggleSprint() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerToggleSprintEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerToggleSprintEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerCommandPreprocess() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerCommandPreprocessEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerCommandPreprocessEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerChangedMainHand() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerChangedMainHandEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerChangedMainHandEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerGameModeChange() - -#### Parameters - - * callback - A function which is called whenever the [player.PlayerGameModeChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerGameModeChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.furnaceSmelt() - -#### Parameters - - * callback - A function which is called whenever the [inventory.FurnaceSmeltEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/FurnaceSmeltEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.prepareAnvil() - -#### Parameters - - * callback - A function which is called whenever the [inventory.PrepareAnvilEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/PrepareAnvilEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventoryDrag() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryDragEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryDragEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.craftItem() - -#### Parameters - - * callback - A function which is called whenever the [inventory.CraftItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/CraftItemEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.furnaceBurn() - -#### Parameters - - * callback - A function which is called whenever the [inventory.FurnaceBurnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/FurnaceBurnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventoryOpen() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryOpenEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryOpenEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventoryPickupItem() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryPickupItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryPickupItemEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventoryMoveItem() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryMoveItemEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryMoveItemEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventoryClick() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryClickEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryClickEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventoryClose() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryCloseEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryCloseEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventoryCreative() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryCreativeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryCreativeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.inventory() - -#### Parameters - - * callback - A function which is called whenever the [inventory.InventoryEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.prepareItemCraft() - -#### Parameters - - * callback - A function which is called whenever the [inventory.PrepareItemCraftEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/PrepareItemCraftEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.furnaceExtract() - -#### Parameters - - * callback - A function which is called whenever the [inventory.FurnaceExtractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/FurnaceExtractEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.brew() - -#### Parameters - - * callback - A function which is called whenever the [inventory.BrewEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/BrewEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.serverCommand() - -#### Parameters - - * callback - A function which is called whenever the [server.ServerCommandEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/ServerCommandEvent.html) is fired + * callback - A function which is called whenever the [server.PluginDisableEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/PluginDisableEvent.html) is fired * priority - optional - see events.on() for more information. @@ -2722,11 +3435,11 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. -### events.pluginDisable() +### events.serverCommand() #### Parameters - * callback - A function which is called whenever the [server.PluginDisableEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/PluginDisableEvent.html) is fired + * callback - A function which is called whenever the [server.ServerCommandEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/ServerCommandEvent.html) is fired * priority - optional - see events.on() for more information. @@ -2738,19 +3451,11 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. -### events.mapInitialize() +### events.pluginEnable() #### Parameters - * callback - A function which is called whenever the [server.MapInitializeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/MapInitializeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.tabComplete() - -#### Parameters - - * callback - A function which is called whenever the [server.TabCompleteEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/TabCompleteEvent.html) is fired + * callback - A function which is called whenever the [server.PluginEnableEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/PluginEnableEvent.html) is fired * priority - optional - see events.on() for more information. @@ -2762,715 +3467,19 @@ The crucial difference is that the events module now has functions for each of t * priority - optional - see events.on() for more information. -### events.pluginEnable() +### events.tabComplete() #### Parameters - * callback - A function which is called whenever the [server.PluginEnableEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/PluginEnableEvent.html) is fired + * callback - A function which is called whenever the [server.TabCompleteEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/TabCompleteEvent.html) is fired * priority - optional - see events.on() for more information. -### events.villagerAcquireTrade() +### events.mapInitialize() #### Parameters - * callback - A function which is called whenever the [entity.VillagerAcquireTradeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/VillagerAcquireTradeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityBreed() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityBreedEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityBreedEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityAirChange() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityAirChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityAirChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerDeath() - -#### Parameters - - * callback - A function which is called whenever the [entity.PlayerDeathEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PlayerDeathEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.enderDragonChangePhase() - -#### Parameters - - * callback - A function which is called whenever the [entity.EnderDragonChangePhaseEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EnderDragonChangePhaseEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityCreatePortal() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityCreatePortalEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCreatePortalEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityCombust() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityCombustEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCombustEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.sheepDyeWool() - -#### Parameters - - * callback - A function which is called whenever the [entity.SheepDyeWoolEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SheepDyeWoolEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.expBottle() - -#### Parameters - - * callback - A function which is called whenever the [entity.ExpBottleEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ExpBottleEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityTame() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityTameEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTameEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.projectileLaunch() - -#### Parameters - - * callback - A function which is called whenever the [entity.ProjectileLaunchEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ProjectileLaunchEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityDamage() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.itemSpawn() - -#### Parameters - - * callback - A function which is called whenever the [entity.ItemSpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ItemSpawnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.projectileHit() - -#### Parameters - - * callback - A function which is called whenever the [entity.ProjectileHitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ProjectileHitEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.foodLevelChange() - -#### Parameters - - * callback - A function which is called whenever the [entity.FoodLevelChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/FoodLevelChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.itemDespawn() - -#### Parameters - - * callback - A function which is called whenever the [entity.ItemDespawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ItemDespawnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.villagerReplenishTrade() - -#### Parameters - - * callback - A function which is called whenever the [entity.VillagerReplenishTradeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/VillagerReplenishTradeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityPortalEnter() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityPortalEnterEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityPortalEnterEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.areaEffectCloudApply() - -#### Parameters - - * callback - A function which is called whenever the [entity.AreaEffectCloudApplyEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/AreaEffectCloudApplyEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityPortal() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityPortalEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityPortalEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityTarget() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityTargetEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTargetEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityDeath() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityDeathEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDeathEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entitySpawn() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntitySpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntitySpawnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.lingeringPotionSplash() - -#### Parameters - - * callback - A function which is called whenever the [entity.LingeringPotionSplashEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/LingeringPotionSplashEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.sheepRegrowWool() - -#### Parameters - - * callback - A function which is called whenever the [entity.SheepRegrowWoolEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SheepRegrowWoolEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityShootBow() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityShootBowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityShootBowEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.creeperPower() - -#### Parameters - - * callback - A function which is called whenever the [entity.CreeperPowerEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreeperPowerEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityCombustByBlock() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityCombustByBlockEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCombustByBlockEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityBreakDoor() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityBreakDoorEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityBreakDoorEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityDamageByEntity() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityDamageByEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageByEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityUnleash() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityUnleashEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityUnleashEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityExplode() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityExplodeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityExplodeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityInteract() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityInteractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityInteractEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityToggleGlide() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityToggleGlideEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityToggleGlideEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.explosionPrime() - -#### Parameters - - * callback - A function which is called whenever the [entity.ExplosionPrimeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ExplosionPrimeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.horseJump() - -#### Parameters - - * callback - A function which is called whenever the [entity.HorseJumpEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/HorseJumpEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.creatureSpawn() - -#### Parameters - - * callback - A function which is called whenever the [entity.CreatureSpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityCombustByEntity() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityCombustByEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityCombustByEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityDamageByBlock() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityDamageByBlockEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageByBlockEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityTargetLivingEntity() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityTargetLivingEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTargetLivingEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityTeleport() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityTeleportEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityTeleportEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.playerLeashEntity() - -#### Parameters - - * callback - A function which is called whenever the [entity.PlayerLeashEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PlayerLeashEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.spawnerSpawn() - -#### Parameters - - * callback - A function which is called whenever the [entity.SpawnerSpawnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SpawnerSpawnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.itemMerge() - -#### Parameters - - * callback - A function which is called whenever the [entity.ItemMergeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/ItemMergeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.slimeSplit() - -#### Parameters - - * callback - A function which is called whenever the [entity.SlimeSplitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/SlimeSplitEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.pigZap() - -#### Parameters - - * callback - A function which is called whenever the [entity.PigZapEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PigZapEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.fireworkExplode() - -#### Parameters - - * callback - A function which is called whenever the [entity.FireworkExplodeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/FireworkExplodeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.potionSplash() - -#### Parameters - - * callback - A function which is called whenever the [entity.PotionSplashEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/PotionSplashEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityChangeBlock() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityChangeBlockEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityChangeBlockEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityPortalExit() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityPortalExitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityPortalExitEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityRegainHealth() - -#### Parameters - - * callback - A function which is called whenever the [entity.EntityRegainHealthEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityRegainHealthEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.entityBlockForm() - -#### Parameters - - * callback - A function which is called whenever the [block.EntityBlockFormEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/EntityBlockFormEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockSpread() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockSpreadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockSpreadEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockMultiPlace() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockMultiPlaceEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockMultiPlaceEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockExplode() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockExplodeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockExplodeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.notePlay() - -#### Parameters - - * callback - A function which is called whenever the [block.NotePlayEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/NotePlayEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.cauldronLevelChange() - -#### Parameters - - * callback - A function which is called whenever the [block.CauldronLevelChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/CauldronLevelChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockFade() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockFadeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockFadeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockPlace() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockPlaceEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPlaceEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockPhysics() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockPhysicsEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPhysicsEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockIgnite() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockIgniteEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockIgniteEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockBreak() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockBreakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockBreakEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockBurn() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockBurnEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockBurnEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockFromTo() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockFromToEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockFromToEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockRedstone() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockRedstoneEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockRedstoneEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockPistonRetract() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockPistonRetractEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPistonRetractEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockDispense() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockDispenseEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockDispenseEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.signChange() - -#### Parameters - - * callback - A function which is called whenever the [block.SignChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/SignChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockPistonExtend() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockPistonExtendEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockPistonExtendEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockCanBuild() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockCanBuildEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockCanBuildEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockGrow() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockGrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockGrowEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.leavesDecay() - -#### Parameters - - * callback - A function which is called whenever the [block.LeavesDecayEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/LeavesDecayEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockExp() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockExpEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockExpEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockForm() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockFormEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockFormEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.blockDamage() - -#### Parameters - - * callback - A function which is called whenever the [block.BlockDamageEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/block/BlockDamageEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.hangingPlace() - -#### Parameters - - * callback - A function which is called whenever the [hanging.HangingPlaceEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/hanging/HangingPlaceEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.hangingBreakByEntity() - -#### Parameters - - * callback - A function which is called whenever the [hanging.HangingBreakByEntityEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/hanging/HangingBreakByEntityEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.hangingBreak() - -#### Parameters - - * callback - A function which is called whenever the [hanging.HangingBreakEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/hanging/HangingBreakEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.structureGrow() - -#### Parameters - - * callback - A function which is called whenever the [world.StructureGrowEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/StructureGrowEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.spawnChange() - -#### Parameters - - * callback - A function which is called whenever the [world.SpawnChangeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/SpawnChangeEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.worldLoad() - -#### Parameters - - * callback - A function which is called whenever the [world.WorldLoadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldLoadEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.worldInit() - -#### Parameters - - * callback - A function which is called whenever the [world.WorldInitEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldInitEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.worldUnload() - -#### Parameters - - * callback - A function which is called whenever the [world.WorldUnloadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldUnloadEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.worldSave() - -#### Parameters - - * callback - A function which is called whenever the [world.WorldSaveEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/WorldSaveEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.chunkUnload() - -#### Parameters - - * callback - A function which is called whenever the [world.ChunkUnloadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/ChunkUnloadEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.chunkPopulate() - -#### Parameters - - * callback - A function which is called whenever the [world.ChunkPopulateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/ChunkPopulateEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.portalCreate() - -#### Parameters - - * callback - A function which is called whenever the [world.PortalCreateEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/PortalCreateEvent.html) is fired - - * priority - optional - see events.on() for more information. - -### events.chunkLoad() - -#### Parameters - - * callback - A function which is called whenever the [world.ChunkLoadEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/world/ChunkLoadEvent.html) is fired + * callback - A function which is called whenever the [server.MapInitializeEvent event](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/server/MapInitializeEvent.html) is fired * priority - optional - see events.on() for more information. @@ -4786,42 +4795,6 @@ location. For example... ![firework example](img/firework.png) -## Inventory Module -This module provides functions to add items to, remove items from and check the -contents of a player or NPC's inventory. - -### Usage -The inventory module is best used in conjunction with the items module. See below for examples of usage. - -```javascript -var inventory = require('inventory'); -var items = require('items'); -var utils = require('utils'); - -// gives every player a cookie and a baked potatoe -utils.players(function(player){ - inventory(player) - .add( items.cookie(1) ) - .add( items.bakedPotato(1) ) -}); - -// give a player 6 cookies then take away 4 of them - -inventory(player) - .add( items.cookie(6) ) - .remove ( items.cookie(4) ) - -// check if a player has any cookies - -var hasCookies = inventory(player).contains( items.cookie(1) ); - -``` -The inventory module exposes a single function which when passed a player or NPC will return an object with 3 methods: - -* add : Adds items to the inventory (Expects parameters of type `net.canarymod.api.inventory.Item` - I strongly recommend using the `items` module for constructing items) -* remove : removes items from the inventory (Expects parameters of type `net.canarymod.api.inventory.Item` - I strongly recommend using the `items` module for constructing items) -* contains : checks to see if there is the specified type and amount of item in the inventory (Expects parameters of type `net.canarymod.api.inventory.Item` - I strongly recommend using the `items` module for constructing items) - ## Classroom Plugin The `classroom` object contains a couple of utility functions for use @@ -4919,6 +4892,42 @@ To disallow scripting (and prevent players who join the server from using the co 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. +## Inventory Module +This module provides functions to add items to, remove items from and check the +contents of a player or NPC's inventory. + +### Usage +The inventory module is best used in conjunction with the items module. See below for examples of usage. + +```javascript +var inventory = require('inventory'); +var items = require('items'); +var utils = require('utils'); + +// gives every player a cookie and a baked potatoe +utils.players(function(player){ + inventory(player) + .add( items.cookie(1) ) + .add( items.bakedPotato(1) ) +}); + +// give a player 6 cookies then take away 4 of them + +inventory(player) + .add( items.cookie(6) ) + .remove ( items.cookie(4) ) + +// check if a player has any cookies + +var hasCookies = inventory(player).contains( items.cookie(1) ); + +``` +The inventory module exposes a single function which when passed a player or NPC will return an object with 3 methods: + +* add : Adds items to the inventory (Expects parameters of type `net.canarymod.api.inventory.Item` - I strongly recommend using the `items` module for constructing items) +* remove : removes items from the inventory (Expects parameters of type `net.canarymod.api.inventory.Item` - I strongly recommend using the `items` module for constructing items) +* contains : checks to see if there is the specified type and amount of item in the inventory (Expects parameters of type `net.canarymod.api.inventory.Item` - I strongly recommend using the `items` module for constructing items) + ## Asynchronous Input Module The `input` module provides a simple way to prompt players for input at the @@ -6041,8 +6050,8 @@ Allows in-game operators to easily spawn creatures at current location. 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 - (CanaryMod) -or (Bukkit) + (Bukkit/SpigotMC) +or (CanaryMod) for a list of possible entities (creatures) which can be spawned. @@ -6326,8 +6335,10 @@ The following functions are provided: * birchFence() * birchFenceGate() * birchWoodStairs() + * blackShulkerBox() * blazePowder() * blazeRod() + * blueShulkerBox() * boat() * boatAcacia() * boatBirch() @@ -6347,6 +6358,7 @@ The following functions are provided: * brick() * brickStairs() * brownMushroom() + * brownShulkerBox() * bucket() * burningFurnace() * cactus() @@ -6389,6 +6401,7 @@ The following functions are provided: * cookedRabbit() * cookie() * crops() + * cyanShulkerBox() * darkOakDoor() * darkOakDoorItem() * darkOakFence() @@ -6484,7 +6497,9 @@ The following functions are provided: * grass() * grassPath() * gravel() + * grayShulkerBox() * greenRecord() + * greenShulkerBox() * grilledPork() * hardClay() * hayBlock() @@ -6534,10 +6549,13 @@ The following functions are provided: * leaves() * leaves2() * lever() + * lightBlueShulkerBox() + * limeShulkerBox() * lingeringPotion() * log() * log2() * longGrass() + * magentaShulkerBox() * magma() * magmaCream() * map() @@ -6565,10 +6583,13 @@ The following functions are provided: * netherWarts() * netherrack() * noteBlock() + * observer() * obsidian() + * orangeShulkerBox() * packedIce() * painting() * paper() + * pinkShulkerBox() * pistonBase() * pistonExtension() * pistonMovingPiece() @@ -6588,6 +6609,7 @@ The following functions are provided: * pumpkinPie() * pumpkinSeeds() * pumpkinStem() + * purpleShulkerBox() * purpurBlock() * purpurDoubleSlab() * purpurPillar() @@ -6620,6 +6642,7 @@ The following functions are provided: * redRose() * redSandstone() * redSandstoneStairs() + * redShulkerBox() * redstone() * redstoneBlock() * redstoneComparator() @@ -6641,8 +6664,10 @@ The following functions are provided: * seeds() * shears() * shield() + * shulkerShell() * sign() * signPost() + * silverShulkerBox() * skull() * skullItem() * slimeBall() @@ -6693,6 +6718,7 @@ The following functions are provided: * tippedArrow() * tnt() * torch() + * totem() * trapDoor() * trappedChest() * tripwire() @@ -6706,6 +6732,7 @@ The following functions are provided: * waterLily() * web() * wheat() + * whiteShulkerBox() * wood() * woodAxe() * woodButton() @@ -6723,6 +6750,7 @@ The following functions are provided: * workbench() * writtenBook() * yellowFlower() + * yellowShulkerBox() ## Items module (CanaryMod version) @@ -7294,15 +7322,19 @@ The following functions are provided: * complex_part() * cow() * creeper() + * donkey() * dragon_fireball() * dropped_item() * egg() + * elder_guardian() * ender_crystal() * ender_dragon() * ender_pearl() * ender_signal() * enderman() * endermite() + * evoker() + * evoker_fangs() * experience_orb() * falling_block() * fireball() @@ -7312,11 +7344,14 @@ The following functions are provided: * giant() * guardian() * horse() + * husk() * iron_golem() * item_frame() * leash_hitch() * lightning() * lingering_potion() + * llama() + * llama_spit() * magma_cube() * minecart() * minecart_chest() @@ -7325,6 +7360,7 @@ The following functions are provided: * minecart_hopper() * minecart_mob_spawner() * minecart_tnt() + * mule() * mushroom_cow() * ocelot() * painting() @@ -7339,6 +7375,7 @@ The following functions are provided: * shulker_bullet() * silverfish() * skeleton() + * skeleton_horse() * slime() * small_fireball() * snowball() @@ -7347,14 +7384,20 @@ The following functions are provided: * spider() * splash_potion() * squid() + * stray() * thrown_exp_bottle() * tipped_arrow() * unknown() + * vex() * villager() + * vindicator() * weather() * witch() * wither() + * wither_skeleton() * wither_skull() * wolf() * zombie() + * zombie_horse() + * zombie_villager() diff --git a/src/main/js/modules/spawn.js b/src/main/js/modules/spawn.js index 7d33b04..088f437 100644 --- a/src/main/js/modules/spawn.js +++ b/src/main/js/modules/spawn.js @@ -8,6 +8,9 @@ module.exports = function(entityType, location){ entityTypeFn = entities[entityType.toLowerCase()]; entityType = entityTypeFn(); } + if (typeof entityType === 'function'){ + entityType = entityType(); + } var world = location.world; if (__plugin.bukkit){ world.spawnEntity( location, entityType); diff --git a/src/main/js/plugins/spawn.js b/src/main/js/plugins/spawn.js index b9a4ecc..2ff425a 100644 --- a/src/main/js/plugins/spawn.js +++ b/src/main/js/plugins/spawn.js @@ -15,8 +15,8 @@ Allows in-game operators to easily spawn creatures at current location. 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 - (CanaryMod) -or (Bukkit) + (Bukkit/SpigotMC) +or (CanaryMod) for a list of possible entities (creatures) which can be spawned.