Skip to content

Latest commit

 

History

History
2186 lines (2155 loc) · 49.1 KB

API-Reference.md

File metadata and controls

2186 lines (2155 loc) · 49.1 KB

ScriptCraft API Reference

Walter Higgins

[email protected]

Table of Contents

Items module (SpigotMC version)

The Items module provides a suite of functions - one for each possible item. See https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html for a list of possible items

Usage

items.book(); // returns org.bukkit.Material.BOOK
items.book(2); // returns a new org.bukkit.inventory.ItemStack object of 2 books
items.book( itemType ); // compares itemType parameter to org.bukkit.Material.BOOK or an Item of type book

The following functions are provided:

  • acaciaBoat()
  • acaciaButton()
  • acaciaDoor()
  • acaciaFence()
  • acaciaFenceGate()
  • acaciaLeaves()
  • acaciaLog()
  • acaciaPlanks()
  • acaciaPressurePlate()
  • acaciaSapling()
  • acaciaSlab()
  • acaciaStairs()
  • acaciaTrapdoor()
  • acaciaWood()
  • activatorRail()
  • air()
  • allium()
  • andesite()
  • anvil()
  • apple()
  • armorStand()
  • arrow()
  • attachedMelonStem()
  • attachedPumpkinStem()
  • azureBluet()
  • bakedPotato()
  • barrier()
  • batSpawnEgg()
  • beacon()
  • bedrock()
  • beef()
  • beetroot()
  • beetrootSeeds()
  • beetrootSoup()
  • beetroots()
  • birchBoat()
  • birchButton()
  • birchDoor()
  • birchFence()
  • birchFenceGate()
  • birchLeaves()
  • birchLog()
  • birchPlanks()
  • birchPressurePlate()
  • birchSapling()
  • birchSlab()
  • birchStairs()
  • birchTrapdoor()
  • birchWood()
  • blackBanner()
  • blackBed()
  • blackCarpet()
  • blackConcrete()
  • blackConcretePowder()
  • blackGlazedTerracotta()
  • blackShulkerBox()
  • blackStainedGlass()
  • blackStainedGlassPane()
  • blackTerracotta()
  • blackWallBanner()
  • blackWool()
  • blazePowder()
  • blazeRod()
  • blazeSpawnEgg()
  • blueBanner()
  • blueBed()
  • blueCarpet()
  • blueConcrete()
  • blueConcretePowder()
  • blueGlazedTerracotta()
  • blueIce()
  • blueOrchid()
  • blueShulkerBox()
  • blueStainedGlass()
  • blueStainedGlassPane()
  • blueTerracotta()
  • blueWallBanner()
  • blueWool()
  • bone()
  • boneBlock()
  • boneMeal()
  • book()
  • bookshelf()
  • bow()
  • bowl()
  • brainCoral()
  • brainCoralBlock()
  • brainCoralFan()
  • brainCoralWallFan()
  • bread()
  • brewingStand()
  • brick()
  • brickSlab()
  • brickStairs()
  • bricks()
  • brownBanner()
  • brownBed()
  • brownCarpet()
  • brownConcrete()
  • brownConcretePowder()
  • brownGlazedTerracotta()
  • brownMushroom()
  • brownMushroomBlock()
  • brownShulkerBox()
  • brownStainedGlass()
  • brownStainedGlassPane()
  • brownTerracotta()
  • brownWallBanner()
  • brownWool()
  • bubbleColumn()
  • bubbleCoral()
  • bubbleCoralBlock()
  • bubbleCoralFan()
  • bubbleCoralWallFan()
  • bucket()
  • cactus()
  • cactusGreen()
  • cake()
  • carrot()
  • carrotOnAStick()
  • carrots()
  • carvedPumpkin()
  • cauldron()
  • caveAir()
  • caveSpiderSpawnEgg()
  • chainCommandBlock()
  • chainmailBoots()
  • chainmailChestplate()
  • chainmailHelmet()
  • chainmailLeggings()
  • charcoal()
  • chest()
  • chestMinecart()
  • chicken()
  • chickenSpawnEgg()
  • chippedAnvil()
  • chiseledQuartzBlock()
  • chiseledRedSandstone()
  • chiseledSandstone()
  • chiseledStoneBricks()
  • chorusFlower()
  • chorusFruit()
  • chorusPlant()
  • clay()
  • clayBall()
  • clock()
  • coal()
  • coalBlock()
  • coalOre()
  • coarseDirt()
  • cobblestone()
  • cobblestoneSlab()
  • cobblestoneStairs()
  • cobblestoneWall()
  • cobweb()
  • cocoa()
  • cocoaBeans()
  • cod()
  • codBucket()
  • codSpawnEgg()
  • commandBlock()
  • commandBlockMinecart()
  • comparator()
  • compass()
  • conduit()
  • cookedBeef()
  • cookedChicken()
  • cookedCod()
  • cookedMutton()
  • cookedPorkchop()
  • cookedRabbit()
  • cookedSalmon()
  • cookie()
  • cowSpawnEgg()
  • crackedStoneBricks()
  • craftingTable()
  • creeperHead()
  • creeperSpawnEgg()
  • creeperWallHead()
  • cutRedSandstone()
  • cutSandstone()
  • cyanBanner()
  • cyanBed()
  • cyanCarpet()
  • cyanConcrete()
  • cyanConcretePowder()
  • cyanDye()
  • cyanGlazedTerracotta()
  • cyanShulkerBox()
  • cyanStainedGlass()
  • cyanStainedGlassPane()
  • cyanTerracotta()
  • cyanWallBanner()
  • cyanWool()
  • damagedAnvil()
  • dandelion()
  • dandelionYellow()
  • darkOakBoat()
  • darkOakButton()
  • darkOakDoor()
  • darkOakFence()
  • darkOakFenceGate()
  • darkOakLeaves()
  • darkOakLog()
  • darkOakPlanks()
  • darkOakPressurePlate()
  • darkOakSapling()
  • darkOakSlab()
  • darkOakStairs()
  • darkOakTrapdoor()
  • darkOakWood()
  • darkPrismarine()
  • darkPrismarineSlab()
  • darkPrismarineStairs()
  • daylightDetector()
  • deadBrainCoral()
  • deadBrainCoralBlock()
  • deadBrainCoralFan()
  • deadBrainCoralWallFan()
  • deadBubbleCoral()
  • deadBubbleCoralBlock()
  • deadBubbleCoralFan()
  • deadBubbleCoralWallFan()
  • deadBush()
  • deadFireCoral()
  • deadFireCoralBlock()
  • deadFireCoralFan()
  • deadFireCoralWallFan()
  • deadHornCoral()
  • deadHornCoralBlock()
  • deadHornCoralFan()
  • deadHornCoralWallFan()
  • deadTubeCoral()
  • deadTubeCoralBlock()
  • deadTubeCoralFan()
  • deadTubeCoralWallFan()
  • debugStick()
  • detectorRail()
  • diamond()
  • diamondAxe()
  • diamondBlock()
  • diamondBoots()
  • diamondChestplate()
  • diamondHelmet()
  • diamondHoe()
  • diamondHorseArmor()
  • diamondLeggings()
  • diamondOre()
  • diamondPickaxe()
  • diamondShovel()
  • diamondSword()
  • diorite()
  • dirt()
  • dispenser()
  • dolphinSpawnEgg()
  • donkeySpawnEgg()
  • dragonBreath()
  • dragonEgg()
  • dragonHead()
  • dragonWallHead()
  • driedKelp()
  • driedKelpBlock()
  • dropper()
  • drownedSpawnEgg()
  • egg()
  • elderGuardianSpawnEgg()
  • elytra()
  • emerald()
  • emeraldBlock()
  • emeraldOre()
  • enchantedBook()
  • enchantedGoldenApple()
  • enchantingTable()
  • endCrystal()
  • endGateway()
  • endPortal()
  • endPortalFrame()
  • endRod()
  • endStone()
  • endStoneBricks()
  • enderChest()
  • enderEye()
  • enderPearl()
  • endermanSpawnEgg()
  • endermiteSpawnEgg()
  • evokerSpawnEgg()
  • experienceBottle()
  • farmland()
  • feather()
  • fermentedSpiderEye()
  • fern()
  • filledMap()
  • fire()
  • fireCharge()
  • fireCoral()
  • fireCoralBlock()
  • fireCoralFan()
  • fireCoralWallFan()
  • fireworkRocket()
  • fireworkStar()
  • fishingRod()
  • flint()
  • flintAndSteel()
  • flowerPot()
  • frostedIce()
  • furnace()
  • furnaceMinecart()
  • ghastSpawnEgg()
  • ghastTear()
  • glass()
  • glassBottle()
  • glassPane()
  • glisteringMelonSlice()
  • glowstone()
  • glowstoneDust()
  • goldBlock()
  • goldIngot()
  • goldNugget()
  • goldOre()
  • goldenApple()
  • goldenAxe()
  • goldenBoots()
  • goldenCarrot()
  • goldenChestplate()
  • goldenHelmet()
  • goldenHoe()
  • goldenHorseArmor()
  • goldenLeggings()
  • goldenPickaxe()
  • goldenShovel()
  • goldenSword()
  • granite()
  • grass()
  • grassBlock()
  • grassPath()
  • gravel()
  • grayBanner()
  • grayBed()
  • grayCarpet()
  • grayConcrete()
  • grayConcretePowder()
  • grayDye()
  • grayGlazedTerracotta()
  • grayShulkerBox()
  • grayStainedGlass()
  • grayStainedGlassPane()
  • grayTerracotta()
  • grayWallBanner()
  • grayWool()
  • greenBanner()
  • greenBed()
  • greenCarpet()
  • greenConcrete()
  • greenConcretePowder()
  • greenGlazedTerracotta()
  • greenShulkerBox()
  • greenStainedGlass()
  • greenStainedGlassPane()
  • greenTerracotta()
  • greenWallBanner()
  • greenWool()
  • guardianSpawnEgg()
  • gunpowder()
  • hayBlock()
  • heartOfTheSea()
  • heavyWeightedPressurePlate()
  • hopper()
  • hopperMinecart()
  • hornCoral()
  • hornCoralBlock()
  • hornCoralFan()
  • hornCoralWallFan()
  • horseSpawnEgg()
  • huskSpawnEgg()
  • ice()
  • infestedChiseledStoneBricks()
  • infestedCobblestone()
  • infestedCrackedStoneBricks()
  • infestedMossyStoneBricks()
  • infestedStone()
  • infestedStoneBricks()
  • inkSac()
  • ironAxe()
  • ironBars()
  • ironBlock()
  • ironBoots()
  • ironChestplate()
  • ironDoor()
  • ironHelmet()
  • ironHoe()
  • ironHorseArmor()
  • ironIngot()
  • ironLeggings()
  • ironNugget()
  • ironOre()
  • ironPickaxe()
  • ironShovel()
  • ironSword()
  • ironTrapdoor()
  • itemFrame()
  • jackOLantern()
  • jukebox()
  • jungleBoat()
  • jungleButton()
  • jungleDoor()
  • jungleFence()
  • jungleFenceGate()
  • jungleLeaves()
  • jungleLog()
  • junglePlanks()
  • junglePressurePlate()
  • jungleSapling()
  • jungleSlab()
  • jungleStairs()
  • jungleTrapdoor()
  • jungleWood()
  • kelp()
  • kelpPlant()
  • knowledgeBook()
  • ladder()
  • lapisBlock()
  • lapisLazuli()
  • lapisOre()
  • largeFern()
  • lava()
  • lavaBucket()
  • lead()
  • leather()
  • leatherBoots()
  • leatherChestplate()
  • leatherHelmet()
  • leatherLeggings()
  • legacyAcaciaDoor()
  • legacyAcaciaDoorItem()
  • legacyAcaciaFence()
  • legacyAcaciaFenceGate()
  • legacyAcaciaStairs()
  • legacyActivatorRail()
  • legacyAir()
  • legacyAnvil()
  • legacyApple()
  • legacyArmorStand()
  • legacyArrow()
  • legacyBakedPotato()
  • legacyBanner()
  • legacyBarrier()
  • legacyBeacon()
  • legacyBed()
  • legacyBedBlock()
  • legacyBedrock()
  • legacyBeetroot()
  • legacyBeetrootBlock()
  • legacyBeetrootSeeds()
  • legacyBeetrootSoup()
  • legacyBirchDoor()
  • legacyBirchDoorItem()
  • legacyBirchFence()
  • legacyBirchFenceGate()
  • legacyBirchWoodStairs()
  • legacyBlackGlazedTerracotta()
  • legacyBlackShulkerBox()
  • legacyBlazePowder()
  • legacyBlazeRod()
  • legacyBlueGlazedTerracotta()
  • legacyBlueShulkerBox()
  • legacyBoat()
  • legacyBoatAcacia()
  • legacyBoatBirch()
  • legacyBoatDarkOak()
  • legacyBoatJungle()
  • legacyBoatSpruce()
  • legacyBone()
  • legacyBoneBlock()
  • legacyBook()
  • legacyBookAndQuill()
  • legacyBookshelf()
  • legacyBow()
  • legacyBowl()
  • legacyBread()
  • legacyBrewingStand()
  • legacyBrewingStandItem()
  • legacyBrick()
  • legacyBrickStairs()
  • legacyBrownGlazedTerracotta()
  • legacyBrownMushroom()
  • legacyBrownShulkerBox()
  • legacyBucket()
  • legacyBurningFurnace()
  • legacyCactus()
  • legacyCake()
  • legacyCakeBlock()
  • legacyCarpet()
  • legacyCarrot()
  • legacyCarrotItem()
  • legacyCarrotStick()
  • legacyCauldron()
  • legacyCauldronItem()
  • legacyChainmailBoots()
  • legacyChainmailChestplate()
  • legacyChainmailHelmet()
  • legacyChainmailLeggings()
  • legacyChest()
  • legacyChorusFlower()
  • legacyChorusFruit()
  • legacyChorusFruitPopped()
  • legacyChorusPlant()
  • legacyClay()
  • legacyClayBall()
  • legacyClayBrick()
  • legacyCoal()
  • legacyCoalBlock()
  • legacyCoalOre()
  • legacyCobbleWall()
  • legacyCobblestone()
  • legacyCobblestoneStairs()
  • legacyCocoa()
  • legacyCommand()
  • legacyCommandChain()
  • legacyCommandMinecart()
  • legacyCommandRepeating()
  • legacyCompass()
  • legacyConcrete()
  • legacyConcretePowder()
  • legacyCookedBeef()
  • legacyCookedChicken()
  • legacyCookedFish()
  • legacyCookedMutton()
  • legacyCookedRabbit()
  • legacyCookie()
  • legacyCrops()
  • legacyCyanGlazedTerracotta()
  • legacyCyanShulkerBox()
  • legacyDarkOakDoor()
  • legacyDarkOakDoorItem()
  • legacyDarkOakFence()
  • legacyDarkOakFenceGate()
  • legacyDarkOakStairs()
  • legacyDaylightDetector()
  • legacyDaylightDetectorInverted()
  • legacyDeadBush()
  • legacyDetectorRail()
  • legacyDiamond()
  • legacyDiamondAxe()
  • legacyDiamondBarding()
  • legacyDiamondBlock()
  • legacyDiamondBoots()
  • legacyDiamondChestplate()
  • legacyDiamondHelmet()
  • legacyDiamondHoe()
  • legacyDiamondLeggings()
  • legacyDiamondOre()
  • legacyDiamondPickaxe()
  • legacyDiamondSpade()
  • legacyDiamondSword()
  • legacyDiode()
  • legacyDiodeBlockOff()
  • legacyDiodeBlockOn()
  • legacyDirt()
  • legacyDispenser()
  • legacyDoublePlant()
  • legacyDoubleStep()
  • legacyDoubleStoneSlab2()
  • legacyDragonEgg()
  • legacyDragonsBreath()
  • legacyDropper()
  • legacyEgg()
  • legacyElytra()
  • legacyEmerald()
  • legacyEmeraldBlock()
  • legacyEmeraldOre()
  • legacyEmptyMap()
  • legacyEnchantedBook()
  • legacyEnchantmentTable()
  • legacyEndBricks()
  • legacyEndCrystal()
  • legacyEndGateway()
  • legacyEndRod()
  • legacyEnderChest()
  • legacyEnderPearl()
  • legacyEnderPortal()
  • legacyEnderPortalFrame()
  • legacyEnderStone()
  • legacyExpBottle()
  • legacyExplosiveMinecart()
  • legacyEyeOfEnder()
  • legacyFeather()
  • legacyFence()
  • legacyFenceGate()
  • legacyFermentedSpiderEye()
  • legacyFire()
  • legacyFireball()
  • legacyFirework()
  • legacyFireworkCharge()
  • legacyFishingRod()
  • legacyFlint()
  • legacyFlintAndSteel()
  • legacyFlowerPot()
  • legacyFlowerPotItem()
  • legacyFrostedIce()
  • legacyFurnace()
  • legacyGhastTear()
  • legacyGlass()
  • legacyGlassBottle()
  • legacyGlowingRedstoneOre()
  • legacyGlowstone()
  • legacyGlowstoneDust()
  • legacyGoldAxe()
  • legacyGoldBarding()
  • legacyGoldBlock()
  • legacyGoldBoots()
  • legacyGoldChestplate()
  • legacyGoldHelmet()
  • legacyGoldHoe()
  • legacyGoldIngot()
  • legacyGoldLeggings()
  • legacyGoldNugget()
  • legacyGoldOre()
  • legacyGoldPickaxe()
  • legacyGoldPlate()
  • legacyGoldRecord()
  • legacyGoldSpade()
  • legacyGoldSword()
  • legacyGoldenApple()
  • legacyGoldenCarrot()
  • legacyGrass()
  • legacyGrassPath()
  • legacyGravel()
  • legacyGrayGlazedTerracotta()
  • legacyGrayShulkerBox()
  • legacyGreenGlazedTerracotta()
  • legacyGreenRecord()
  • legacyGreenShulkerBox()
  • legacyGrilledPork()
  • legacyHardClay()
  • legacyHayBlock()
  • legacyHopper()
  • legacyHopperMinecart()
  • legacyHugeMushroom1()
  • legacyHugeMushroom2()
  • legacyIce()
  • legacyInkSack()
  • legacyIronAxe()
  • legacyIronBarding()
  • legacyIronBlock()
  • legacyIronBoots()
  • legacyIronChestplate()
  • legacyIronDoor()
  • legacyIronDoorBlock()
  • legacyIronFence()
  • legacyIronHelmet()
  • legacyIronHoe()
  • legacyIronIngot()
  • legacyIronLeggings()
  • legacyIronNugget()
  • legacyIronOre()
  • legacyIronPickaxe()
  • legacyIronPlate()
  • legacyIronSpade()
  • legacyIronSword()
  • legacyIronTrapdoor()
  • legacyItemFrame()
  • legacyJackOLantern()
  • legacyJukebox()
  • legacyJungleDoor()
  • legacyJungleDoorItem()
  • legacyJungleFence()
  • legacyJungleFenceGate()
  • legacyJungleWoodStairs()
  • legacyKnowledgeBook()
  • legacyLadder()
  • legacyLapisBlock()
  • legacyLapisOre()
  • legacyLava()
  • legacyLavaBucket()
  • legacyLeash()
  • legacyLeather()
  • legacyLeatherBoots()
  • legacyLeatherChestplate()
  • legacyLeatherHelmet()
  • legacyLeatherLeggings()
  • legacyLeaves()
  • legacyLeaves2()
  • legacyLever()
  • legacyLightBlueGlazedTerracotta()
  • legacyLightBlueShulkerBox()
  • legacyLimeGlazedTerracotta()
  • legacyLimeShulkerBox()
  • legacyLingeringPotion()
  • legacyLog()
  • legacyLog2()
  • legacyLongGrass()
  • legacyMagentaGlazedTerracotta()
  • legacyMagentaShulkerBox()
  • legacyMagma()
  • legacyMagmaCream()
  • legacyMap()
  • legacyMelon()
  • legacyMelonBlock()
  • legacyMelonSeeds()
  • legacyMelonStem()
  • legacyMilkBucket()
  • legacyMinecart()
  • legacyMobSpawner()
  • legacyMonsterEgg()
  • legacyMonsterEggs()
  • legacyMossyCobblestone()
  • legacyMushroomSoup()
  • legacyMutton()
  • legacyMycel()
  • legacyNameTag()
  • legacyNetherBrick()
  • legacyNetherBrickItem()
  • legacyNetherBrickStairs()
  • legacyNetherFence()
  • legacyNetherStalk()
  • legacyNetherStar()
  • legacyNetherWartBlock()
  • legacyNetherWarts()
  • legacyNetherrack()
  • legacyNoteBlock()
  • legacyObserver()
  • legacyObsidian()
  • legacyOrangeGlazedTerracotta()
  • legacyOrangeShulkerBox()
  • legacyPackedIce()
  • legacyPainting()
  • legacyPaper()
  • legacyPinkGlazedTerracotta()
  • legacyPinkShulkerBox()
  • legacyPistonBase()
  • legacyPistonExtension()
  • legacyPistonMovingPiece()
  • legacyPistonStickyBase()
  • legacyPoisonousPotato()
  • legacyPork()
  • legacyPortal()
  • legacyPotato()
  • legacyPotatoItem()
  • legacyPotion()
  • legacyPoweredMinecart()
  • legacyPoweredRail()
  • legacyPrismarine()
  • legacyPrismarineCrystals()
  • legacyPrismarineShard()
  • legacyPumpkin()
  • legacyPumpkinPie()
  • legacyPumpkinSeeds()
  • legacyPumpkinStem()
  • legacyPurpleGlazedTerracotta()
  • legacyPurpleShulkerBox()
  • legacyPurpurBlock()
  • legacyPurpurDoubleSlab()
  • legacyPurpurPillar()
  • legacyPurpurSlab()
  • legacyPurpurStairs()
  • legacyQuartz()
  • legacyQuartzBlock()
  • legacyQuartzOre()
  • legacyQuartzStairs()
  • legacyRabbit()
  • legacyRabbitFoot()
  • legacyRabbitHide()
  • legacyRabbitStew()
  • legacyRails()
  • legacyRawBeef()
  • legacyRawChicken()
  • legacyRawFish()
  • legacyRecord10()
  • legacyRecord11()
  • legacyRecord12()
  • legacyRecord3()
  • legacyRecord4()
  • legacyRecord5()
  • legacyRecord6()
  • legacyRecord7()
  • legacyRecord8()
  • legacyRecord9()
  • legacyRedGlazedTerracotta()
  • legacyRedMushroom()
  • legacyRedNetherBrick()
  • legacyRedRose()
  • legacyRedSandstone()
  • legacyRedSandstoneStairs()
  • legacyRedShulkerBox()
  • legacyRedstone()
  • legacyRedstoneBlock()
  • legacyRedstoneComparator()
  • legacyRedstoneComparatorOff()
  • legacyRedstoneComparatorOn()
  • legacyRedstoneLampOff()
  • legacyRedstoneLampOn()
  • legacyRedstoneOre()
  • legacyRedstoneTorchOff()
  • legacyRedstoneTorchOn()
  • legacyRedstoneWire()
  • legacyRottenFlesh()
  • legacySaddle()
  • legacySand()
  • legacySandstone()
  • legacySandstoneStairs()
  • legacySapling()
  • legacySeaLantern()
  • legacySeeds()
  • legacyShears()
  • legacyShield()
  • legacyShulkerShell()
  • legacySign()
  • legacySignPost()
  • legacySilverGlazedTerracotta()
  • legacySilverShulkerBox()
  • legacySkull()
  • legacySkullItem()
  • legacySlimeBall()
  • legacySlimeBlock()
  • legacySmoothBrick()
  • legacySmoothStairs()
  • legacySnow()
  • legacySnowBall()
  • legacySnowBlock()
  • legacySoil()
  • legacySoulSand()
  • legacySpeckledMelon()
  • legacySpectralArrow()
  • legacySpiderEye()
  • legacySplashPotion()
  • legacySponge()
  • legacySpruceDoor()
  • legacySpruceDoorItem()
  • legacySpruceFence()
  • legacySpruceFenceGate()
  • legacySpruceWoodStairs()
  • legacyStainedClay()
  • legacyStainedGlass()
  • legacyStainedGlassPane()
  • legacyStandingBanner()
  • legacyStationaryLava()
  • legacyStationaryWater()
  • legacyStep()
  • legacyStick()
  • legacyStone()
  • legacyStoneAxe()
  • legacyStoneButton()
  • legacyStoneHoe()
  • legacyStonePickaxe()
  • legacyStonePlate()
  • legacyStoneSlab2()
  • legacyStoneSpade()
  • legacyStoneSword()
  • legacyStorageMinecart()
  • legacyString()
  • legacyStructureBlock()
  • legacyStructureVoid()
  • legacySugar()
  • legacySugarCane()
  • legacySugarCaneBlock()
  • legacySulphur()
  • legacyThinGlass()
  • legacyTippedArrow()
  • legacyTnt()
  • legacyTorch()
  • legacyTotem()
  • legacyTrapDoor()
  • legacyTrappedChest()
  • legacyTripwire()
  • legacyTripwireHook()
  • legacyVine()
  • legacyWallBanner()
  • legacyWallSign()
  • legacyWatch()
  • legacyWater()
  • legacyWaterBucket()
  • legacyWaterLily()
  • legacyWeb()
  • legacyWheat()
  • legacyWhiteGlazedTerracotta()
  • legacyWhiteShulkerBox()
  • legacyWood()
  • legacyWoodAxe()
  • legacyWoodButton()
  • legacyWoodDoor()
  • legacyWoodDoubleStep()
  • legacyWoodHoe()
  • legacyWoodPickaxe()
  • legacyWoodPlate()
  • legacyWoodSpade()
  • legacyWoodStairs()
  • legacyWoodStep()
  • legacyWoodSword()
  • legacyWoodenDoor()
  • legacyWool()
  • legacyWorkbench()
  • legacyWrittenBook()
  • legacyYellowFlower()
  • legacyYellowGlazedTerracotta()
  • legacyYellowShulkerBox()
  • lever()
  • lightBlueBanner()
  • lightBlueBed()
  • lightBlueCarpet()
  • lightBlueConcrete()
  • lightBlueConcretePowder()
  • lightBlueDye()
  • lightBlueGlazedTerracotta()
  • lightBlueShulkerBox()
  • lightBlueStainedGlass()
  • lightBlueStainedGlassPane()
  • lightBlueTerracotta()
  • lightBlueWallBanner()
  • lightBlueWool()
  • lightGrayBanner()
  • lightGrayBed()
  • lightGrayCarpet()
  • lightGrayConcrete()
  • lightGrayConcretePowder()
  • lightGrayDye()
  • lightGrayGlazedTerracotta()
  • lightGrayShulkerBox()
  • lightGrayStainedGlass()
  • lightGrayStainedGlassPane()
  • lightGrayTerracotta()
  • lightGrayWallBanner()
  • lightGrayWool()
  • lightWeightedPressurePlate()
  • lilac()
  • lilyPad()
  • limeBanner()
  • limeBed()
  • limeCarpet()
  • limeConcrete()
  • limeConcretePowder()
  • limeDye()
  • limeGlazedTerracotta()
  • limeShulkerBox()
  • limeStainedGlass()
  • limeStainedGlassPane()
  • limeTerracotta()
  • limeWallBanner()
  • limeWool()
  • lingeringPotion()
  • llamaSpawnEgg()
  • magentaBanner()
  • magentaBed()
  • magentaCarpet()
  • magentaConcrete()
  • magentaConcretePowder()
  • magentaDye()
  • magentaGlazedTerracotta()
  • magentaShulkerBox()
  • magentaStainedGlass()
  • magentaStainedGlassPane()
  • magentaTerracotta()
  • magentaWallBanner()
  • magentaWool()
  • magmaBlock()
  • magmaCream()
  • magmaCubeSpawnEgg()
  • map()
  • melon()
  • melonSeeds()
  • melonSlice()
  • melonStem()
  • milkBucket()
  • minecart()
  • mooshroomSpawnEgg()
  • mossyCobblestone()
  • mossyCobblestoneWall()
  • mossyStoneBricks()
  • movingPiston()
  • muleSpawnEgg()
  • mushroomStem()
  • mushroomStew()
  • musicDisc11()
  • musicDisc13()
  • musicDiscBlocks()
  • musicDiscCat()
  • musicDiscChirp()
  • musicDiscFar()
  • musicDiscMall()
  • musicDiscMellohi()
  • musicDiscStal()
  • musicDiscStrad()
  • musicDiscWait()
  • musicDiscWard()
  • mutton()
  • mycelium()
  • nameTag()
  • nautilusShell()
  • netherBrick()
  • netherBrickFence()
  • netherBrickSlab()
  • netherBrickStairs()
  • netherBricks()
  • netherPortal()
  • netherQuartzOre()
  • netherStar()
  • netherWart()
  • netherWartBlock()
  • netherrack()
  • noteBlock()
  • oakBoat()
  • oakButton()
  • oakDoor()
  • oakFence()
  • oakFenceGate()
  • oakLeaves()
  • oakLog()
  • oakPlanks()
  • oakPressurePlate()
  • oakSapling()
  • oakSlab()
  • oakStairs()
  • oakTrapdoor()
  • oakWood()
  • observer()
  • obsidian()
  • ocelotSpawnEgg()
  • orangeBanner()
  • orangeBed()
  • orangeCarpet()
  • orangeConcrete()
  • orangeConcretePowder()
  • orangeDye()
  • orangeGlazedTerracotta()
  • orangeShulkerBox()
  • orangeStainedGlass()
  • orangeStainedGlassPane()
  • orangeTerracotta()
  • orangeTulip()
  • orangeWallBanner()
  • orangeWool()
  • oxeyeDaisy()
  • packedIce()
  • painting()
  • paper()
  • parrotSpawnEgg()
  • peony()
  • petrifiedOakSlab()
  • phantomMembrane()
  • phantomSpawnEgg()
  • pigSpawnEgg()
  • pinkBanner()
  • pinkBed()
  • pinkCarpet()
  • pinkConcrete()
  • pinkConcretePowder()
  • pinkDye()
  • pinkGlazedTerracotta()
  • pinkShulkerBox()
  • pinkStainedGlass()
  • pinkStainedGlassPane()
  • pinkTerracotta()
  • pinkTulip()
  • pinkWallBanner()
  • pinkWool()
  • piston()
  • pistonHead()
  • playerHead()
  • playerWallHead()
  • podzol()
  • poisonousPotato()
  • polarBearSpawnEgg()
  • polishedAndesite()
  • polishedDiorite()
  • polishedGranite()
  • poppedChorusFruit()
  • poppy()
  • porkchop()
  • potato()
  • potatoes()
  • potion()
  • pottedAcaciaSapling()
  • pottedAllium()
  • pottedAzureBluet()
  • pottedBirchSapling()
  • pottedBlueOrchid()
  • pottedBrownMushroom()
  • pottedCactus()
  • pottedDandelion()
  • pottedDarkOakSapling()
  • pottedDeadBush()
  • pottedFern()
  • pottedJungleSapling()
  • pottedOakSapling()
  • pottedOrangeTulip()
  • pottedOxeyeDaisy()
  • pottedPinkTulip()
  • pottedPoppy()
  • pottedRedMushroom()
  • pottedRedTulip()
  • pottedSpruceSapling()
  • pottedWhiteTulip()
  • poweredRail()
  • prismarine()
  • prismarineBrickSlab()
  • prismarineBrickStairs()
  • prismarineBricks()
  • prismarineCrystals()
  • prismarineShard()
  • prismarineSlab()
  • prismarineStairs()
  • pufferfish()
  • pufferfishBucket()
  • pufferfishSpawnEgg()
  • pumpkin()
  • pumpkinPie()
  • pumpkinSeeds()
  • pumpkinStem()
  • purpleBanner()
  • purpleBed()
  • purpleCarpet()
  • purpleConcrete()
  • purpleConcretePowder()
  • purpleDye()
  • purpleGlazedTerracotta()
  • purpleShulkerBox()
  • purpleStainedGlass()
  • purpleStainedGlassPane()
  • purpleTerracotta()
  • purpleWallBanner()
  • purpleWool()
  • purpurBlock()
  • purpurPillar()
  • purpurSlab()
  • purpurStairs()
  • quartz()
  • quartzBlock()
  • quartzPillar()
  • quartzSlab()
  • quartzStairs()
  • rabbit()
  • rabbitFoot()
  • rabbitHide()
  • rabbitSpawnEgg()
  • rabbitStew()
  • rail()
  • redBanner()
  • redBed()
  • redCarpet()
  • redConcrete()
  • redConcretePowder()
  • redGlazedTerracotta()
  • redMushroom()
  • redMushroomBlock()
  • redNetherBricks()
  • redSand()
  • redSandstone()
  • redSandstoneSlab()
  • redSandstoneStairs()
  • redShulkerBox()
  • redStainedGlass()
  • redStainedGlassPane()
  • redTerracotta()
  • redTulip()
  • redWallBanner()
  • redWool()
  • redstone()
  • redstoneBlock()
  • redstoneLamp()
  • redstoneOre()
  • redstoneTorch()
  • redstoneWallTorch()
  • redstoneWire()
  • repeater()
  • repeatingCommandBlock()
  • roseBush()
  • roseRed()
  • rottenFlesh()
  • saddle()
  • salmon()
  • salmonBucket()
  • salmonSpawnEgg()
  • sand()
  • sandstone()
  • sandstoneSlab()
  • sandstoneStairs()
  • scute()
  • seaLantern()
  • seaPickle()
  • seagrass()
  • shears()
  • sheepSpawnEgg()
  • shield()
  • shulkerBox()
  • shulkerShell()
  • shulkerSpawnEgg()
  • sign()
  • silverfishSpawnEgg()
  • skeletonHorseSpawnEgg()
  • skeletonSkull()
  • skeletonSpawnEgg()
  • skeletonWallSkull()
  • slimeBall()
  • slimeBlock()
  • slimeSpawnEgg()
  • smoothQuartz()
  • smoothRedSandstone()
  • smoothSandstone()
  • smoothStone()
  • snow()
  • snowBlock()
  • snowball()
  • soulSand()
  • spawner()
  • spectralArrow()
  • spiderEye()
  • spiderSpawnEgg()
  • splashPotion()
  • sponge()
  • spruceBoat()
  • spruceButton()
  • spruceDoor()
  • spruceFence()
  • spruceFenceGate()
  • spruceLeaves()
  • spruceLog()
  • sprucePlanks()
  • sprucePressurePlate()
  • spruceSapling()
  • spruceSlab()
  • spruceStairs()
  • spruceTrapdoor()
  • spruceWood()
  • squidSpawnEgg()
  • stick()
  • stickyPiston()
  • stone()
  • stoneAxe()
  • stoneBrickSlab()
  • stoneBrickStairs()
  • stoneBricks()
  • stoneButton()
  • stoneHoe()
  • stonePickaxe()
  • stonePressurePlate()
  • stoneShovel()
  • stoneSlab()
  • stoneSword()
  • straySpawnEgg()
  • string()
  • strippedAcaciaLog()
  • strippedAcaciaWood()
  • strippedBirchLog()
  • strippedBirchWood()
  • strippedDarkOakLog()
  • strippedDarkOakWood()
  • strippedJungleLog()
  • strippedJungleWood()
  • strippedOakLog()
  • strippedOakWood()
  • strippedSpruceLog()
  • strippedSpruceWood()
  • structureBlock()
  • structureVoid()
  • sugar()
  • sugarCane()
  • sunflower()
  • tallGrass()
  • tallSeagrass()
  • terracotta()
  • tippedArrow()
  • tnt()
  • tntMinecart()
  • torch()
  • totemOfUndying()
  • trappedChest()
  • trident()
  • tripwire()
  • tripwireHook()
  • tropicalFish()
  • tropicalFishBucket()
  • tropicalFishSpawnEgg()
  • tubeCoral()
  • tubeCoralBlock()
  • tubeCoralFan()
  • tubeCoralWallFan()
  • turtleEgg()
  • turtleHelmet()
  • turtleSpawnEgg()
  • vexSpawnEgg()
  • villagerSpawnEgg()
  • vindicatorSpawnEgg()
  • vine()
  • voidAir()
  • wallSign()
  • wallTorch()
  • water()
  • waterBucket()
  • wetSponge()
  • wheat()
  • wheatSeeds()
  • whiteBanner()
  • whiteBed()
  • whiteCarpet()
  • whiteConcrete()
  • whiteConcretePowder()
  • whiteGlazedTerracotta()
  • whiteShulkerBox()
  • whiteStainedGlass()
  • whiteStainedGlassPane()
  • whiteTerracotta()
  • whiteTulip()
  • whiteWallBanner()
  • whiteWool()
  • witchSpawnEgg()
  • witherSkeletonSkull()
  • witherSkeletonSpawnEgg()
  • witherSkeletonWallSkull()
  • wolfSpawnEgg()
  • woodenAxe()
  • woodenHoe()
  • woodenPickaxe()
  • woodenShovel()
  • woodenSword()
  • writableBook()
  • writtenBook()
  • yellowBanner()
  • yellowBed()
  • yellowCarpet()
  • yellowConcrete()
  • yellowConcretePowder()
  • yellowGlazedTerracotta()
  • yellowShulkerBox()
  • yellowStainedGlass()
  • yellowStainedGlassPane()
  • yellowTerracotta()
  • yellowWallBanner()
  • yellowWool()
  • zombieHead()
  • zombieHorseSpawnEgg()
  • zombiePigmanSpawnEgg()
  • zombieSpawnEgg()
  • zombieVillagerSpawnEgg()
  • zombieWallHead()

Sounds module (SpigotMC version)

This module provides a simple way to play sounds.

Usage

var sounds = require("sounds");
// plays ENTITY_WOLF_HOWL sound at full volume and medium pitch
sounds.play( org.bukkit.Sound.ENTITY_WOLF_HOWL, self, 1, 0); 
// same as previous statement
sounds.play( org.bukkit.Sound.ENTITY_WOLF_HOWL , self );

The play() function takes as parameters:

In addition, the Sounds module provides a suite of helper functions - one for each possible sound.

var sounds = require("sounds");
// same as previous examples
sounds.entityWolfHowl( self );

Each of the following functions takes as parameters:

  • A Location orbject or any object which has a location
  • The Volume parameter is in the range 0 to 1 (default: 1)
  • The Pitch parameter is in the range 0 to 4 (default: 0)

The following functions are provided for convenience and to help beginners explore sounds using TAB completion:

  • ambientCave()
  • ambientUnderwaterEnter()
  • ambientUnderwaterExit()
  • ambientUnderwaterLoop()
  • ambientUnderwaterLoopAdditions()
  • ambientUnderwaterLoopAdditionsRare()
  • ambientUnderwaterLoopAdditionsUltraRare()
  • blockAnvilBreak()
  • blockAnvilDestroy()
  • blockAnvilFall()
  • blockAnvilHit()
  • blockAnvilLand()
  • blockAnvilPlace()
  • blockAnvilStep()
  • blockAnvilUse()
  • blockBeaconActivate()
  • blockBeaconAmbient()
  • blockBeaconDeactivate()
  • blockBeaconPowerSelect()
  • blockBrewingStandBrew()
  • blockBubbleColumnBubblePop()
  • blockBubbleColumnUpwardsAmbient()
  • blockBubbleColumnUpwardsInside()
  • blockBubbleColumnWhirlpoolAmbient()
  • blockBubbleColumnWhirlpoolInside()
  • blockChestClose()
  • blockChestLocked()
  • blockChestOpen()
  • blockChorusFlowerDeath()
  • blockChorusFlowerGrow()
  • blockComparatorClick()
  • blockConduitActivate()
  • blockConduitAmbient()
  • blockConduitAmbientShort()
  • blockConduitAttackTarget()
  • blockConduitDeactivate()
  • blockCoralBlockBreak()
  • blockCoralBlockFall()
  • blockCoralBlockHit()
  • blockCoralBlockPlace()
  • blockCoralBlockStep()
  • blockDispenserDispense()
  • blockDispenserFail()
  • blockDispenserLaunch()
  • blockEnchantmentTableUse()
  • blockEndGatewaySpawn()
  • blockEndPortalFrameFill()
  • blockEndPortalSpawn()
  • blockEnderChestClose()
  • blockEnderChestOpen()
  • blockFenceGateClose()
  • blockFenceGateOpen()
  • blockFireAmbient()
  • blockFireExtinguish()
  • blockFurnaceFireCrackle()
  • blockGlassBreak()
  • blockGlassFall()
  • blockGlassHit()
  • blockGlassPlace()
  • blockGlassStep()
  • blockGrassBreak()
  • blockGrassFall()
  • blockGrassHit()
  • blockGrassPlace()
  • blockGrassStep()
  • blockGravelBreak()
  • blockGravelFall()
  • blockGravelHit()
  • blockGravelPlace()
  • blockGravelStep()
  • blockIronDoorClose()
  • blockIronDoorOpen()
  • blockIronTrapdoorClose()
  • blockIronTrapdoorOpen()
  • blockLadderBreak()
  • blockLadderFall()
  • blockLadderHit()
  • blockLadderPlace()
  • blockLadderStep()
  • blockLavaAmbient()
  • blockLavaExtinguish()
  • blockLavaPop()
  • blockLeverClick()
  • blockLilyPadPlace()
  • blockMetalBreak()
  • blockMetalFall()
  • blockMetalHit()
  • blockMetalPlace()
  • blockMetalPressurePlateClickOff()
  • blockMetalPressurePlateClickOn()
  • blockMetalStep()
  • blockNoteBlockBasedrum()
  • blockNoteBlockBass()
  • blockNoteBlockBell()
  • blockNoteBlockChime()
  • blockNoteBlockFlute()
  • blockNoteBlockGuitar()
  • blockNoteBlockHarp()
  • blockNoteBlockHat()
  • blockNoteBlockPling()
  • blockNoteBlockSnare()
  • blockNoteBlockXylophone()
  • blockPistonContract()
  • blockPistonExtend()
  • blockPortalAmbient()
  • blockPortalTravel()
  • blockPortalTrigger()
  • blockPumpkinCarve()
  • blockRedstoneTorchBurnout()
  • blockSandBreak()
  • blockSandFall()
  • blockSandHit()
  • blockSandPlace()
  • blockSandStep()
  • blockShulkerBoxClose()
  • blockShulkerBoxOpen()
  • blockSlimeBlockBreak()
  • blockSlimeBlockFall()
  • blockSlimeBlockHit()
  • blockSlimeBlockPlace()
  • blockSlimeBlockStep()
  • blockSnowBreak()
  • blockSnowFall()
  • blockSnowHit()
  • blockSnowPlace()
  • blockSnowStep()
  • blockStoneBreak()
  • blockStoneButtonClickOff()
  • blockStoneButtonClickOn()
  • blockStoneFall()
  • blockStoneHit()
  • blockStonePlace()
  • blockStonePressurePlateClickOff()
  • blockStonePressurePlateClickOn()
  • blockStoneStep()
  • blockTripwireAttach()
  • blockTripwireClickOff()
  • blockTripwireClickOn()
  • blockTripwireDetach()
  • blockWaterAmbient()
  • blockWetGrassBreak()
  • blockWetGrassFall()
  • blockWetGrassHit()
  • blockWetGrassPlace()
  • blockWetGrassStep()
  • blockWoodBreak()
  • blockWoodFall()
  • blockWoodHit()
  • blockWoodPlace()
  • blockWoodStep()
  • blockWoodenButtonClickOff()
  • blockWoodenButtonClickOn()
  • blockWoodenDoorClose()
  • blockWoodenDoorOpen()
  • blockWoodenPressurePlateClickOff()
  • blockWoodenPressurePlateClickOn()
  • blockWoodenTrapdoorClose()
  • blockWoodenTrapdoorOpen()
  • blockWoolBreak()
  • blockWoolFall()
  • blockWoolHit()
  • blockWoolPlace()
  • blockWoolStep()
  • enchantThornsHit()
  • entityArmorStandBreak()
  • entityArmorStandFall()
  • entityArmorStandHit()
  • entityArmorStandPlace()
  • entityArrowHit()
  • entityArrowHitPlayer()
  • entityArrowShoot()
  • entityBatAmbient()
  • entityBatDeath()
  • entityBatHurt()
  • entityBatLoop()
  • entityBatTakeoff()
  • entityBlazeAmbient()
  • entityBlazeBurn()
  • entityBlazeDeath()
  • entityBlazeHurt()
  • entityBlazeShoot()
  • entityBoatPaddleLand()
  • entityBoatPaddleWater()
  • entityCatAmbient()
  • entityCatDeath()
  • entityCatHiss()
  • entityCatHurt()
  • entityCatPurr()
  • entityCatPurreow()
  • entityChickenAmbient()
  • entityChickenDeath()
  • entityChickenEgg()
  • entityChickenHurt()
  • entityChickenStep()
  • entityCodAmbient()
  • entityCodDeath()
  • entityCodFlop()
  • entityCodHurt()
  • entityCowAmbient()
  • entityCowDeath()
  • entityCowHurt()
  • entityCowMilk()
  • entityCowStep()
  • entityCreeperDeath()
  • entityCreeperHurt()
  • entityCreeperPrimed()
  • entityDolphinAmbient()
  • entityDolphinAmbientWater()
  • entityDolphinAttack()
  • entityDolphinDeath()
  • entityDolphinEat()
  • entityDolphinHurt()
  • entityDolphinJump()
  • entityDolphinPlay()
  • entityDolphinSplash()
  • entityDolphinSwim()
  • entityDonkeyAmbient()
  • entityDonkeyAngry()
  • entityDonkeyChest()
  • entityDonkeyDeath()
  • entityDonkeyHurt()
  • entityDragonFireballExplode()
  • entityDrownedAmbient()
  • entityDrownedAmbientWater()
  • entityDrownedDeath()
  • entityDrownedDeathWater()
  • entityDrownedHurt()
  • entityDrownedHurtWater()
  • entityDrownedShoot()
  • entityDrownedStep()
  • entityDrownedSwim()
  • entityEggThrow()
  • entityElderGuardianAmbient()
  • entityElderGuardianAmbientLand()
  • entityElderGuardianCurse()
  • entityElderGuardianDeath()
  • entityElderGuardianDeathLand()
  • entityElderGuardianFlop()
  • entityElderGuardianHurt()
  • entityElderGuardianHurtLand()
  • entityEnderDragonAmbient()
  • entityEnderDragonDeath()
  • entityEnderDragonFlap()
  • entityEnderDragonGrowl()
  • entityEnderDragonHurt()
  • entityEnderDragonShoot()
  • entityEnderEyeDeath()
  • entityEnderEyeLaunch()
  • entityEnderPearlThrow()
  • entityEndermanAmbient()
  • entityEndermanDeath()
  • entityEndermanHurt()
  • entityEndermanScream()
  • entityEndermanStare()
  • entityEndermanTeleport()
  • entityEndermiteAmbient()
  • entityEndermiteDeath()
  • entityEndermiteHurt()
  • entityEndermiteStep()
  • entityEvokerAmbient()
  • entityEvokerCastSpell()
  • entityEvokerDeath()
  • entityEvokerFangsAttack()
  • entityEvokerHurt()
  • entityEvokerPrepareAttack()
  • entityEvokerPrepareSummon()
  • entityEvokerPrepareWololo()
  • entityExperienceBottleThrow()
  • entityExperienceOrbPickup()
  • entityFireworkRocketBlast()
  • entityFireworkRocketBlastFar()
  • entityFireworkRocketLargeBlast()
  • entityFireworkRocketLargeBlastFar()
  • entityFireworkRocketLaunch()
  • entityFireworkRocketShoot()
  • entityFireworkRocketTwinkle()
  • entityFireworkRocketTwinkleFar()
  • entityFishSwim()
  • entityFishingBobberRetrieve()
  • entityFishingBobberSplash()
  • entityFishingBobberThrow()
  • entityGenericBigFall()
  • entityGenericBurn()
  • entityGenericDeath()
  • entityGenericDrink()
  • entityGenericEat()
  • entityGenericExplode()
  • entityGenericExtinguishFire()
  • entityGenericHurt()
  • entityGenericSmallFall()
  • entityGenericSplash()
  • entityGenericSwim()
  • entityGhastAmbient()
  • entityGhastDeath()
  • entityGhastHurt()
  • entityGhastScream()
  • entityGhastShoot()
  • entityGhastWarn()
  • entityGuardianAmbient()
  • entityGuardianAmbientLand()
  • entityGuardianAttack()
  • entityGuardianDeath()
  • entityGuardianDeathLand()
  • entityGuardianFlop()
  • entityGuardianHurt()
  • entityGuardianHurtLand()
  • entityHorseAmbient()
  • entityHorseAngry()
  • entityHorseArmor()
  • entityHorseBreathe()
  • entityHorseDeath()
  • entityHorseEat()
  • entityHorseGallop()
  • entityHorseHurt()
  • entityHorseJump()
  • entityHorseLand()
  • entityHorseSaddle()
  • entityHorseStep()
  • entityHorseStepWood()
  • entityHostileBigFall()
  • entityHostileDeath()
  • entityHostileHurt()
  • entityHostileSmallFall()
  • entityHostileSplash()
  • entityHostileSwim()
  • entityHuskAmbient()
  • entityHuskConvertedToZombie()
  • entityHuskDeath()
  • entityHuskHurt()
  • entityHuskStep()
  • entityIllusionerAmbient()
  • entityIllusionerCastSpell()
  • entityIllusionerDeath()
  • entityIllusionerHurt()
  • entityIllusionerMirrorMove()
  • entityIllusionerPrepareBlindness()
  • entityIllusionerPrepareMirror()
  • entityIronGolemAttack()
  • entityIronGolemDeath()
  • entityIronGolemHurt()
  • entityIronGolemStep()
  • entityItemBreak()
  • entityItemFrameAddItem()
  • entityItemFrameBreak()
  • entityItemFramePlace()
  • entityItemFrameRemoveItem()
  • entityItemFrameRotateItem()
  • entityItemPickup()
  • entityLeashKnotBreak()
  • entityLeashKnotPlace()
  • entityLightningBoltImpact()
  • entityLightningBoltThunder()
  • entityLingeringPotionThrow()
  • entityLlamaAmbient()
  • entityLlamaAngry()
  • entityLlamaChest()
  • entityLlamaDeath()
  • entityLlamaEat()
  • entityLlamaHurt()
  • entityLlamaSpit()
  • entityLlamaStep()
  • entityLlamaSwag()
  • entityMagmaCubeDeath()
  • entityMagmaCubeDeathSmall()
  • entityMagmaCubeHurt()
  • entityMagmaCubeHurtSmall()
  • entityMagmaCubeJump()
  • entityMagmaCubeSquish()
  • entityMagmaCubeSquishSmall()
  • entityMinecartInside()
  • entityMinecartRiding()
  • entityMooshroomShear()
  • entityMuleAmbient()
  • entityMuleChest()
  • entityMuleDeath()
  • entityMuleHurt()
  • entityPaintingBreak()
  • entityPaintingPlace()
  • entityParrotAmbient()
  • entityParrotDeath()
  • entityParrotEat()
  • entityParrotFly()
  • entityParrotHurt()
  • entityParrotImitateBlaze()
  • entityParrotImitateCreeper()
  • entityParrotImitateDrowned()
  • entityParrotImitateElderGuardian()
  • entityParrotImitateEnderDragon()
  • entityParrotImitateEnderman()
  • entityParrotImitateEndermite()
  • entityParrotImitateEvoker()
  • entityParrotImitateGhast()
  • entityParrotImitateHusk()
  • entityParrotImitateIllusioner()
  • entityParrotImitateMagmaCube()
  • entityParrotImitatePhantom()
  • entityParrotImitatePolarBear()
  • entityParrotImitateShulker()
  • entityParrotImitateSilverfish()
  • entityParrotImitateSkeleton()
  • entityParrotImitateSlime()
  • entityParrotImitateSpider()
  • entityParrotImitateStray()
  • entityParrotImitateVex()
  • entityParrotImitateVindicator()
  • entityParrotImitateWitch()
  • entityParrotImitateWither()
  • entityParrotImitateWitherSkeleton()
  • entityParrotImitateWolf()
  • entityParrotImitateZombie()
  • entityParrotImitateZombiePigman()
  • entityParrotImitateZombieVillager()
  • entityParrotStep()
  • entityPhantomAmbient()
  • entityPhantomBite()
  • entityPhantomDeath()
  • entityPhantomFlap()
  • entityPhantomHurt()
  • entityPhantomSwoop()
  • entityPigAmbient()
  • entityPigDeath()
  • entityPigHurt()
  • entityPigSaddle()
  • entityPigStep()
  • entityPlayerAttackCrit()
  • entityPlayerAttackKnockback()
  • entityPlayerAttackNodamage()
  • entityPlayerAttackStrong()
  • entityPlayerAttackSweep()
  • entityPlayerAttackWeak()
  • entityPlayerBigFall()
  • entityPlayerBreath()
  • entityPlayerBurp()
  • entityPlayerDeath()
  • entityPlayerHurt()
  • entityPlayerHurtDrown()
  • entityPlayerHurtOnFire()
  • entityPlayerLevelup()
  • entityPlayerSmallFall()
  • entityPlayerSplash()
  • entityPlayerSplashHighSpeed()
  • entityPlayerSwim()
  • entityPolarBearAmbient()
  • entityPolarBearAmbientBaby()
  • entityPolarBearDeath()
  • entityPolarBearHurt()
  • entityPolarBearStep()
  • entityPolarBearWarning()
  • entityPufferFishAmbient()
  • entityPufferFishBlowOut()
  • entityPufferFishBlowUp()
  • entityPufferFishDeath()
  • entityPufferFishFlop()
  • entityPufferFishHurt()
  • entityPufferFishSting()
  • entityRabbitAmbient()
  • entityRabbitAttack()
  • entityRabbitDeath()
  • entityRabbitHurt()
  • entityRabbitJump()
  • entitySalmonAmbient()
  • entitySalmonDeath()
  • entitySalmonFlop()
  • entitySalmonHurt()
  • entitySheepAmbient()
  • entitySheepDeath()
  • entitySheepHurt()
  • entitySheepShear()
  • entitySheepStep()
  • entityShulkerAmbient()
  • entityShulkerBulletHit()
  • entityShulkerBulletHurt()
  • entityShulkerClose()
  • entityShulkerDeath()
  • entityShulkerHurt()
  • entityShulkerHurtClosed()
  • entityShulkerOpen()
  • entityShulkerShoot()
  • entityShulkerTeleport()
  • entitySilverfishAmbient()
  • entitySilverfishDeath()
  • entitySilverfishHurt()
  • entitySilverfishStep()
  • entitySkeletonAmbient()
  • entitySkeletonDeath()
  • entitySkeletonHorseAmbient()
  • entitySkeletonHorseAmbientWater()
  • entitySkeletonHorseDeath()
  • entitySkeletonHorseGallopWater()
  • entitySkeletonHorseHurt()
  • entitySkeletonHorseJumpWater()
  • entitySkeletonHorseStepWater()
  • entitySkeletonHorseSwim()
  • entitySkeletonHurt()
  • entitySkeletonShoot()
  • entitySkeletonStep()
  • entitySlimeAttack()
  • entitySlimeDeath()
  • entitySlimeDeathSmall()
  • entitySlimeHurt()
  • entitySlimeHurtSmall()
  • entitySlimeJump()
  • entitySlimeJumpSmall()
  • entitySlimeSquish()
  • entitySlimeSquishSmall()
  • entitySnowGolemAmbient()
  • entitySnowGolemDeath()
  • entitySnowGolemHurt()
  • entitySnowGolemShoot()
  • entitySnowballThrow()
  • entitySpiderAmbient()
  • entitySpiderDeath()
  • entitySpiderHurt()
  • entitySpiderStep()
  • entitySplashPotionBreak()
  • entitySplashPotionThrow()
  • entitySquidAmbient()
  • entitySquidDeath()
  • entitySquidHurt()
  • entitySquidSquirt()
  • entityStrayAmbient()
  • entityStrayDeath()
  • entityStrayHurt()
  • entityStrayStep()
  • entityTntPrimed()
  • entityTropicalFishAmbient()
  • entityTropicalFishDeath()
  • entityTropicalFishFlop()
  • entityTropicalFishHurt()
  • entityTurtleAmbientLand()
  • entityTurtleDeath()
  • entityTurtleDeathBaby()
  • entityTurtleEggBreak()
  • entityTurtleEggCrack()
  • entityTurtleEggHatch()
  • entityTurtleHurt()
  • entityTurtleHurtBaby()
  • entityTurtleLayEgg()
  • entityTurtleShamble()
  • entityTurtleShambleBaby()
  • entityTurtleSwim()
  • entityVexAmbient()
  • entityVexCharge()
  • entityVexDeath()
  • entityVexHurt()
  • entityVillagerAmbient()
  • entityVillagerDeath()
  • entityVillagerHurt()
  • entityVillagerNo()
  • entityVillagerTrade()
  • entityVillagerYes()
  • entityVindicatorAmbient()
  • entityVindicatorDeath()
  • entityVindicatorHurt()
  • entityWitchAmbient()
  • entityWitchDeath()
  • entityWitchDrink()
  • entityWitchHurt()
  • entityWitchThrow()
  • entityWitherAmbient()
  • entityWitherBreakBlock()
  • entityWitherDeath()
  • entityWitherHurt()
  • entityWitherShoot()
  • entityWitherSkeletonAmbient()
  • entityWitherSkeletonDeath()
  • entityWitherSkeletonHurt()
  • entityWitherSkeletonStep()
  • entityWitherSpawn()
  • entityWolfAmbient()
  • entityWolfDeath()
  • entityWolfGrowl()
  • entityWolfHowl()
  • entityWolfHurt()
  • entityWolfPant()
  • entityWolfShake()
  • entityWolfStep()
  • entityWolfWhine()
  • entityZombieAmbient()
  • entityZombieAttackIronDoor()
  • entityZombieAttackWoodenDoor()
  • entityZombieBreakWoodenDoor()
  • entityZombieConvertedToDrowned()
  • entityZombieDeath()
  • entityZombieDestroyEgg()
  • entityZombieHorseAmbient()
  • entityZombieHorseDeath()
  • entityZombieHorseHurt()
  • entityZombieHurt()
  • entityZombieInfect()
  • entityZombiePigmanAmbient()
  • entityZombiePigmanAngry()
  • entityZombiePigmanDeath()
  • entityZombiePigmanHurt()
  • entityZombieStep()
  • entityZombieVillagerAmbient()
  • entityZombieVillagerConverted()
  • entityZombieVillagerCure()
  • entityZombieVillagerDeath()
  • entityZombieVillagerHurt()
  • entityZombieVillagerStep()
  • itemArmorEquipChain()
  • itemArmorEquipDiamond()
  • itemArmorEquipElytra()
  • itemArmorEquipGeneric()
  • itemArmorEquipGold()
  • itemArmorEquipIron()
  • itemArmorEquipLeather()
  • itemArmorEquipTurtle()
  • itemAxeStrip()
  • itemBottleEmpty()
  • itemBottleFill()
  • itemBottleFillDragonbreath()
  • itemBucketEmpty()
  • itemBucketEmptyFish()
  • itemBucketEmptyLava()
  • itemBucketFill()
  • itemBucketFillFish()
  • itemBucketFillLava()
  • itemChorusFruitTeleport()
  • itemElytraFlying()
  • itemFirechargeUse()
  • itemFlintandsteelUse()
  • itemHoeTill()
  • itemShieldBlock()
  • itemShieldBreak()
  • itemShovelFlatten()
  • itemTotemUse()
  • itemTridentHit()
  • itemTridentHitGround()
  • itemTridentReturn()
  • itemTridentRiptide1()
  • itemTridentRiptide2()
  • itemTridentRiptide3()
  • itemTridentThrow()
  • itemTridentThunder()
  • musicCreative()
  • musicCredits()
  • musicDisc11()
  • musicDisc13()
  • musicDiscBlocks()
  • musicDiscCat()
  • musicDiscChirp()
  • musicDiscFar()
  • musicDiscMall()
  • musicDiscMellohi()
  • musicDiscStal()
  • musicDiscStrad()
  • musicDiscWait()
  • musicDiscWard()
  • musicDragon()
  • musicEnd()
  • musicGame()
  • musicMenu()
  • musicNether()
  • musicUnderWater()
  • uiButtonClick()
  • uiToastChallengeComplete()
  • uiToastIn()
  • uiToastOut()
  • weatherRain()
  • weatherRainAbove()

Entities module

The Entities module provides a suite of functions - one for each possible entity type. It acts as a helper or enumerated module to assist in use with the spawn module and command. This module is useful for TAB-completion at the in-game prompt.

When each function is called with no parameters, it will return the appropriate EntityType object. For example entities.polar_bear() will return an EntityType.POLAR_BEAR object.

When each function is called with a single parameter - an entity - the entity's type will be compared and return true or false.

Usage

entities.zombie(); // returns a SpigotMC/CanaryMod EntityType.ZOMBIE enum value
entities.zombie( mob ); // compares the entity's type to a zombie, returns true if mob type is zombie, false otherwise
entities.player( self ); // at the in-game prompt this should return true (compares self to a player entity type)
entities.rabbit( self ); // at the in-game prompt this should return false (compares self to a rabbit entity type)

The following functions are provided:

  • area_effect_cloud()
  • armor_stand()
  • arrow()
  • bat()
  • blaze()
  • boat()
  • cave_spider()
  • chicken()
  • cod()
  • complex_part()
  • cow()
  • creeper()
  • dolphin()
  • donkey()
  • dragon_fireball()
  • dropped_item()
  • drowned()
  • egg()
  • elder_guardian()
  • ender_crystal()
  • ender_dragon()
  • ender_pearl()
  • ender_signal()
  • enderman()
  • endermite()
  • evoker()
  • evoker_fangs()
  • experience_orb()
  • falling_block()
  • fireball()
  • firework()
  • fishing_hook()
  • ghast()
  • giant()
  • guardian()
  • horse()
  • husk()
  • illusioner()
  • iron_golem()
  • item_frame()
  • leash_hitch()
  • lightning()
  • lingering_potion()
  • llama()
  • llama_spit()
  • magma_cube()
  • minecart()
  • minecart_chest()
  • minecart_command()
  • minecart_furnace()
  • minecart_hopper()
  • minecart_mob_spawner()
  • minecart_tnt()
  • mule()
  • mushroom_cow()
  • ocelot()
  • painting()
  • parrot()
  • phantom()
  • pig()
  • pig_zombie()
  • player()
  • polar_bear()
  • primed_tnt()
  • pufferfish()
  • rabbit()
  • salmon()
  • sheep()
  • shulker()
  • shulker_bullet()
  • silverfish()
  • skeleton()
  • skeleton_horse()
  • slime()
  • small_fireball()
  • snowball()
  • snowman()
  • spectral_arrow()
  • spider()
  • splash_potion()
  • squid()
  • stray()
  • thrown_exp_bottle()
  • tipped_arrow()
  • trident()
  • tropical_fish()
  • turtle()
  • unknown()
  • vex()
  • villager()
  • vindicator()
  • weather()
  • witch()
  • wither()
  • wither_skeleton()
  • wither_skull()
  • wolf()
  • zombie()
  • zombie_horse()
  • zombie_villager()