Class SignBlockEntity

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

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

net.minecraft.world.level.block.entity.SignBlockEntity

All Implemented Interfaces:

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

Direct Known Subclasses:

HangingSignBlockEntity

public class SignBlockEntity
extends BlockEntity

Nested Class Summary

Nested classes/interfaces inherited from class AttachmentHolder

AttachmentHolder.AsField

Nested classes/interfaces inherited from interface DebugValueSource

DebugValueSource.Registration, DebugValueSource.ValueGetter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private SignText	backText
private static final boolean	DEFAULT_IS_WAXED
private SignText	frontText
private boolean	isWaxed
private static final org.slf4j.Logger	LOGGER
private static final int	MAX_TEXT_LINE_WIDTH
private @Nullable UUID	playerWhoMayEdit
private static final int	TEXT_LINE_HEIGHT

Fields inherited from class BlockEntity

level, remove, worldPosition

Fields inherited from class AttachmentHolder

ATTACHMENTS_NBT_KEY

Constructor Summary

Constructors

Constructor	Description
SignBlockEntity(BlockPos worldPosition, BlockState blockState)
SignBlockEntity(BlockEntityType<? extends SignBlockEntity> type, BlockPos worldPosition, BlockState blockState)

Method Summary

Modifier and Type	Method	Description
boolean	canExecuteClickCommands(boolean isFrontText, Player player)
private void	clearInvalidPlayerWhoMayEdit(SignBlockEntity signBlockEntity, Level level, UUID playerWhoMayEdit)
private static CommandSourceStack	createCommandSourceStack(@Nullable Player player, ServerLevel level, BlockPos pos)
protected SignText	createDefaultSignText()
boolean	executeClickCommandsIfPresent(ServerLevel level, Player player, BlockPos pos, boolean isFrontText)
SignText	getBackText()
SignText	getFrontText()
int	getMaxTextLineWidth()
@Nullable UUID	getPlayerWhoMayEdit()
SoundEvent	getSignInteractionFailedSoundEvent()
SignText	getText(boolean isFrontText)
int	getTextLineHeight()
ClientboundBlockEntityDataPacket	getUpdatePacket()
CompoundTag	getUpdateTag(HolderLookup.Provider registries)
boolean	isFacingFrontText(Player player)
boolean	isWaxed()
protected void	loadAdditional(ValueInput input)
private Component	loadLine(Component component)
private SignText	loadLines(SignText data)
private void	markUpdated()
boolean	playerIsTooFarAwayToEdit(UUID player)
protected void	saveAdditional(ValueOutput output)
void	setAllowedPlayerEditor(@Nullable UUID playerUUID)
private boolean	setBackText(SignText text)
private boolean	setFrontText(SignText text)
private SignText	setMessages(Player player, List<FilteredText> lines, SignText text)
boolean	setText(SignText text, boolean isFrontText)
boolean	setWaxed(boolean isWaxed)
static void	tick(Level level, BlockPos blockPos, BlockState blockState, SignBlockEntity signBlockEntity)
void	updateSignText(Player player, boolean frontText, List<FilteredText> lines)
boolean	updateText(UnaryOperator<SignText> function, boolean isFrontText)

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

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

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

MAX_TEXT_LINE_WIDTH

private static final int MAX_TEXT_LINE_WIDTH

See Also:

• Constant Field Values

TEXT_LINE_HEIGHT

private static final int TEXT_LINE_HEIGHT

See Also:

• Constant Field Values

DEFAULT_IS_WAXED

private static final boolean DEFAULT_IS_WAXED

See Also:

• Constant Field Values

playerWhoMayEdit

private @Nullable UUID playerWhoMayEdit

frontText

private SignText frontText

backText

private SignText backText

isWaxed

private boolean isWaxed

Constructor Details

SignBlockEntity

public SignBlockEntity(BlockPos worldPosition,
 BlockState blockState)

SignBlockEntity

public SignBlockEntity(BlockEntityType<? extends SignBlockEntity> type,
 BlockPos worldPosition,
 BlockState blockState)

Method Details

createDefaultSignText

protected SignText createDefaultSignText()

isFacingFrontText

public boolean isFacingFrontText(Player player)

getText

public SignText getText(boolean isFrontText)

getFrontText

public SignText getFrontText()

getBackText

public SignText getBackText()

getTextLineHeight

public int getTextLineHeight()

getMaxTextLineWidth

public int getMaxTextLineWidth()

saveAdditional

protected void saveAdditional(ValueOutput output)

Overrides:

saveAdditional in class BlockEntity

loadAdditional

protected void loadAdditional(ValueInput input)

Overrides:

loadAdditional in class BlockEntity

loadLines

private SignText loadLines(SignText data)

loadLine

private Component loadLine(Component component)

updateSignText

public void updateSignText(Player player,
 boolean frontText,
 List<FilteredText> lines)

updateText

public boolean updateText(UnaryOperator<SignText> function,
 boolean isFrontText)

setMessages

private SignText setMessages(Player player,
 List<FilteredText> lines,
 SignText text)

setText

public boolean setText(SignText text,
 boolean isFrontText)

setBackText

private boolean setBackText(SignText text)

setFrontText

private boolean setFrontText(SignText text)

canExecuteClickCommands

public boolean canExecuteClickCommands(boolean isFrontText,
 Player player)

executeClickCommandsIfPresent

public boolean executeClickCommandsIfPresent(ServerLevel level,
 Player player,
 BlockPos pos,
 boolean isFrontText)

createCommandSourceStack

private static CommandSourceStack createCommandSourceStack(@Nullable Player player,
 ServerLevel level,
 BlockPos pos)

getUpdatePacket

public ClientboundBlockEntityDataPacket getUpdatePacket()

Overrides:

getUpdatePacket in class BlockEntity

getUpdateTag

public CompoundTag getUpdateTag(HolderLookup.Provider registries)

Overrides:

getUpdateTag in class BlockEntity

setAllowedPlayerEditor

public void setAllowedPlayerEditor(@Nullable UUID playerUUID)

getPlayerWhoMayEdit

public @Nullable UUID getPlayerWhoMayEdit()

markUpdated

private void markUpdated()

isWaxed

public boolean isWaxed()

setWaxed

public boolean setWaxed(boolean isWaxed)

playerIsTooFarAwayToEdit

public boolean playerIsTooFarAwayToEdit(UUID player)

tick

public static void tick(Level level,
 BlockPos blockPos,
 BlockState blockState,
 SignBlockEntity signBlockEntity)

clearInvalidPlayerWhoMayEdit

private void clearInvalidPlayerWhoMayEdit(SignBlockEntity signBlockEntity,
 Level level,
 UUID playerWhoMayEdit)

getSignInteractionFailedSoundEvent

public SoundEvent getSignInteractionFailedSoundEvent()