Package com.sk89q.worldedit.extent.world

Class SurvivalModeExtent

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.world.SurvivalModeExtent
All Implemented Interfaces:
Extent, InputExtent, OutputExtent
public class SurvivalModeExtent extends AbstractDelegateExtent
Makes changes to the world as if a player had done so during survival mode.

Note that this extent may choose to not call the underlying extent and may instead call methods on the World that is passed in the constructor. For that reason, if you wish to "catch" changes, you should catch them before the changes reach this extent.

  • Constructor Details

    • SurvivalModeExtent

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

  • Method Details

    • hasToolUse

      public boolean hasToolUse()
      Return whether changes to the world should be simulated with the use of game tools (such as pickaxes) whenever possible and reasonable.

      For example, we could pretend that the act of setting a coal ore block to air (nothing) was the act of a player mining that coal ore block with a pickaxe, which would mean that a coal item would be dropped.

      Returns:
      true if tool use is to be simulated

    • setToolUse

      public void setToolUse(boolean toolUse)
      Set whether changes to the world should be simulated with the use of game tools (such as pickaxes) whenever possible and reasonable.
      Parameters:
      toolUse - true if tool use is to be simulated
      See Also:

    • hasStripNbt

      public boolean hasStripNbt()

    • setStripNbt

      public void setStripNbt(boolean stripNbt)

    • 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