Class Display.TextDisplay

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

net.minecraft.world.entity.Entity

net.minecraft.world.entity.Display

net.minecraft.world.entity.Display.TextDisplay

All Implemented Interfaces:

DataComponentGetter, TypedInstance<EntityType<?>>, SyncedDataHolder, DebugValueSource, ItemOwner, SlotProvider, EntityAccess, UniquelyIdentifyable, Nameable, ScoreHolder, IAttachmentHolder, IEntityExtension

Enclosing class:

Display

public static class Display.TextDisplay
extends Display

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Display.TextDisplay.Align
static final record	Display.TextDisplay.CachedInfo
static final record	Display.TextDisplay.CachedLine
static interface	Display.TextDisplay.LineSplitter
static final record	Display.TextDisplay.TextRenderState

Nested classes/interfaces inherited from class Display

Display.BillboardConstraints, Display.BlockDisplay, Display.FloatInterpolator, Display.GenericInterpolator<T>, Display.IntInterpolator, Display.ItemDisplay, Display.RenderState, Display.TextDisplay

Nested classes/interfaces inherited from class Entity

Entity.Flags, Entity.MoveFunction, Entity.MovementEmission, Entity.RemovalReason

Nested classes/interfaces inherited from class AttachmentHolder

AttachmentHolder.AsField

Nested classes/interfaces inherited from interface DebugValueSource

DebugValueSource.Registration, DebugValueSource.ValueGetter<T>

Nested classes/interfaces inherited from interface ItemOwner

ItemOwner.OffsetFromOwner

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable Display.TextDisplay.CachedInfo	clientDisplayCache
private static final EntityDataAccessor<Integer>	DATA_BACKGROUND_COLOR_ID
private static final EntityDataAccessor<Integer>	DATA_LINE_WIDTH_ID
private static final EntityDataAccessor<Byte>	DATA_STYLE_FLAGS_ID
private static final EntityDataAccessor<Component>	DATA_TEXT_ID
private static final EntityDataAccessor<Byte>	DATA_TEXT_OPACITY_ID
static final byte	FLAG_ALIGN_LEFT
static final byte	FLAG_ALIGN_RIGHT
static final byte	FLAG_SEE_THROUGH
static final byte	FLAG_SHADOW
static final byte	FLAG_USE_DEFAULT_BACKGROUND
static final int	INITIAL_BACKGROUND
private static final int	INITIAL_LINE_WIDTH
private static final byte	INITIAL_TEXT_OPACITY
private static final String	TAG_ALIGNMENT
private static final String	TAG_BACKGROUND_COLOR
private static final String	TAG_LINE_WIDTH
private static final String	TAG_SEE_THROUGH
private static final String	TAG_SHADOW
static final String	TAG_TEXT
private static final String	TAG_TEXT_OPACITY
private static final String	TAG_USE_DEFAULT_BACKGROUND
private static final it.unimi.dsi.fastutil.ints.IntSet	TEXT_RENDER_STATE_IDS
private @Nullable Display.TextDisplay.TextRenderState	textRenderState

Fields inherited from class Display

NO_BRIGHTNESS_OVERRIDE, TAG_BILLBOARD, TAG_BRIGHTNESS, TAG_GLOW_COLOR_OVERRIDE, TAG_HEIGHT, TAG_POS_ROT_INTERPOLATION_DURATION, TAG_SHADOW_RADIUS, TAG_SHADOW_STRENGTH, TAG_TRANSFORMATION, TAG_TRANSFORMATION_INTERPOLATION_DURATION, TAG_TRANSFORMATION_START_INTERPOLATION, TAG_VIEW_RANGE, TAG_WIDTH, updateRenderState

Fields inherited from class Entity

BASE_SAFE_FALL_DISTANCE, BASE_TICKS_REQUIRED_TO_FREEZE, blocksBuilding, BOARDING_COOLDOWN, boardingCooldown, CONTENTS_SLOT_INDEX, DATA_POSE, DATA_SHARED_FLAGS_ID, DEFAULT_BB_HEIGHT, DEFAULT_BB_WIDTH, DELTA_AFFECTED_BY_BLOCKS_BELOW_0_2, DELTA_AFFECTED_BY_BLOCKS_BELOW_0_5, DELTA_AFFECTED_BY_BLOCKS_BELOW_1_0, ENTITY_COUNTER, entityData, fallDistance, firstTick, FLAG_FALL_FLYING, FLAG_GLOWING, FLAG_ONFIRE, fluidHeight, flyDist, forgeFluidTypeHeight, FREEZE_HURT_FREQUENCY, horizontalCollision, hurtMarked, invulnerableTime, isInPowderSnow, mainSupportingBlockPos, MAX_ENTITY_TAG_COUNT, MAX_MOVEMENTS_HANDELED_PER_TICK, minorHorizontalCollision, moveDist, needsSync, noPhysics, portalProcess, random, stringUUID, stuckSpeedMultiplier, TAG_AIR, TAG_CUSTOM_NAME, TAG_DATA, TAG_FALL_DISTANCE, TAG_FIRE, TAG_GLOWING, TAG_ID, TAG_INVULNERABLE, TAG_MOTION, TAG_NO_GRAVITY, TAG_ON_GROUND, TAG_PASSENGERS, TAG_PORTAL_COOLDOWN, TAG_POS, TAG_ROTATION, TAG_SILENT, TAG_UUID, tickCount, TOTAL_AIR_SUPPLY, uuid, verticalCollision, verticalCollisionBelow, wasEyeInWater, wasInPowderSnow, wasTouchingWater, xo, xOld, xRotO, yo, yOld, yRotO, zo, zOld

Fields inherited from class AttachmentHolder

ATTACHMENTS_NBT_KEY

Fields inherited from interface ScoreHolder

WILDCARD, WILDCARD_NAME

Constructor Summary

Constructors

Constructor	Description
TextDisplay(EntityType<?> type, Level level)

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalSaveData(ValueOutput output)
Display.TextDisplay.CachedInfo	cacheDisplay(Display.TextDisplay.LineSplitter splitter)
private Display.TextDisplay.TextRenderState	createFreshTextRenderState()
private Display.TextDisplay.TextRenderState	createInterpolatedTextRenderState(Display.TextDisplay.TextRenderState previous, float progress)
protected void	defineSynchedData(SynchedEntityData.Builder entityData)
static Display.TextDisplay.Align	getAlign(byte flags)
private int	getBackgroundColor()
private byte	getFlags()
private int	getLineWidth()
private Component	getText()
private byte	getTextOpacity()
private static byte	loadFlag(byte flags, ValueInput input, String id, byte mask)
void	onSyncedDataUpdated(EntityDataAccessor<?> accessor)
protected void	readAdditionalSaveData(ValueInput input)
private void	setBackgroundColor(int color)
private void	setFlags(byte flags)
private void	setLineWidth(int width)
private void	setText(Component text)
private void	setTextOpacity(byte opacity)
private static void	storeFlag(byte flags, ValueOutput output, String id, byte mask)
@Nullable Display.TextDisplay.TextRenderState	textRenderState()
protected void	updateRenderSubState(boolean shouldInterpolate, float progress)

Methods inherited from class Display

affectedByCulling, calculateInterpolationProgress, getBoundingBoxForCulling, getInterpolation, getPistonPushReaction, getTeamColor, hurtServer, isIgnoringBlockTriggers, renderState, setPos, shouldRenderAtSqrDistance, tick

Methods inherited from class Entity

absSnapRotationTo, absSnapTo, absSnapTo, addDeltaMovement, addPassenger, addTag, adjustSpawnLocation, animateHurt, applyComponentsFromItemStack, applyEffectsFromBlocks, applyEffectsFromBlocks, applyGravity, applyImplicitComponent, applyImplicitComponentIfPresent, applyImplicitComponents, awardKillScore, baseTick, blockPosition, broadcastToPlayer, calculateUpVector, calculateViewVector, canAddPassenger, canBeCollidedWith, canBeHitByProjectile, canCollideWith, canControlVehicle, canFreeze, canInteractWithLevel, canRide, canSimulateMovement, canSpawnSprintParticle, canSprint, canTeleport, canTrample, canUsePortal, captureDrops, captureDrops, castComponentValue, causeFallDamage, checkBelowWorld, checkDespawn, checkFallDamage, checkFallDistanceAccumulation, checkSupportingBlock, chunkPosition, clearFire, clearFreeze, clearMovementThisTick, closerThan, closerThan, collectAllColliders, collideBoundingBox, collidedWithFluid, collidedWithShapeMovingFrom, computeSpeed, considersEntityAsAlly, copyPosition, couldAcceptPassenger, countPlayerPassengers, createCommandSourceStackForNameResolution, createHoverEvent, damageSources, dampensVibrations, deflection, discard, dismountsUnderwater, dismountTo, displayFireAnimation, distanceTo, distanceToSqr, distanceToSqr, distanceToSqr, doCheckFallDamage, doWaterSplashEffect, dropAllLeashConnections, ejectPassengers, entityTags, equals, extinguishFire, fillCrashReportCategory, fireImmune, fixupDimensions, forceSetRotation, fudgePositionAfterSizeChange, gameEvent, gameEvent, get, getAddEntityPacket, getAirSupply, getAttachments, getAvailableSpaceBelow, getBbHeight, getBbWidth, getBlockExplosionResistance, getBlockJumpFactor, getBlockPosBelowThatAffectsMyMovement, getBlockSpeedFactor, getBlockStateOn, getBlockStateOnLegacy, getBlockX, getBlockY, getBlockZ, getBoundingBox, getCapability, getCapability, getCollisionHorizontalEscapeVector, getControlledVehicle, getControllingPassenger, getCustomName, getDefaultGravity, getDefaultPassengerAttachmentPoint, getDeltaMovement, getDimensionChangingDelay, getDimensions, getDirection, getDismountLocationForPassenger, getDisplayName, getEncodeId, getEntityData, getEyeHeight, getEyeHeight, getEyeInFluidType, getEyePosition, getEyePosition, getEyeY, getFireImmuneTicks, getFirstPassenger, getFluidHeight, getFluidJumpThreshold, getFluidTypeHeight, getForward, getGravity, getHandHoldingItemAngle, getHeadLookAngle, getId, getInBlockState, getIndirectPassengers, getInputVector, getKnownMovement, getKnownSpeed, getLightLevelDependentMagicValue, getLightProbePosition, getLookAngle, getLootTable, getMaxAirSupply, getMaxFallDistance, getMaxHeightFluidType, getMotionDirection, getMovementEmission, getName, getNearestViewDirection, getOnPos, getOnPos, getOnPosLegacy, getPassengerAttachmentPoint, getPassengerRidingPosition, getPassengers, getPassengersAndSelf, getPercentFrozen, getPersistentData, getPickRadius, getPickResult, getPortalCooldown, getPose, getPosition, getPositionCodec, getPreciseBodyRotation, getPrimaryStepSoundBlockPos, getQuadLeashHolderOffsets, getRandom, getRandomX, getRandomY, getRandomZ, getRelativePortalPosition, getRemainingFireTicks, getRemovalReason, getRequiresPrecisePosition, getRootVehicle, getRopeHoldPosition, getRotationVector, getScoreboardName, getSelfAndPassengers, getSharedFlag, getSlot, getSoundSource, getStringUUID, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTeam, getTicksFrozen, getTicksRequiredToFreeze, getType, getTypeName, getUpVector, getUUID, getVehicle, getVehicleAttachmentPoint, getViewScale, getViewVector, getViewXRot, getViewYRot, getVisualRotationYInDegrees, getWeaponItem, getX, getX, getXRot, getXRot, getY, getY, getYHeadRot, getYRot, getYRot, getZ, getZ, handleDamageEvent, handleEntityEvent, handleOnAboveBubbleColumn, handleOnInsideBubbleColumn, handlePortal, hasControllingPassenger, hasCustomName, hasExactlyOnePlayerPassenger, hasGlowingTag, hashCode, hasIndirectPassenger, hasMovedHorizontallyRecently, hasPassenger, hasPassenger, hasPose, hurt, hurtClient, hurtOrSimulate, igniteForSeconds, igniteForTicks, ignoreExplosion, interact, is, isAddedToLevel, isAffectedByBlocks, isAlive, isAlliedTo, isAlliedTo, isAlwaysTicking, isAttackable, isClientAuthoritative, isColliding, isCrouching, isCurrentlyGlowing, isCustomNameVisible, isDescending, isDiscrete, isEffectiveAi, isEyeInFluid, isFlapping, isFlyingVehicle, isFree, isFreezing, isFullyFrozen, isHorizontalCollisionMinor, isInClouds, isInFluidType, isInFluidType, isInLava, isInLiquid, isInRain, isInShallowWater, isInterpolating, isInvisible, isInvisibleTo, isInvulnerable, isInvulnerableToBase, isInWall, isInWater, isInWaterOrRain, isLocalClientAuthoritative, isLocalInstanceAuthoritative, isNoGravity, isOnFire, isOnPortalCooldown, isOnRails, isPassenger, isPassengerOfSameVehicle, isPickable, isPushable, isPushedByFluid, isRemoved, isShiftKeyDown, isSilent, isSpectator, isSprinting, isSteppingCarefully, isSupportedBy, isSuppressingBounce, isSwimming, isUnderWater, isVehicle, isVisuallyCrawling, isVisuallySwimming, kill, killedEntity, lavaHurt, lavaIgnite, lerpHeadTo, lerpMotion, lerpPositionAndRotationStep, level, limitPistonMovement, load, lookAt, makeBoundingBox, makeBoundingBox, makeStuckInBlock, markHurt, maxUpStep, maybeBackOffFromEdge, mayInteract, mirror, move, moveOrInterpolateTo, moveOrInterpolateTo, moveOrInterpolateTo, moveOrInterpolateTo, moveRelative, moveTowardsClosestSpace, nextStep, notifyLeasheeRemoved, notifyLeashHolder, oldPosition, onAboveBubbleColumn, onAddedToLevel, onBelowWorld, onClientRemoval, onExplosionHit, onFlap, onGround, onInsideBlock, onInsideBubbleColumn, onPassengerTurned, onRemoval, onRemovedFromLevel, onSyncedDataUpdated, pick, placePortalTicket, playCombinationStepSounds, playEntityOnFireExtinguishedSound, playerTouch, playMuffledStepSound, playSound, playSound, playStepSound, playSwimSound, position, positionRider, positionRider, problemPath, processFlappingMovement, processPortalCooldown, propagateFallToPassengers, push, push, push, reapplyPosition, recreateFromPacket, refreshDimensions, registerDebugValues, registryAccess, remove, removeAfterChangingDimensions, removeLatestMovementRecording, removePassenger, removeTag, removeVehicle, repositionEntityAfterLoad, resetFallDistance, restoreFrom, revive, rideTick, rotate, save, saveAsPassenger, saveWithoutId, sendBubbleColumnParticles, setAirSupply, setAsInsidePortal, setBoundingBox, setComponent, setCustomName, setCustomNameVisible, setData, setDeltaMovement, setDeltaMovement, setFluidTypeHeight, setGlowingTag, setId, setInvisible, setInvulnerable, setIsInPowderSnow, setLevel, setLevelCallback, setNoGravity, setOldPos, setOldPosAndRot, setOldPosAndRot, setOldRot, setOnGround, setOnGroundWithMovement, setOnGroundWithMovement, setPortalCooldown, setPortalCooldown, setPos, setPose, setPosRaw, setRemainingFireTicks, setRemoved, setRequiresPrecisePosition, setRot, setSharedFlag, setSharedFlagOnFire, setShiftKeyDown, setSilent, setSprinting, setSwimming, setTicksFrozen, setUUID, setViewScale, setXRot, setYBodyRot, setYHeadRot, setYRot, shearOffAllLeashConnections, shouldBeSaved, shouldBlockExplode, shouldPlayLavaHurtSound, shouldRender, shouldShowName, showVehicleHealth, skipAttackInteraction, snapTo, snapTo, snapTo, snapTo, snapTo, spawnAtLocation, spawnAtLocation, spawnAtLocation, spawnAtLocation, spawnSprintParticle, startRiding, startRiding, startSeenByPlayer, stopRiding, stopSeenByPlayer, supportQuadLeashAsHolder, syncData, syncPacketPositionCodec, teleport, teleportRelative, teleportSetPosition, teleportSetPosition, teleportSpectators, teleportTo, teleportTo, thunderHit, toString, touchingUnloadedChunk, trackingPosition, turn, typeHolder, unRide, unsetRemoved, updateDataBeforeSync, updateDynamicGameEventListener, updateFluidHeightAndDoCanPushEntityFluidPushing, updateFluidHeightAndDoFluidPushing, updateFluidHeightAndDoFluidPushing, updateInWaterStateAndDoFluidPushing, updateInWaterStateAndDoWaterCurrentPushing, updateInWaterStateAndDoWaterCurrentPushing, updateSwimming, waterSwimSound

Methods inherited from class AttachmentHolder

deserializeAttachments, getData, getExistingDataOrNull, hasAttachments, hasData, removeData, serializeAttachments

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DataComponentGetter

get, getOrDefault, getOrDefault, getTyped, has, has

Methods inherited from interface IAttachmentHolder

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

Methods inherited from interface IEntityExtension

canBeRiddenUnderFluidType, canFluidExtinguish, canHydrateInFluidType, canRiderInteract, canStartSwimming, canSwimInFluidType, copyAttachmentsFrom, getClassification, getFluidFallDistanceModifier, getFluidMotionScale, getParts, getSoundFromFluidType, hasCustomOutlineRendering, isEyeInFluidType, isInFluidType, isInFluidType, isInFluidType, isMultipartEntity, isPushedByFluid, sendPairingData, shouldRiderSit

Methods inherited from interface ItemOwner

asLivingEntity

Methods inherited from interface Nameable

getPlainTextName

Methods inherited from interface ScoreHolder

getFeedbackDisplayName

Methods inherited from interface SlotProvider

getSlotsFromRange

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

TAG_TEXT

public static final String TAG_TEXT

See Also:

• Constant Field Values

TAG_LINE_WIDTH

private static final String TAG_LINE_WIDTH

See Also:

• Constant Field Values

TAG_TEXT_OPACITY

private static final String TAG_TEXT_OPACITY

See Also:

• Constant Field Values

TAG_BACKGROUND_COLOR

private static final String TAG_BACKGROUND_COLOR

See Also:

• Constant Field Values

TAG_SHADOW

private static final String TAG_SHADOW

See Also:

• Constant Field Values

TAG_SEE_THROUGH

private static final String TAG_SEE_THROUGH

See Also:

• Constant Field Values

TAG_USE_DEFAULT_BACKGROUND

private static final String TAG_USE_DEFAULT_BACKGROUND

See Also:

• Constant Field Values

TAG_ALIGNMENT

private static final String TAG_ALIGNMENT

See Also:

• Constant Field Values

FLAG_SHADOW

public static final byte FLAG_SHADOW

See Also:

• Constant Field Values

FLAG_SEE_THROUGH

public static final byte FLAG_SEE_THROUGH

See Also:

• Constant Field Values

FLAG_USE_DEFAULT_BACKGROUND

public static final byte FLAG_USE_DEFAULT_BACKGROUND

See Also:

• Constant Field Values

FLAG_ALIGN_LEFT

public static final byte FLAG_ALIGN_LEFT

See Also:

• Constant Field Values

FLAG_ALIGN_RIGHT

public static final byte FLAG_ALIGN_RIGHT

See Also:

• Constant Field Values

INITIAL_TEXT_OPACITY

private static final byte INITIAL_TEXT_OPACITY

See Also:

• Constant Field Values

INITIAL_BACKGROUND

public static final int INITIAL_BACKGROUND

See Also:

• Constant Field Values

INITIAL_LINE_WIDTH

private static final int INITIAL_LINE_WIDTH

See Also:

• Constant Field Values

DATA_TEXT_ID

private static final EntityDataAccessor<Component> DATA_TEXT_ID

DATA_LINE_WIDTH_ID

private static final EntityDataAccessor<Integer> DATA_LINE_WIDTH_ID

DATA_BACKGROUND_COLOR_ID

private static final EntityDataAccessor<Integer> DATA_BACKGROUND_COLOR_ID

DATA_TEXT_OPACITY_ID

private static final EntityDataAccessor<Byte> DATA_TEXT_OPACITY_ID

DATA_STYLE_FLAGS_ID

private static final EntityDataAccessor<Byte> DATA_STYLE_FLAGS_ID

TEXT_RENDER_STATE_IDS

private static final it.unimi.dsi.fastutil.ints.IntSet TEXT_RENDER_STATE_IDS

clientDisplayCache

private @Nullable Display.TextDisplay.CachedInfo clientDisplayCache

textRenderState

private @Nullable Display.TextDisplay.TextRenderState textRenderState

Constructor Details

TextDisplay

public TextDisplay(EntityType<?> type,
 Level level)

Method Details

defineSynchedData

protected void defineSynchedData(SynchedEntityData.Builder entityData)

Overrides:

defineSynchedData in class Display

onSyncedDataUpdated

public void onSyncedDataUpdated(EntityDataAccessor<?> accessor)

Specified by:

onSyncedDataUpdated in interface SyncedDataHolder

Overrides:

onSyncedDataUpdated in class Display

getText

private Component getText()

setText

private void setText(Component text)

getLineWidth

private int getLineWidth()

setLineWidth

private void setLineWidth(int width)

getTextOpacity

private byte getTextOpacity()

setTextOpacity

private void setTextOpacity(byte opacity)

getBackgroundColor

private int getBackgroundColor()

setBackgroundColor

private void setBackgroundColor(int color)

getFlags

private byte getFlags()

setFlags

private void setFlags(byte flags)

loadFlag

private static byte loadFlag(byte flags,
 ValueInput input,
 String id,
 byte mask)

readAdditionalSaveData

protected void readAdditionalSaveData(ValueInput input)

Overrides:

readAdditionalSaveData in class Display

storeFlag

private static void storeFlag(byte flags,
 ValueOutput output,
 String id,
 byte mask)

addAdditionalSaveData

protected void addAdditionalSaveData(ValueOutput output)

Overrides:

addAdditionalSaveData in class Display

updateRenderSubState

protected void updateRenderSubState(boolean shouldInterpolate,
 float progress)

Specified by:

updateRenderSubState in class Display

textRenderState

public @Nullable Display.TextDisplay.TextRenderState textRenderState()

createFreshTextRenderState

private Display.TextDisplay.TextRenderState createFreshTextRenderState()

createInterpolatedTextRenderState

private Display.TextDisplay.TextRenderState createInterpolatedTextRenderState(Display.TextDisplay.TextRenderState previous,
 float progress)

cacheDisplay

public Display.TextDisplay.CachedInfo cacheDisplay(Display.TextDisplay.LineSplitter splitter)

getAlign

public static Display.TextDisplay.Align getAlign(byte flags)