Class StructureBlockEntity

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

net.minecraft.world.level.block.entity.BlockEntity

net.minecraft.world.level.block.entity.StructureBlockEntity

All Implemented Interfaces:

TypedInstance<BlockEntityType<?>>, DebugValueSource, BoundingBoxRenderable, IAttachmentHolder, IBlockEntityExtension

public class StructureBlockEntity
extends BlockEntity
implements BoundingBoxRenderable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StructureBlockEntity.UpdateType

Nested classes/interfaces inherited from class AttachmentHolder

AttachmentHolder.AsField

Nested classes/interfaces inherited from interface BoundingBoxRenderable

BoundingBoxRenderable.Mode, BoundingBoxRenderable.RenderableBox

Nested classes/interfaces inherited from interface DebugValueSource

DebugValueSource.Registration, DebugValueSource.ValueGetter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private String	author
static final String	AUTHOR_TAG
private static final String	DEFAULT_AUTHOR
private static final boolean	DEFAULT_IGNORE_ENTITIES
private static final float	DEFAULT_INTEGRITY
private static final String	DEFAULT_METADATA
private static final Mirror	DEFAULT_MIRROR
private static final BlockPos	DEFAULT_POS
private static final boolean	DEFAULT_POWERED
private static final Rotation	DEFAULT_ROTATION
private static final long	DEFAULT_SEED
private static final boolean	DEFAULT_SHOW_AIR
private static final boolean	DEFAULT_SHOW_BOUNDING_BOX
private static final Vec3i	DEFAULT_SIZE
private static final boolean	DEFAULT_STRICT
private boolean	ignoreEntities
private float	integrity
static final int	MAX_OFFSET_PER_AXIS
static final int	MAX_SIZE_PER_AXIS
private String	metaData
private Mirror	mirror
private StructureMode	mode
private boolean	powered
private Rotation	rotation
private static final int	SCAN_CORNER_BLOCKS_RANGE
private long	seed
private boolean	showAir
private boolean	showBoundingBox
private boolean	strict
private @Nullable Identifier	structureName
private BlockPos	structurePos
private Vec3i	structureSize

Fields inherited from class BlockEntity

level, remove, worldPosition

Fields inherited from class AttachmentHolder

ATTACHMENTS_NBT_KEY

Constructor Summary

Constructors

Constructor	Description
StructureBlockEntity(BlockPos worldPosition, BlockState blockState)

Method Summary

Modifier and Type	Method	Description
private static Optional<BoundingBox>	calculateEnclosingBoundingBox(BlockPos pos, Stream<BlockPos> relatedCorners)
void	createdBy(LivingEntity creator)
static RandomSource	createRandom(long seed)
boolean	detectSize()
float	getIntegrity()
String	getMetaData()
Mirror	getMirror()
StructureMode	getMode()
private Stream<BlockPos>	getRelatedCorners(BlockPos corner1, BlockPos corner2)
BoundingBoxRenderable.RenderableBox	getRenderableBox()
Rotation	getRotation()
long	getSeed()
boolean	getShowAir()
boolean	getShowBoundingBox()
String	getStructureName()
BlockPos	getStructurePos()
Vec3i	getStructureSize()
private @Nullable StructureTemplate	getStructureTemplate(ServerLevel level)
ClientboundBlockEntityDataPacket	getUpdatePacket()
CompoundTag	getUpdateTag(HolderLookup.Provider registries)
boolean	hasStructureName()
boolean	isIgnoreEntities()
boolean	isPowered()
boolean	isStrict()
boolean	isStructureLoadable()
protected void	loadAdditional(ValueInput input)
boolean	loadStructureInfo(ServerLevel level)
private void	loadStructureInfo(StructureTemplate structureTemplate)
void	placeStructure(ServerLevel level)
private void	placeStructure(ServerLevel level, StructureTemplate template)
boolean	placeStructureIfSameSize(ServerLevel level)
BoundingBoxRenderable.Mode	renderMode()
protected void	saveAdditional(ValueOutput output)
boolean	saveStructure()
boolean	saveStructure(boolean saveToDisk)	Saves the template, either updating the local version or writing it to disk.
static boolean	saveStructure(ServerLevel level, Identifier structureName, BlockPos pos, Vec3i structureSize, boolean ignoreEntities, String author, boolean saveToDisk, List<Block> ignoreBlocks)
void	setIgnoreEntities(boolean ignoreEntities)
void	setIntegrity(float integrity)
void	setMetaData(String metaData)
void	setMirror(Mirror mirror)
void	setMode(StructureMode mode)
void	setPowered(boolean powered)
void	setRotation(Rotation rotation)
void	setSeed(long seed)
void	setShowAir(boolean showAir)
void	setShowBoundingBox(boolean showBoundingBox)
void	setStrict(boolean strict)
void	setStructureName(@Nullable String structureName)
void	setStructureName(@Nullable Identifier structureName)
void	setStructurePos(BlockPos structurePos)
void	setStructureSize(Vec3i structureSize)
void	unloadStructure()
private void	updateBlockState()
boolean	usedBy(Player player)

Methods inherited from class BlockEntity

addEntityType, applyComponents, applyComponentsFromItemStack, applyImplicitComponents, clearRemoved, collectComponents, collectImplicitComponents, components, fillCrashReportCategory, getAndClearAttachmentTypesToSync, getBlockPos, getBlockState, getLevel, getNameForReporting, getPersistentData, getPosFromTag, getType, hasLevel, isRemoved, isValidBlockState, loadCustomOnly, loadStatic, loadWithComponents, parseCustomNameSafe, preRemoveSideEffects, problemPath, registerDebugValues, removeComponentsFromTag, removeData, saveCustomOnly, saveCustomOnly, saveWithFullMetadata, saveWithFullMetadata, saveWithId, saveWithoutMetadata, saveWithoutMetadata, setBlockState, setChanged, setChanged, setComponents, setData, setLevel, setRemoved, syncData, triggerEvent, typeHolder

Methods inherited from class AttachmentHolder

deserializeAttachments, getData, getExistingDataOrNull, hasAttachments, hasData, serializeAttachments

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IAttachmentHolder

getData, getExistingData, getExistingData, getExistingDataOrNull, hasData, removeData, setData, syncData

Methods inherited from interface IBlockEntityExtension

getModelData, handleUpdateTag, hasCustomOutlineRendering, invalidateCapabilities, onChunkUnloaded, onDataPacket, onLoad, requestModelDataUpdate

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

SCAN_CORNER_BLOCKS_RANGE

private static final int SCAN_CORNER_BLOCKS_RANGE

See Also:

• Constant Field Values

MAX_OFFSET_PER_AXIS

public static final int MAX_OFFSET_PER_AXIS

See Also:

• Constant Field Values

MAX_SIZE_PER_AXIS

public static final int MAX_SIZE_PER_AXIS

See Also:

• Constant Field Values

AUTHOR_TAG

public static final String AUTHOR_TAG

See Also:

• Constant Field Values

DEFAULT_AUTHOR

private static final String DEFAULT_AUTHOR

See Also:

• Constant Field Values

DEFAULT_METADATA

private static final String DEFAULT_METADATA

See Also:

• Constant Field Values

DEFAULT_POS

private static final BlockPos DEFAULT_POS

DEFAULT_SIZE

private static final Vec3i DEFAULT_SIZE

DEFAULT_ROTATION

private static final Rotation DEFAULT_ROTATION

DEFAULT_MIRROR

private static final Mirror DEFAULT_MIRROR

DEFAULT_IGNORE_ENTITIES

private static final boolean DEFAULT_IGNORE_ENTITIES

See Also:

• Constant Field Values

DEFAULT_STRICT

private static final boolean DEFAULT_STRICT

See Also:

• Constant Field Values

DEFAULT_POWERED

private static final boolean DEFAULT_POWERED

See Also:

• Constant Field Values

DEFAULT_SHOW_AIR

private static final boolean DEFAULT_SHOW_AIR

See Also:

• Constant Field Values

DEFAULT_SHOW_BOUNDING_BOX

private static final boolean DEFAULT_SHOW_BOUNDING_BOX

See Also:

• Constant Field Values

DEFAULT_INTEGRITY

private static final float DEFAULT_INTEGRITY

See Also:

• Constant Field Values

DEFAULT_SEED

private static final long DEFAULT_SEED

See Also:

• Constant Field Values

structureName

private @Nullable Identifier structureName

author

private String author

metaData

private String metaData

structurePos

private BlockPos structurePos

structureSize

private Vec3i structureSize

mirror

private Mirror mirror

rotation

private Rotation rotation

mode

private StructureMode mode

ignoreEntities

private boolean ignoreEntities

strict

private boolean strict

powered

private boolean powered

showAir

private boolean showAir

showBoundingBox

private boolean showBoundingBox

integrity

private float integrity

seed

private long seed

Constructor Details

StructureBlockEntity

public StructureBlockEntity(BlockPos worldPosition,
 BlockState blockState)

Method Details

saveAdditional

protected void saveAdditional(ValueOutput output)

Overrides:

saveAdditional in class BlockEntity

loadAdditional

protected void loadAdditional(ValueInput input)

Overrides:

loadAdditional in class BlockEntity

updateBlockState

private void updateBlockState()

getUpdatePacket

public ClientboundBlockEntityDataPacket getUpdatePacket()

Overrides:

getUpdatePacket in class BlockEntity

getUpdateTag

public CompoundTag getUpdateTag(HolderLookup.Provider registries)

Overrides:

getUpdateTag in class BlockEntity

usedBy

public boolean usedBy(Player player)

getStructureName

public String getStructureName()

hasStructureName

public boolean hasStructureName()

setStructureName

public void setStructureName(@Nullable String structureName)

setStructureName

public void setStructureName(@Nullable Identifier structureName)

createdBy

public void createdBy(LivingEntity creator)

getStructurePos

public BlockPos getStructurePos()

setStructurePos

public void setStructurePos(BlockPos structurePos)

getStructureSize

public Vec3i getStructureSize()

setStructureSize

public void setStructureSize(Vec3i structureSize)

getMirror

public Mirror getMirror()

setMirror

public void setMirror(Mirror mirror)

getRotation

public Rotation getRotation()

setRotation

public void setRotation(Rotation rotation)

getMetaData

public String getMetaData()

setMetaData

public void setMetaData(String metaData)

getMode

public StructureMode getMode()

setMode

public void setMode(StructureMode mode)

isIgnoreEntities

public boolean isIgnoreEntities()

isStrict

public boolean isStrict()

setIgnoreEntities

public void setIgnoreEntities(boolean ignoreEntities)

setStrict

public void setStrict(boolean strict)

getIntegrity

public float getIntegrity()

setIntegrity

public void setIntegrity(float integrity)

getSeed

public long getSeed()

setSeed

public void setSeed(long seed)

detectSize

public boolean detectSize()

getRelatedCorners

private Stream<BlockPos> getRelatedCorners(BlockPos corner1,
 BlockPos corner2)

calculateEnclosingBoundingBox

private static Optional<BoundingBox> calculateEnclosingBoundingBox(BlockPos pos,
 Stream<BlockPos> relatedCorners)

saveStructure

public boolean saveStructure()

saveStructure

public boolean saveStructure(boolean saveToDisk)

Saves the template, either updating the local version or writing it to disk.

Returns:

true if the template was successfully saved.

saveStructure

public static boolean saveStructure(ServerLevel level,
 Identifier structureName,
 BlockPos pos,
 Vec3i structureSize,
 boolean ignoreEntities,
 String author,
 boolean saveToDisk,
 List<Block> ignoreBlocks)

createRandom

public static RandomSource createRandom(long seed)

placeStructureIfSameSize

public boolean placeStructureIfSameSize(ServerLevel level)

loadStructureInfo

public boolean loadStructureInfo(ServerLevel level)

loadStructureInfo

private void loadStructureInfo(StructureTemplate structureTemplate)

placeStructure

public void placeStructure(ServerLevel level)

getStructureTemplate

private @Nullable StructureTemplate getStructureTemplate(ServerLevel level)

placeStructure

private void placeStructure(ServerLevel level,
 StructureTemplate template)

unloadStructure

public void unloadStructure()

isStructureLoadable

public boolean isStructureLoadable()

isPowered

public boolean isPowered()

setPowered

public void setPowered(boolean powered)

getShowAir

public boolean getShowAir()

setShowAir

public void setShowAir(boolean showAir)

getShowBoundingBox

public boolean getShowBoundingBox()

setShowBoundingBox

public void setShowBoundingBox(boolean showBoundingBox)

renderMode

public BoundingBoxRenderable.Mode renderMode()

Specified by:

renderMode in interface BoundingBoxRenderable

getRenderableBox

public BoundingBoxRenderable.RenderableBox getRenderableBox()

Specified by:

getRenderableBox in interface BoundingBoxRenderable