Package org.spongepowered.api.map

Interface MapCanvas.Builder

All Superinterfaces:
ResettableBuilder<MapCanvas,MapCanvas.Builder>
Enclosing interface:
MapCanvas
public static interface MapCanvas.Builder extends ResettableBuilder<MapCanvas,MapCanvas.Builder>
A builder that creates a MapCanvas.

  • Method Details

    • paintAll

      MapCanvas.Builder paintAll(MapColor color)
      Sets the entire canvas to the supplied MapColor.
      Parameters:
      color - The MapColor
      Returns:
      this builder, for chaining

    • paint

      MapCanvas.Builder paint(int startX, int startY, int endX, int endY, MapColor mapColor)
      Sets the rectangle bounded by the given co-ordinates to the supplied MapColor.

      The provided co-ordinates are included in the region.

      Parameters:
      startX - Bottom left corner of region to paint
      startY - Bottom left corner of region to paint
      endX - Top right corner of region to paint
      endY - Top right corner of region to paint
      mapColor - The MapColor to paint the given region
      Returns:
      this builder, for chaining

    • paint

      default MapCanvas.Builder paint(Vector2i start, Vector2i end, MapColor mapColor)
      Sets the rectangle bounded by the given co-ordinates to the supplied MapColor.

      The provided co-ordinates are included in the region.

      Parameters:
      start - A Vector2i that represents one corner of the rectangle.
      end - A Vector2i that represents the opposite corner of the rectangle.
      mapColor - The MapColor to paint this region
      Returns:
      this builder, for chaining

    • from

      MapCanvas.Builder from(MapCanvas canvas)
      Sets up this builder such that calling build() will return a copy of the supplied MapCanvas.
      Parameters:
      canvas - MapCanvas to set the state of this builder to
      Returns:
      this builder, for chaining

    • fromImage

      MapCanvas.Builder fromImage(Image image) throws IllegalArgumentException
      Fills a canvas from an image This given image will be copied and thus changes to the image after this is called will not be reflected.
      Parameters:
      image - to take from
      Returns:
      This Builder, for chaining
      Throws:
      IllegalArgumentException - if width/height is wrong or not known yet
      IllegalArgumentException - if color found is not in the palette MapColorTypes

    • fromContainer

      MapCanvas.Builder fromContainer(DataView container)
      Attempts to reconstruct the builder with all of the data from DataSerializable.toContainer().
      Parameters:
      container - The container to translate
      Returns:
      This builder, for chaining

    • build

      MapCanvas build()
      Creates a MapCanvas from the state of this builder.
      Returns:
      The MapCanvas