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
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2018-07-05 08:15:51 +00:00
|
|
|
package com.sk89q.worldedit.world.block;
|
2018-06-18 07:53:33 +00:00
|
|
|
|
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;
|
2018-08-12 14:03:07 +00:00
|
|
|
import com.sk89q.worldedit.function.pattern.FawePattern;
|
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;
|
2018-08-12 14:03:07 +00:00
|
|
|
import com.sk89q.worldedit.registry.state.PropertyKey;
|
2018-08-10 10:29:06 +00:00
|
|
|
import com.sk89q.worldedit.world.registry.BlockMaterial;
|
2018-06-18 07:53:33 +00:00
|
|
|
|
2019-04-07 07:41:26 +00:00
|
|
|
import javax.annotation.Nullable;
|
2019-06-28 23:00:31 +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
|
|
|
|
2019-04-07 07:41:26 +00:00
|
|
|
public interface BlockStateHolder<B extends BlockStateHolder<B>> extends FawePattern, TileEntityBlock {
|
2018-06-18 07:53:33 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the block type
|
|
|
|
*
|
|
|
|
* @return The type
|
|
|
|
*/
|
2019-01-31 15:08:58 +00:00
|
|
|
BlockType getBlockType();
|
2018-06-18 07:53:33 +00:00
|
|
|
|
|
|
|
/**
|
2018-08-12 14:03:07 +00:00
|
|
|
* Magic number (legacy uses)
|
|
|
|
* @param propertyId
|
|
|
|
* @return
|
|
|
|
*/
|
|
|
|
@Deprecated
|
2019-03-28 19:02:37 +00:00
|
|
|
B withPropertyId(int propertyId);
|
2018-08-12 14:03:07 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get combined id (legacy uses)
|
|
|
|
* @return
|
|
|
|
*/
|
|
|
|
@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
|
|
|
/**
|
|
|
|
* Get type id (legacy uses)
|
|
|
|
* @return
|
|
|
|
*/
|
|
|
|
@Deprecated
|
2019-01-31 15:08:58 +00:00
|
|
|
int getInternalBlockTypeId();
|
2018-08-12 14:03:07 +00:00
|
|
|
/**
|
|
|
|
* Get the block data (legacy uses)
|
|
|
|
* @return
|
|
|
|
*/
|
|
|
|
@Deprecated
|
|
|
|
int getInternalPropertiesId();
|
|
|
|
|
|
|
|
/**
|
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
|
2018-06-18 07:53:33 +00:00
|
|
|
* @param value The value
|
|
|
|
* @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
|
|
|
|
2018-08-12 14:03:07 +00:00
|
|
|
/**
|
|
|
|
* Returns a BlockStateHolder with the given state and value applied.
|
|
|
|
*
|
|
|
|
* @param property The property key
|
|
|
|
* @param value The value
|
|
|
|
* @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
|
|
|
|
2018-06-18 07:53:33 +00:00
|
|
|
/**
|
|
|
|
* Gets the value at the given state
|
|
|
|
*
|
2018-07-05 23:16:52 +00:00
|
|
|
* @param property The state
|
2018-06-18 07:53:33 +00:00
|
|
|
* @return The value
|
|
|
|
*/
|
2018-07-05 23:16:52 +00:00
|
|
|
<V> V getState(Property<V> property);
|
2018-06-18 07:53:33 +00:00
|
|
|
|
2018-08-12 14:03:07 +00:00
|
|
|
/**
|
|
|
|
* Gets the value at the given state
|
|
|
|
*
|
|
|
|
* @param property The state
|
|
|
|
* @return The value
|
|
|
|
*/
|
|
|
|
<V> V getState(final PropertyKey property);
|
|
|
|
|
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
|
|
|
|
*/
|
|
|
|
BaseBlock toBaseBlock(CompoundTag compoundTag);
|
|
|
|
|
2019-09-21 01:52:35 +00:00
|
|
|
@Override
|
|
|
|
default BaseBlock apply(BlockVector3 position) {
|
|
|
|
return toBaseBlock();
|
|
|
|
}
|
|
|
|
|
2019-10-23 04:23:52 +00:00
|
|
|
void applyTileEntity(OutputExtent output, int x, int y, int z);
|
|
|
|
|
2019-04-07 07:41:26 +00:00
|
|
|
/**
|
|
|
|
* Return the name of the title entity ID.
|
|
|
|
*
|
|
|
|
* @return tile entity ID, non-null string
|
|
|
|
*/
|
|
|
|
default String getNbtId() {
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns whether the block contains NBT data. {@link #getNbtData()}
|
|
|
|
* must not return null if this method returns true.
|
|
|
|
*
|
|
|
|
* @return true if there is NBT data
|
|
|
|
*/
|
|
|
|
default boolean hasNbtData() {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the object's NBT data (tile entity data). The returned tag, if
|
|
|
|
* modified in any way, should be sent to {@link #setNbtData(CompoundTag)}
|
|
|
|
* so that the instance knows of the changes. Making changes without
|
|
|
|
* calling {@link #setNbtData(CompoundTag)} could have unintended
|
|
|
|
* consequences.
|
|
|
|
*
|
|
|
|
* <p>{@link #hasNbtData()} must return true if and only if method does
|
|
|
|
* not return null.</p>
|
|
|
|
*
|
|
|
|
* @return compound tag, or null
|
|
|
|
*/
|
|
|
|
@Nullable
|
|
|
|
default CompoundTag getNbtData() {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the object's NBT data (tile entity data).
|
|
|
|
*
|
|
|
|
* @param nbtData NBT data, or null if no data
|
|
|
|
*/
|
|
|
|
default void setNbtData(@Nullable CompoundTag nbtData) {
|
|
|
|
throw new UnsupportedOperationException("State is immutable");
|
|
|
|
}
|
|
|
|
|
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()
|
|
|
|
.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 + "]";
|
|
|
|
}
|
|
|
|
}
|
2018-06-18 07:53:33 +00:00
|
|
|
}
|