Custom Items

#in myCustomItem.yml:
name: "My Custom Item"

item:
      material: LEATHER_CHESTPLATE
      displayName: "&6My Custom Item"
      lore:
          - "This is line one"
          - "This is line two"
          - "&lThis&7 line is &cformatted"
    itemDamage: 24
    enchantments:
        #Add the enchantments Thorns 2
        "minecraft:THORNS": 2
    color: "00AAFF"
    # making color from RGB values
    color:
        red: 10
        green: 127
        blue: 255

info:
      description: "This is an awesome custom item I made"
      usage: "You don't need to use this custom item. Just look at it in awe"
      relatedItems:
          - "minecraft:STICK"
          - "minecraft:DIAMOND"

  recipes

item:
  enchantments:
    # Unbreaking 3
    "minecraft:DURABILITY": 3
    # Thorns 2
    "minecraft:THORNS": 2

-
  action: playerAddEffects
  effects:
  # Night Vision Potion lasting 40 seconds
    -
      type: "NIGHT_VISION"
      time: 40

block:
  drops:
    "minecraft:DIAMOND": 4
    "myCustomItemID": 1

block:
  generation:
    -
      method: ore
      worlds:
        - world
      continueChance: 0.4
      generationChance: 1.0
      amountPerChunk: 5
      minY: 20

• method — string — The method of generating the blocks. Currently valid options are: "ore" and "replace"
• world(s) — string or string list — The world(s) to enable generation in.
• biome(s) — string or string list — The biome(s) to enable generation in.
• amountPerChunk — integer — The number of times to run this generation method per chunk
• generationChance — decimal between 0.0 and 1.0 — The chance of the generation method to run (for example, 0.7 gives this generation method a 70% chance of running each time)
• minY — integer— The minimum y-position to start generating blocks at
• maxY — integer— The maximum y-position to start generating blocks at
• continueChance — decimal between 0.0 and 1.0 only for the "ore" generation method — the chance of the ore generation continuing to generate more blocks in the vein

• rightClickAir When a player right-clicks air with this item
• rightClickBlock When a player right-clicks a block with this item
• leftClickAir When a player hits air with this item
• leftClickBlock When a player hits a block with this item
• drop When a player drops this item
• itemPickup When a player picks up this item
• itemBreak When this item breaks after after used
• itemDamage When this item is damaged by being used
• hitMob When a player hits a mob with this item
• hitPlayer When a player hits a player with this item
• mine When a player mines a block with this item
• projectileShoot When a player shoots this projectile
• projectileHitMob When this projectile hits a mob
• projectileHitPlayer When this projectile hits a player
• projectileHitBlock When this projectile hits a block
• consume When a player eats this item
• bowShoot When this bow is shot
• blockBreak When a player breaks this block
• blockPlace When a player places this block
• blockHit When a player hits this block
• blockInteract When a player interacts with this block (right-clicks it)
• blockStep When a player steps onto this block (called only when they switch to a new block)

• ifBlockType(s) — string or string list — if the block type is (one of)
• ifHasPermission — string — if the player has the permission. Automatically prefixed with "customitems.action." For example, "useMyItem" will require the permission "customitems.action.useMyItem"
• ifNotHasPermission — string — if the player doesn't have the permission. Automatically prefixed like ifHasPermission
• ifHasPermissionRaw — string — if the player has the permission, not prefixed
• ifNotHasPermissionRaw — string — if the player doesn't have the permission, not prefixed
• ifItem(s)InHand — string or string list — if the item in the player's hand is (one of)
• ifItem(s)InOffHand — string or string list — if the item in the player's off hand is (one of)
• ifItemEnchants — enchantments map, see the WIKI — if the item in the player's hand has the enchantments given
• ifPlayerHasItem(s) — string or string list — if the player has (one of these) this items in their inventory
• ifTargetHasItem(s) — string or string list — if the target has (one of these) this items in their inventory
• ifTargetType(s) — string or string list — if the target's entity type is (one of)
• ifNotTargetType(s) — string or string list — if the target's entity type is not (one of)
• ifSneaking — string or string list — if the player is sneaking
• ifGamemode(s) — string or string list — if the player's Game Mode is (one of)
• ifWorld(s) — string or string list — if the player's current world is (one of)
• ifInRegion(s) — string or string list — if the player is currently in (one of) the World Guard Regions
• ifNotInRegion(s) — string or string list — if the player is not currently in (one of) the World Guard Regions
• ifStatementCombine — string — SPECIAL PARAMETER — How the if statements should be combined. "AND" to make sure all conditions are satisfied, or "OR" to run as long as one or more of the conditions is satisfied, no matter whether or not the other conditions are satisfied. You can also use "XOR" to run the action only if exactly one statement is true — if multiple are true, or none are true, the action will not run with "XOR". Default is "AND"
• invertIfResult — boolean (default false) — SPECIAL PARAMETER — Inverts the result of your if statements. If your action would normally not run, and you set this to true, your action will run. If your action normally would run, and you set this to true, your action will not run.

• sendMessage(s) Send message(s) to the player. message(s) — string(s), prefix — boolean (default true)
• playerRunCommand(s) Force the player to run command(s). command(s) — string(s), overridePermisisons — boolean*** (default true)
• consoleRunCommand(s) Force the console to run command(s). command(s) — string(s)
• destroyItemUsed Destroy the item in the player's hand. amount — integer (default 1, use -1 to remove all items of the same type)
• damageItemUsed Damage the item in the player's hand. amount — integer (default 1)
• setBlockType Set the clicked block to type. type — string
• setDrops Set the items to drop. item(s) — string(s)
• givePlayerItem Give the player the specified item. type — string, amount — integer (default 1)
• playerRemoveItem Remove the specified item from the player's inventory. type — string, amount — integer (default all items)
• giveTargetItem Give the target the specified item. type — string, amount — integer (default 1)
• targetRemoveItem Remove the specified item from the target's inventory. type — string, amount — integer (default all items)
• cancel Cancel what just happened. (no parameters)
• uncancel Uncancel what just happened. (no parameter)
• addFood Adds food to the player. amount — integer
• setFood Sets the food of the player. amount — integer
• addSaturation Adds saturation to the player. amount — integer
• setSaturation Sets the saturation of the player. amount — integer
• addHealth Adds health to the player in half-hearts. amount — integer
• setHealth Sets the health of the player in half-hearts. amount — integer
• damagePlayer Damages the player in half-hearts. amount — integer
• addFireTicks Adds to the number of ticks the player is on fire. ticks — integer
• setFireTicks Sets the number of ticks the player is on fire. ticks — integer
• extinguishPlayer Extinguishes the player (no parameters)
• teleportPlayer Teleport the player. world — string, locationX — decimal, locationY — decimal, locationZ — decimal, function — string ("set" or "add" to the player's location. Default is "set"), bringToSurface — boolean (default false)
• playerAddEffect(s) Add potion effects to the player. effect(s) — potion(s) see referencing potions above
• playerRemoveEffect(s) Remove the potion effects from the player. effect(s) — string(s)
• playerClearEffects Remove all potion effects from the player. (no parameters)
• targetAddHealth Adds health to the target in half-hearts. amount — integer
• targetSetHealth Sets the health of the target in half-hearts. amount — integer
• damageTarget Damages the target in half-hearts. amount — integer
• killTarget Kills the target. (no parameters)
• despawnTarget Despawns the target. (no parameters)
• targetAddFireTicks Adds to the number of ticks the target is on fire. ticks — integer
• targetSetFireTicks Sets the number of ticks the target is on fire. ticks — integer
• extinguishTarget Extinguishes the target (no parameters)
• teleportTarget Teleport the target. world — string, locationX — decimal, locationY — decimal, locationZ — decimal, function — string ("set" or "add" to the target's location. Default is "set"), bringToSurface — boolean (default false)
• targetAddEffect(s) Add potion effects to the target. effect(s) — potion(s) see referencing potions above
• targetRemoveEffect(s) Remove the potion effects from the target. effect(s) — string(s)
• targetClearEffects Remove all potion effects from the target. (no parameters)
• none runs no action. (no parameter)
• runActions Special action that runs more actions. actions — action list
• runSkript(s) Special action that runs Skript code with the specified ID. actionID(s) — the id(s) of the actions to run in the Skript files

• probability**** — decimal between 0.0 and 1.0 (default 1.0) — the probability that this action will run. For example, set this to 0.7 to have your action run 70% of the time, and not run the other 30% of the time.
• tickDelay — number (default 0) — the number of ticks the to wait before running the action (there are 20 ticks in one second). For example, set this to 10 to make the action wait half a second before running
• runInterval**** — number (default 1) — number of times to do nothing before running this action. For example, set this to 2 to make the action run every other time, and set it to 10 to make the action run every 10th time.

handlers:
  consume:
    actions:
      -
        action: addHealth
        amount: 10
      -
        action: sendMessages
        messages:
          - "Hey {player}"
          - "You're in the world {player.location.world}"
  rightClickBlock:
    actions:
      -
        action: destroyItemUsed
      -
        ifBlockType: "minecraft:DIAMOND_BLOCK"
        ifHasPermission: "cui.click"
        ifStatementCombine: "AND"
        probability: 0.8

action: runActions
        actions:
          -
            action: setBlockType
            type: "minecraft:AIR"
          -
          action: givePlayerItem
          type: "minecraft:DIAMOND"
          amount: 27
        -
          action: runSkript
          actionID: "mySkriptAction"