2014-04-03 06:42:11 +00:00
|
|
|
/*
|
|
|
|
* WorldEdit, a Minecraft world manipulation toolkit
|
|
|
|
* Copyright (C) sk89q <http://www.sk89q.com>
|
|
|
|
* Copyright (C) WorldEdit team and contributors
|
|
|
|
*
|
2014-04-04 22:03:18 +00:00
|
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU Lesser General Public License as published by the
|
|
|
|
* Free Software Foundation, either version 3 of the License, or
|
2014-04-03 06:42:11 +00:00
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
2014-04-04 22:03:18 +00:00
|
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
|
|
|
|
* for more details.
|
2014-04-03 06:42:11 +00:00
|
|
|
*
|
2014-04-04 22:03:18 +00:00
|
|
|
* You should have received a copy of the GNU Lesser General Public License
|
2014-04-03 06:42:11 +00:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
package com.sk89q.worldedit.extent;
|
|
|
|
|
2019-08-06 15:32:05 +00:00
|
|
|
import com.sk89q.jnbt.CompoundTag;
|
2014-04-03 06:42:11 +00:00
|
|
|
import com.sk89q.worldedit.WorldEditException;
|
|
|
|
import com.sk89q.worldedit.function.operation.Operation;
|
2018-10-14 10:40:53 +00:00
|
|
|
import com.sk89q.worldedit.math.BlockVector2;
|
|
|
|
import com.sk89q.worldedit.math.BlockVector3;
|
2019-10-23 04:23:52 +00:00
|
|
|
import com.sk89q.worldedit.math.MutableBlockVector2;
|
|
|
|
import com.sk89q.worldedit.math.MutableBlockVector3;
|
2019-02-16 07:27:00 +00:00
|
|
|
import com.sk89q.worldedit.world.biome.BiomeType;
|
2018-07-30 13:26:06 +00:00
|
|
|
import com.sk89q.worldedit.world.block.BlockStateHolder;
|
2014-04-03 06:42:11 +00:00
|
|
|
|
|
|
|
import javax.annotation.Nullable;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Accepts block and entity changes.
|
|
|
|
*/
|
|
|
|
public interface OutputExtent {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Change the block at the given location to the given block. The operation may
|
2018-06-18 12:51:21 +00:00
|
|
|
* not tie the given {@link BlockStateHolder} to the world, so future changes to the
|
|
|
|
* {@link BlockStateHolder} do not affect the world until this method is called again.
|
2014-07-26 07:29:12 +00:00
|
|
|
*
|
|
|
|
* <p>The return value of this method indicates whether the change was probably
|
2014-04-03 06:42:11 +00:00
|
|
|
* 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
|
2014-07-26 07:29:12 +00:00
|
|
|
* example, the approximate number of changes.</p>
|
2014-04-03 06:42:11 +00:00
|
|
|
*
|
|
|
|
* @param position position of the block
|
|
|
|
* @param block block to set
|
|
|
|
* @return true if the block was successfully set (return value may not be accurate)
|
2014-07-29 21:23:00 +00:00
|
|
|
* @throws WorldEditException thrown on an error
|
2019-09-21 01:52:35 +00:00
|
|
|
* @deprecated It is recommended that you use {@link #setBlock(int, int, int, BlockStateHolder)} in FAWE
|
2014-04-03 06:42:11 +00:00
|
|
|
*/
|
2019-08-06 15:32:05 +00:00
|
|
|
@Deprecated
|
2019-10-23 04:23:52 +00:00
|
|
|
default <T extends BlockStateHolder<T>> boolean setBlock(BlockVector3 position, T block) throws WorldEditException {
|
|
|
|
return setBlock(position.getX(), position.getY(), position.getZ(), block);
|
|
|
|
}
|
2019-05-12 13:32:04 +00:00
|
|
|
|
2019-10-23 04:23:52 +00:00
|
|
|
// The defaults need to remain for compatibility (the actual implementation still needs to override one of these)
|
2020-01-15 00:44:09 +00:00
|
|
|
default <B extends BlockStateHolder<B>> boolean setBlock(int x, int y, int z, B block) throws WorldEditException {
|
2019-10-23 04:23:52 +00:00
|
|
|
return setBlock(MutableBlockVector3.get(x, y, z), block);
|
|
|
|
}
|
2014-04-03 06:42:11 +00:00
|
|
|
|
2019-08-06 15:32:05 +00:00
|
|
|
boolean setTile(int x, int y, int z, CompoundTag tile) throws WorldEditException;
|
|
|
|
|
2014-07-17 07:21:13 +00:00
|
|
|
/**
|
|
|
|
* Set the biome.
|
|
|
|
*
|
|
|
|
* @param position the (x, z) location to set the biome at
|
|
|
|
* @param biome the biome to set to
|
|
|
|
* @return true if the biome was successfully set (return value may not be accurate)
|
|
|
|
*/
|
2019-10-23 04:23:52 +00:00
|
|
|
default boolean setBiome(BlockVector2 position, BiomeType biome) {
|
|
|
|
return setBiome(position.getX(), 0, position.getBlockZ(), biome);
|
|
|
|
}
|
2019-05-12 13:32:04 +00:00
|
|
|
|
2019-10-23 04:23:52 +00:00
|
|
|
// The defaults need to remain for compatibility (the actual implementation still needs to override one of these)
|
|
|
|
default boolean setBiome(int x, int y, int z, BiomeType biome) {
|
|
|
|
return setBiome(MutableBlockVector2.get(x, z), biome);
|
|
|
|
}
|
2014-07-17 07:21:13 +00:00
|
|
|
|
2020-05-27 10:45:08 +00:00
|
|
|
/**
|
|
|
|
* Set the light value
|
|
|
|
*
|
|
|
|
* @param position position of the block
|
|
|
|
* @param value light level to set
|
|
|
|
*/
|
|
|
|
default void setBlockLight(BlockVector3 position, int value) {
|
|
|
|
setBlockLight(position.getX(), position.getY(), position.getZ(), value);
|
|
|
|
}
|
|
|
|
|
|
|
|
default void setBlockLight(int x, int y, int z, int value) {}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the sky light value
|
|
|
|
*
|
|
|
|
* @param position position of the block
|
|
|
|
* @param value light level to set
|
|
|
|
*/
|
|
|
|
default void setSkyLight(BlockVector3 position, int value) {
|
|
|
|
setSkyLight(position.getX(), position.getY(), position.getZ(), value);
|
|
|
|
}
|
|
|
|
|
|
|
|
default void setSkyLight(int x, int y, int z, int value) {}
|
|
|
|
|
2014-04-03 06:42:11 +00:00
|
|
|
/**
|
|
|
|
* Return an {@link Operation} that should be called to tie up loose ends
|
|
|
|
* (such as to commit changes in a buffer).
|
|
|
|
*
|
|
|
|
* @return an operation or null if there is none to execute
|
|
|
|
*/
|
|
|
|
@Nullable Operation commit();
|
|
|
|
|
|
|
|
}
|