Package com.sk89q.worldedit.extent.validation

Class DataValidatorExtent

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.validation.DataValidatorExtent
All Implemented Interfaces:
Extent, InputExtent, OutputExtent
public class DataValidatorExtent extends AbstractDelegateExtent
Validates set data to prevent creating invalid blocks and such.

  • Constructor Details

    • DataValidatorExtent

      public DataValidatorExtent(Extent extent, World world)
      Create a new instance.
      Parameters:
      extent - the extent
      world - the world

    • DataValidatorExtent

      public DataValidatorExtent(Extent extent, int minY, int maxY)
      Create a new instance.
      Parameters:
      extent - The extent
      minY - The minimum Y height to allow (inclusive)
      maxY - The maximum Y height to allow (inclusive)

  • Method Details

    • setBlock

      public <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 location, B block) throws WorldEditException
      Description copied from interface: OutputExtent
      Change the block at the given location to the given block. The operation may not tie the given BlockStateHolder to the world, so future changes to the BlockStateHolder do not affect the world until this method is called again.

      The return value of this method indicates whether the change was probably successful. It may not be successful if, for example, the location is out of the bounds of the extent. It may be unsuccessful if the block passed is the same as the one in the world. However, the return value is only an estimation and it may be incorrect, but it could be used to count, for example, the approximate number of changes.

      Specified by:
      setBlock in interface OutputExtent
      Overrides:
      setBlock in class AbstractDelegateExtent
      Parameters:
      location - position of the block
      block - block to set
      Returns:
      true if the block was successfully set (return value may not be accurate)
      Throws:
      WorldEditException - thrown on an error

    • setBiome

      public boolean setBiome(BlockVector3 location, BiomeType biome)
      Description copied from interface: OutputExtent
      Set the biome.

      As implementation varies per Minecraft version, this may set more than this position's biome. On versions prior to 1.15, this will set the entire column. On later versions it will set the 4x4x4 cube.

      Specified by:
      setBiome in interface OutputExtent
      Overrides:
      setBiome in class AbstractDelegateExtent
      Parameters:
      location - the (x, y, z) location to set the biome at
      biome - the biome to set to
      Returns:
      true if the biome was successfully set (return value may not be accurate)