Package org.sgrewritten.stargate.api.gate

Interface GateFormatAPI

All Known Implementing Classes:
GateFormat
public interface GateFormatAPI
Represents a specific gate format

  • Method Details

    • getFileName

      String getFileName()
      Returns:

      The name of the file this format was loaded from

    • getControlBlocks

      List<org.bukkit.util.BlockVector> getControlBlocks()
      Returns:

      The positions of the control blocks in format space

    • getIrisMaterial

      org.bukkit.Material getIrisMaterial(boolean getOpenMaterial)
      Gets the material used for this gate format's iris when in the given state
      Parameters:
      getOpenMaterial -

      Whether to get the open-material or the closed-material

      Returns:

      The material used for this gate format's iris

    • isIronDoorBlockable

      boolean isIronDoorBlockable()
      Gets whether this gate format is iron door blockable

      Iron door block-ability is defined as such: Can the Stargate's entrance be fully blocked by a single iron door?

      Returns:

      True if iron door blockable

    • getExit

      org.bukkit.util.BlockVector getExit()
      Returns:

      The coordinates of the exit point for this gate format

    • getStructure

      GateStructure getStructure(GateFormatStructureType gateFormatStructureType)
      Get a structure based on the type of structure
      Parameters:
      gateFormatStructureType -

      A gate structure type

      Returns:

      A gate structure

    • matches

      boolean matches(VectorOperation converter, org.bukkit.Location topLeft)
      Determines whether the format matches when provided a conversion between minecraft space and format space.
      Parameters:
      converter -

      Vector operation which converts between format space and minecraft space

      topLeft -

      Origo in format space, top left of format in real space

      Returns:

    • getHeight

      int getHeight()
      Returns:

      the height of the format (Y axis)

    • getWidth

      int getWidth()
      Returns:

      The width of the format (Z axis)

    • getBoundingBox

      org.bukkit.util.BoundingBox getBoundingBox()
      Get the bounding box of this gate format
      Returns:

      The bounding box of this format