Package wtf.choco.locksecurity.api.key

Interface IKeyBuilderSmithed

All Superinterfaces:
IKeyBuilder
public interface IKeyBuilderSmithed
extends IKeyBuilder
An IKeyBuilder implementation for smithed keys.
Since:
3.0.0
Author:
Parker Hawke - Choco

  • Method Details

    • unlocks

      @NotNull IKeyBuilderSmithed unlocks​(@NotNull org.bukkit.inventory.ItemStack key)
      Copy the unlockable blocks from the supplied key.
      Parameters:
      key - the key whose unlockable blocks to copy. Must not be null
      Returns:
      this instance. Allows for chained method calls

    • unlocks

      @NotNull IKeyBuilderSmithed unlocks​(@NotNull Iterable<? extends ILockedBlock> blocks)
      Add the specified blocks to the built key's unlockable blocks.
      Parameters:
      blocks - the blocks to unlock. Must not be null
      Returns:
      this instance. Allows for chained method calls

    • unlocks

      @NotNull IKeyBuilderSmithed unlocks​(@NotNull ILockedBlock... blocks)
      Add the specified blocks to the built key's unlockable blocks.
      Parameters:
      blocks - the blocks to unlock. Must not be null
      Returns:
      this instance. Allows for chained method calls

    • unlocks

      @NotNull IKeyBuilderSmithed unlocks​(@NotNull ILockedBlock block)
      Add the specified block to the built key's unlockable blocks.
      Parameters:
      block - the block to unlock. Must not be null
      Returns:
      this instance. Allows for chained method calls

    • withFlags

      @NotNull IKeyBuilderSmithed withFlags​(@NotNull KeyFlag... flags)
      Assign the specified flags to the built key.
      Parameters:
      flags - the flags to assign. Must not be null
      Returns:
      this instance. Allows for chained method calls

    • withFlag

      @NotNull IKeyBuilderSmithed withFlag​(@NotNull KeyFlag flag, boolean value)
      Assign the specified flag to the built key.
      Parameters:
      flag - the flags to assign
      value - the value to set for this flag
      Returns:
      this instance. Allows for chained method calls

    • withFlag

      @NotNull IKeyBuilderSmithed withFlag​(@NotNull KeyFlag flag)
      Assign the specified flag to the built key.
      Parameters:
      flag - the flag to assign. Must not be null
      Returns:
      this instance. Allows for chained method calls

    • preventDuplication

      @NotNull IKeyBuilderSmithed preventDuplication()
      Apply the KeyFlag.PREVENT_DUPLICATION flag to the built key.
      Returns:
      this instance. Allows for chained method calls

    • preventMerging

      @NotNull IKeyBuilderSmithed preventMerging()
      Apply the KeyFlag.PREVENT_MERGING flag to the built key.
      Returns:
      this instance. Allows for chained method calls

    • preventResetting

      @NotNull IKeyBuilderSmithed preventResetting()
      Apply the KeyFlag.PREVENT_RESETTING flag to the built key.
      Returns:
      this instance. Allows for chained method calls

    • breakOnUse

      @NotNull IKeyBuilderSmithed breakOnUse()
      Apply the KeyFlag.BREAK_ON_USE flag to the built key.
      Returns:
      this instance. Allows for chained method calls

    • hideBlockCoordinates

      @NotNull IKeyBuilderSmithed hideBlockCoordinates()
      Apply the KeyFlag.HIDE_BLOCK_COORDINATES flag to the built key.
      Returns:
      this instance. Allows for chained method calls

    • hideFlagLore

      @NotNull IKeyBuilderSmithed hideFlagLore​(boolean hide)
      Hide the lore from flags that would otherwise be applied on the built key.
      Parameters:
      hide - whether or not to hide the flag lore
      Returns:
      this instance. Allows for chained method calls

    • hideFlagLore

      @NotNull IKeyBuilderSmithed hideFlagLore()
      Hide the lore from flags that would otherwise be applied on the built key.
      Returns:
      this instance. Allows for chained method calls