2018-06-18 07:53:33 +00:00
|
|
|
/*
|
|
|
|
* WorldEdit, a Minecraft world manipulation toolkit
|
|
|
|
* Copyright (C) sk89q <http://www.sk89q.com>
|
|
|
|
* Copyright (C) WorldEdit team and contributors
|
|
|
|
*
|
2020-08-25 01:31:47 +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
|
2018-06-18 07:53:33 +00:00
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
2020-08-25 01:31:47 +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.
|
2018-06-18 07:53:33 +00:00
|
|
|
*
|
2020-08-25 01:31:47 +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/>.
|
2018-06-18 07:53:33 +00:00
|
|
|
*/
|
|
|
|
|
2018-07-05 08:15:51 +00:00
|
|
|
package com.sk89q.worldedit.world.block;
|
2018-06-18 07:53:33 +00:00
|
|
|
|
2021-07-23 15:48:51 +00:00
|
|
|
import com.fastasyncworldedit.core.queue.ITileInput;
|
2021-07-24 15:34:05 +00:00
|
|
|
import com.fastasyncworldedit.core.registry.state.PropertyKey;
|
2019-06-28 23:00:31 +00:00
|
|
|
import com.sk89q.jnbt.CompoundTag;
|
2019-04-07 07:41:26 +00:00
|
|
|
import com.sk89q.worldedit.blocks.TileEntityBlock;
|
2019-10-23 04:23:52 +00:00
|
|
|
import com.sk89q.worldedit.extent.OutputExtent;
|
2020-01-21 19:30:13 +00:00
|
|
|
import com.sk89q.worldedit.function.pattern.Pattern;
|
2021-07-01 20:16:25 +00:00
|
|
|
import com.sk89q.worldedit.internal.util.DeprecationUtil;
|
|
|
|
import com.sk89q.worldedit.internal.util.NonAbstractForCompatibility;
|
2019-04-10 19:14:58 +00:00
|
|
|
import com.sk89q.worldedit.math.BlockVector3;
|
2018-07-05 23:16:52 +00:00
|
|
|
import com.sk89q.worldedit.registry.state.Property;
|
2021-07-01 20:16:25 +00:00
|
|
|
import com.sk89q.worldedit.util.concurrency.LazyReference;
|
|
|
|
import com.sk89q.worldedit.util.nbt.CompoundBinaryTag;
|
2021-07-24 15:34:05 +00:00
|
|
|
import com.sk89q.worldedit.world.registry.BlockMaterial;
|
2018-06-18 07:53:33 +00:00
|
|
|
|
2020-07-14 02:50:59 +00:00
|
|
|
import java.util.Locale;
|
2018-06-18 07:53:33 +00:00
|
|
|
import java.util.Map;
|
2018-07-15 14:21:32 +00:00
|
|
|
import java.util.stream.Collectors;
|
2018-06-18 07:53:33 +00:00
|
|
|
|
2021-07-23 15:48:51 +00:00
|
|
|
//FAWE start - TileEntityBlock
|
2020-01-21 19:30:13 +00:00
|
|
|
public interface BlockStateHolder<B extends BlockStateHolder<B>> extends TileEntityBlock, Pattern {
|
2021-07-23 15:48:51 +00:00
|
|
|
//FAWE end
|
2018-06-18 07:53:33 +00:00
|
|
|
|
|
|
|
/**
|
2020-10-05 17:41:41 +00:00
|
|
|
* Get the block type.
|
2018-06-18 07:53:33 +00:00
|
|
|
*
|
|
|
|
* @return The type
|
|
|
|
*/
|
2019-01-31 15:08:58 +00:00
|
|
|
BlockType getBlockType();
|
2018-06-18 07:53:33 +00:00
|
|
|
|
2021-07-23 15:48:51 +00:00
|
|
|
//FAWE start
|
2021-07-24 15:34:05 +00:00
|
|
|
|
2018-06-18 07:53:33 +00:00
|
|
|
/**
|
2020-10-05 17:41:41 +00:00
|
|
|
* Magic number (legacy uses).
|
2018-08-12 14:03:07 +00:00
|
|
|
*/
|
|
|
|
@Deprecated
|
2019-03-28 19:02:37 +00:00
|
|
|
B withPropertyId(int propertyId);
|
2018-08-12 14:03:07 +00:00
|
|
|
|
|
|
|
/**
|
2020-10-05 17:41:41 +00:00
|
|
|
* Get combined id (legacy uses).
|
2018-08-12 14:03:07 +00:00
|
|
|
*/
|
|
|
|
@Deprecated
|
|
|
|
int getInternalId();
|
|
|
|
|
2018-08-27 16:56:28 +00:00
|
|
|
@Deprecated
|
|
|
|
int getOrdinal();
|
|
|
|
|
2019-04-30 16:19:10 +00:00
|
|
|
@Deprecated
|
|
|
|
char getOrdinalChar();
|
|
|
|
|
2019-01-31 15:08:58 +00:00
|
|
|
BlockMaterial getMaterial();
|
2019-09-21 01:52:35 +00:00
|
|
|
|
2018-08-12 14:03:07 +00:00
|
|
|
/**
|
2020-10-05 17:41:41 +00:00
|
|
|
* Get type id (legacy uses).
|
2018-08-12 14:03:07 +00:00
|
|
|
*/
|
|
|
|
@Deprecated
|
2019-01-31 15:08:58 +00:00
|
|
|
int getInternalBlockTypeId();
|
2020-10-05 17:41:41 +00:00
|
|
|
|
2018-08-12 14:03:07 +00:00
|
|
|
/**
|
2020-10-05 17:41:41 +00:00
|
|
|
* Get the block data (legacy uses).
|
2018-08-12 14:03:07 +00:00
|
|
|
*/
|
|
|
|
@Deprecated
|
|
|
|
int getInternalPropertiesId();
|
2021-07-23 15:48:51 +00:00
|
|
|
//FAWE end
|
2018-08-12 14:03:07 +00:00
|
|
|
|
|
|
|
/**
|
2019-03-28 19:02:37 +00:00
|
|
|
* Returns a BlockState with the given state and value applied.
|
2018-06-18 07:53:33 +00:00
|
|
|
*
|
2018-07-05 23:16:52 +00:00
|
|
|
* @param property The state
|
2021-07-24 15:34:05 +00:00
|
|
|
* @param value The value
|
2018-06-18 07:53:33 +00:00
|
|
|
* @return The modified state, or same if could not be applied
|
|
|
|
*/
|
2019-03-28 19:02:37 +00:00
|
|
|
<V> B with(final Property<V> property, final V value);
|
2018-06-18 07:53:33 +00:00
|
|
|
|
2021-08-25 11:25:33 +00:00
|
|
|
/**
|
|
|
|
* Gets the value for the given state.
|
|
|
|
*
|
|
|
|
* @param property The state
|
|
|
|
* @return The value
|
|
|
|
*/
|
|
|
|
<V> V getState(Property<V> property);
|
|
|
|
|
|
|
|
//FAWE start
|
2018-08-12 14:03:07 +00:00
|
|
|
/**
|
|
|
|
* Returns a BlockStateHolder with the given state and value applied.
|
|
|
|
*
|
|
|
|
* @param property The property key
|
2021-07-24 15:34:05 +00:00
|
|
|
* @param value The value
|
2018-08-12 14:03:07 +00:00
|
|
|
* @return The modified state, or same if could not be applied
|
|
|
|
*/
|
2019-03-28 19:02:37 +00:00
|
|
|
<V> B with(final PropertyKey property, final V value);
|
2018-08-12 14:03:07 +00:00
|
|
|
|
|
|
|
/**
|
2020-10-05 17:41:41 +00:00
|
|
|
* Gets the value for the given state.
|
2018-08-12 14:03:07 +00:00
|
|
|
*
|
|
|
|
* @param property The state
|
|
|
|
* @return The value
|
|
|
|
*/
|
|
|
|
<V> V getState(final PropertyKey property);
|
2021-08-25 11:25:33 +00:00
|
|
|
//FAWE end
|
2018-08-12 14:03:07 +00:00
|
|
|
|
2018-06-18 07:53:33 +00:00
|
|
|
/**
|
|
|
|
* Gets an immutable collection of the states.
|
|
|
|
*
|
|
|
|
* @return The states
|
|
|
|
*/
|
2018-07-05 23:16:52 +00:00
|
|
|
Map<Property<?>, Object> getStates();
|
2018-06-18 12:51:21 +00:00
|
|
|
|
|
|
|
/**
|
2019-03-26 17:27:09 +00:00
|
|
|
* Checks if the type is the same, and if the matched states are the same.
|
|
|
|
*
|
2018-06-18 12:51:21 +00:00
|
|
|
* @param o other block
|
|
|
|
* @return true if equal
|
|
|
|
*/
|
2018-12-27 00:39:10 +00:00
|
|
|
boolean equalsFuzzy(BlockStateHolder<?> o);
|
2018-07-01 12:03:22 +00:00
|
|
|
|
|
|
|
/**
|
2018-08-10 10:29:06 +00:00
|
|
|
* Returns an immutable {@link BlockState} from this BlockStateHolder.
|
2018-07-01 12:03:22 +00:00
|
|
|
*
|
|
|
|
* @return A BlockState
|
|
|
|
*/
|
|
|
|
BlockState toImmutableState();
|
2018-07-15 14:21:32 +00:00
|
|
|
|
2018-08-10 10:29:06 +00:00
|
|
|
/**
|
|
|
|
* Gets a {@link BaseBlock} from this BlockStateHolder.
|
|
|
|
*
|
|
|
|
* @return The BaseBlock
|
|
|
|
*/
|
|
|
|
BaseBlock toBaseBlock();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets a {@link BaseBlock} from this BlockStateHolder.
|
|
|
|
*
|
|
|
|
* @param compoundTag The NBT Data to apply
|
|
|
|
* @return The BaseBlock
|
2021-07-01 20:16:25 +00:00
|
|
|
* @deprecated Use {@link BlockStateHolder#toBaseBlock(LazyReference)}.
|
2018-08-10 10:29:06 +00:00
|
|
|
*/
|
2021-07-01 20:16:25 +00:00
|
|
|
@Deprecated
|
|
|
|
default BaseBlock toBaseBlock(CompoundTag compoundTag) {
|
|
|
|
return toBaseBlock(compoundTag == null ? null : LazyReference.from(compoundTag::asBinaryTag));
|
2019-09-21 01:52:35 +00:00
|
|
|
}
|
|
|
|
|
2019-04-07 07:41:26 +00:00
|
|
|
/**
|
2021-07-01 20:16:25 +00:00
|
|
|
* Gets a {@link BaseBlock} from this BlockStateHolder.
|
2019-04-07 07:41:26 +00:00
|
|
|
*
|
2021-07-01 20:16:25 +00:00
|
|
|
* @param compoundTag The NBT Data to apply
|
|
|
|
* @return The BaseBlock
|
|
|
|
* @apiNote This must be overridden by new subclasses. See {@link NonAbstractForCompatibility}
|
|
|
|
* for details
|
2019-04-07 07:41:26 +00:00
|
|
|
*/
|
2021-07-01 20:16:25 +00:00
|
|
|
@NonAbstractForCompatibility(
|
2021-07-24 15:34:05 +00:00
|
|
|
delegateName = "toBaseBlock",
|
|
|
|
delegateParams = {CompoundTag.class}
|
2021-07-01 20:16:25 +00:00
|
|
|
)
|
|
|
|
default BaseBlock toBaseBlock(LazyReference<CompoundBinaryTag> compoundTag) {
|
|
|
|
DeprecationUtil.checkDelegatingOverride(getClass());
|
2019-04-07 07:41:26 +00:00
|
|
|
|
2021-07-01 20:16:25 +00:00
|
|
|
return toBaseBlock(compoundTag == null ? null : new CompoundTag(compoundTag.getValue()));
|
2019-04-07 07:41:26 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-07-01 20:16:25 +00:00
|
|
|
* Gets a {@link BaseBlock} from this BlockStateHolder.
|
2019-04-07 07:41:26 +00:00
|
|
|
*
|
2021-07-01 20:16:25 +00:00
|
|
|
* @param compoundTag The NBT Data to apply
|
|
|
|
* @return The BaseBlock
|
2019-04-07 07:41:26 +00:00
|
|
|
*/
|
2021-07-01 20:16:25 +00:00
|
|
|
default BaseBlock toBaseBlock(CompoundBinaryTag compoundTag) {
|
|
|
|
return toBaseBlock(compoundTag == null ? null : LazyReference.computed(compoundTag));
|
2019-04-07 07:41:26 +00:00
|
|
|
}
|
|
|
|
|
2021-07-01 20:16:25 +00:00
|
|
|
@Override
|
|
|
|
default BaseBlock applyBlock(BlockVector3 position) {
|
|
|
|
return toBaseBlock();
|
2019-04-07 07:41:26 +00:00
|
|
|
}
|
|
|
|
|
2021-08-25 11:25:33 +00:00
|
|
|
//FAWE start
|
2021-07-01 20:16:25 +00:00
|
|
|
void applyTileEntity(OutputExtent output, int x, int y, int z);
|
|
|
|
|
2019-11-20 03:40:52 +00:00
|
|
|
default BaseBlock toBaseBlock(ITileInput input, int x, int y, int z) {
|
|
|
|
throw new UnsupportedOperationException("State is immutable");
|
|
|
|
}
|
2021-07-23 15:48:51 +00:00
|
|
|
//FAWE end
|
2019-11-20 03:40:52 +00:00
|
|
|
|
2018-07-15 14:21:32 +00:00
|
|
|
default String getAsString() {
|
|
|
|
if (getStates().isEmpty()) {
|
|
|
|
return this.getBlockType().getId();
|
|
|
|
} else {
|
2019-06-28 23:00:31 +00:00
|
|
|
String properties = getStates().entrySet().stream()
|
2021-07-24 15:34:05 +00:00
|
|
|
.map(entry -> entry.getKey().getName()
|
|
|
|
+ "="
|
|
|
|
+ entry.getValue().toString().toLowerCase(Locale.ROOT))
|
|
|
|
.collect(Collectors.joining(","));
|
2018-07-15 14:21:32 +00:00
|
|
|
return this.getBlockType().getId() + "[" + properties + "]";
|
|
|
|
}
|
|
|
|
}
|
2021-07-24 15:34:05 +00:00
|
|
|
|
2018-06-18 07:53:33 +00:00
|
|
|
}
|