Interface BrushBuilder

public interface BrushBuilder
Builder to build brushes.

  • Method Details

    • getSchematicSet

      Optional<SchematicSetBuilder> getSchematicSet(int id)
      Get the schematic set builder for the set with the id
      Parameters:
      id - id
      Returns:
      set if the id exists

    • removeSchematicSet

      boolean removeSchematicSet(int id)
      Remove the set with the id
      Parameters:
      id - id
      Returns:
      true if the set with the id was removed

    • createSchematicSet

      int createSchematicSet()
      Create a new schematic set
      Returns:
      id of the created schematic set

    • setPlacementModifier

      <T extends Nameable> void setPlacementModifier(T type, Mutator<?> provider)
      Sets the placement modifier
      Type Parameters:
      T - Type of the placement modifier
      Parameters:
      type - type
      provider - provider

    • removePlacementModifier

      <T extends Nameable> void removePlacementModifier(T type)
      Removes the placement modifier
      Type Parameters:
      T - Type of the placement modifier
      Parameters:
      type - type

    • build

      SchematicBrush build(Plugin plugin, Player owner)
      Build the schematic brush
      Parameters:
      plugin - plugin
      owner - brush owner
      Returns:
      new schematic brush instance

    • buildSettings

      BrushSettings buildSettings()
      Builds the settings of a brush from the current state. The settings share no mutable state with this builder.
      Returns:
      new brush settings

    • addSchematicSet

      void addSchematicSet(SchematicSetBuilder schematicSetBuilder)
      Add a new schematic set builder
      Parameters:
      schematicSetBuilder - builder to add

    • schematicSets

      List<SchematicSetBuilder> schematicSets()
      Get the registered schematic set builder
      Returns:
      unmodifiable list of schematic sets

    • placementModifier

      Map<? extends Nameable, Mutator<?>> placementModifier()
      Get the current placement modifier
      Returns:
      unmodifiable map of the placement modifier

    • clear

      void clear()
      Reset all modifier to default and clear schematic sets.

    • getSchematicCount

      int getSchematicCount()
      Get the schematic count of the brush
      Returns:
      schematic count

    • refresh

      void refresh()
      Reload all schematics in the brush

    • snapshot

      BrushBuilderSnapshot snapshot()
      Get a immutable snapshot of the brush builder.
      Returns:
      snapshot

    • restore

      void restore(BrushBuilderSnapshot snapshot)
      Replaces the placement modifiers and schematic sets with copies of those in the snapshot.
      Parameters:
      snapshot - snapshot to restore