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
|
|
|
|
*
|
2020-08-18 19:48:31 +00:00
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU 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.
|
|
|
|
*
|
2020-08-18 19:48:31 +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 General Public License for more details.
|
2014-04-03 06:42:11 +00:00
|
|
|
*
|
2020-08-18 19:48:31 +00:00
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
2014-04-03 06:42:11 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
package com.sk89q.worldedit.extent;
|
|
|
|
|
2021-07-23 15:48:51 +00:00
|
|
|
import com.fastasyncworldedit.core.extent.processor.heightmap.HeightMapType;
|
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;
|
2020-08-18 19:48:31 +00:00
|
|
|
import com.sk89q.worldedit.internal.util.DeprecationUtil;
|
|
|
|
import com.sk89q.worldedit.internal.util.NonAbstractForCompatibility;
|
2018-10-14 10:40:53 +00:00
|
|
|
import com.sk89q.worldedit.math.BlockVector2;
|
|
|
|
import com.sk89q.worldedit.math.BlockVector3;
|
2021-07-23 15:48:51 +00:00
|
|
|
import com.fastasyncworldedit.core.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;
|
|
|
|
|
2020-09-12 13:31:42 +00:00
|
|
|
/**
|
|
|
|
* Check if this extent fully supports 3D biomes.
|
|
|
|
*
|
|
|
|
* <p>
|
|
|
|
* If {@code false}, the extent only visually reads biomes from {@code y = 0}.
|
|
|
|
* The biomes will still be set in 3D, but the client will only see the one at
|
|
|
|
* {@code y = 0}. It is up to the caller to determine if they want to set that
|
|
|
|
* biome instead, or simply warn the actor.
|
|
|
|
* </p>
|
|
|
|
*
|
|
|
|
* @return if the extent fully supports 3D biomes
|
|
|
|
*/
|
|
|
|
default boolean fullySupports3DBiomes() {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
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)
|
2020-08-18 19:48:31 +00:00
|
|
|
* @deprecated Biomes in Minecraft are 3D now, use {@link OutputExtent#setBiome(BlockVector3, BiomeType)}
|
2014-07-17 07:21:13 +00:00
|
|
|
*/
|
2020-08-18 19:48:31 +00:00
|
|
|
@Deprecated
|
2019-10-23 04:23:52 +00:00
|
|
|
default boolean setBiome(BlockVector2 position, BiomeType biome) {
|
2020-10-22 21:18:16 +00:00
|
|
|
boolean result = false;
|
|
|
|
for (int y = 0; y < 256; y ++) {
|
|
|
|
result |= setBiome(position.toBlockVector3().mutY(y), biome);
|
|
|
|
}
|
|
|
|
return result;
|
2019-10-23 04:23:52 +00:00
|
|
|
}
|
2019-05-12 13:32:04 +00:00
|
|
|
|
2020-08-18 19:48:31 +00:00
|
|
|
@NonAbstractForCompatibility(
|
|
|
|
delegateName = "setBiome",
|
|
|
|
delegateParams = { int.class, int.class, int.class, BiomeType.class }
|
|
|
|
)
|
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) {
|
2020-08-18 19:48:31 +00:00
|
|
|
DeprecationUtil.checkDelegatingOverride(getClass());
|
|
|
|
|
2020-08-25 02:04:56 +00:00
|
|
|
return setBiome(MutableBlockVector3.get(x, y, z), biome);
|
2019-10-23 04:23:52 +00:00
|
|
|
}
|
2014-07-17 07:21:13 +00:00
|
|
|
|
2021-07-23 15:48:51 +00:00
|
|
|
//FAWE start
|
2020-05-27 10:45:08 +00:00
|
|
|
/**
|
2020-08-18 19:48:31 +00:00
|
|
|
* Set the biome.
|
|
|
|
*
|
|
|
|
* <p>
|
|
|
|
* 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.
|
|
|
|
* </p>
|
|
|
|
*
|
|
|
|
* @param position the (x, y, 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)
|
|
|
|
* @apiNote This must be overridden by new subclasses. See {@link NonAbstractForCompatibility}
|
|
|
|
* for details
|
|
|
|
*/
|
|
|
|
@NonAbstractForCompatibility(
|
|
|
|
delegateName = "setBiome",
|
|
|
|
delegateParams = { BlockVector3.class, BiomeType.class }
|
|
|
|
)
|
|
|
|
default boolean setBiome(BlockVector3 position, BiomeType biome) {
|
|
|
|
DeprecationUtil.checkDelegatingOverride(getClass());
|
|
|
|
|
|
|
|
return setBiome(position.toBlockVector2(), biome);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the light value.
|
2020-05-27 10:45:08 +00:00
|
|
|
*
|
|
|
|
* @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);
|
|
|
|
}
|
|
|
|
|
2020-08-18 19:48:31 +00:00
|
|
|
default void setBlockLight(int x, int y, int z, int value) {
|
|
|
|
}
|
2020-05-27 10:45:08 +00:00
|
|
|
|
|
|
|
/**
|
2020-08-18 19:48:31 +00:00
|
|
|
* Set the sky light value.
|
2020-05-27 10:45:08 +00:00
|
|
|
*
|
|
|
|
* @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);
|
|
|
|
}
|
2021-07-23 15:48:51 +00:00
|
|
|
//FAWE end
|
2020-05-27 10:45:08 +00:00
|
|
|
|
2020-08-18 19:48:31 +00:00
|
|
|
default void setSkyLight(int x, int y, int z, int value) {
|
|
|
|
}
|
2020-05-27 10:45:08 +00:00
|
|
|
|
2020-09-14 13:19:23 +00:00
|
|
|
default void setHeightMap(HeightMapType type, int[] heightMap) {
|
|
|
|
}
|
|
|
|
|
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();
|
|
|
|
}
|