Package org.geysermc.geyser.entity.type.player

Class PlayerEntity

java.lang.Object

org.geysermc.geyser.entity.type.Entity

org.geysermc.geyser.entity.type.LivingEntity

org.geysermc.geyser.entity.type.player.PlayerEntity

All Implemented Interfaces:

org.geysermc.geyser.api.entity.type.GeyserEntity, org.geysermc.geyser.api.entity.type.player.GeyserPlayerEntity

Direct Known Subclasses:

SessionPlayerEntity, SkullPlayerEntity

public class PlayerEntity
extends LivingEntity
implements org.geysermc.geyser.api.entity.type.player.GeyserPlayerEntity

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<org.cloudburstmc.protocol.bedrock.data.AbilityLayer>	BASE_ABILITY_LAYER
static final float	SNEAKING_POSE_HEIGHT

Fields inherited from class org.geysermc.geyser.entity.type.LivingEntity

body, boots, chestplate, equipment, hand, health, helmet, leggings, maxHealth, offhand, saddle

Fields inherited from class org.geysermc.geyser.entity.type.Entity

definition, dirtyMetadata, entityId, flags, geyserId, headYaw, motion, nametag, onGround, passengers, pitch, position, propertyManager, session, silent, uuid, valid, vehicle, yaw

Constructor Summary

Constructors

Constructor	Description
PlayerEntity(GeyserSession session, int entityId, long geyserId, UUID uuid, org.cloudburstmc.math.vector.Vector3f position, org.cloudburstmc.math.vector.Vector3f motion, float yaw, float pitch, float headYaw, String username, @Nullable String texturesProperty)

Method Summary

Modifier and Type	Method	Description
void	despawnEntity()	Despawns the entity
@Nullable org.cloudburstmc.math.vector.Vector3i	getBedPosition()
String	getCachedScore()
String	getDisplayName()
@Nullable ParrotEntity	getLeftParrot()	Saves the parrot currently on the player's left shoulder; otherwise null
@Nullable ParrotEntity	getRightParrot()	Saves the parrot currently on the player's right shoulder; otherwise null
UUID	getTabListUuid()
@Nullable String	getTexturesProperty()	The textures property from the GameProfile.
String	getUsername()
protected void	initializeMetadata()	Called on entity spawn.
boolean	isListed()	Whether this player is currently listed.
boolean	isScoreVisible()
void	moveAbsolute(org.cloudburstmc.math.vector.Vector3f position, float yaw, float pitch, float headYaw, boolean isOnGround, boolean teleported)
void	moveRelative(double relX, double relY, double relZ, float yaw, float pitch, float headYaw, boolean isOnGround)
org.cloudburstmc.math.vector.Vector3f	position()
void	resetMetadata()
protected void	scoreVisibility(boolean show)
void	sendPlayer()
void	setAbsorptionHearts(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.FloatEntityMetadata entityMetadata)
@Nullable org.cloudburstmc.math.vector.Vector3i	setBedPosition(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<Optional<org.cloudburstmc.math.vector.Vector3i>,?> entityMetadata)
void	setBelowNameText(String text)
void	setCachedScore(String cachedScore)
void	setDimensionsFromPose(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.Pose pose)	Set the height and width of the entity's bounding box
void	setDisplayName(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<Optional<net.kyori.adventure.text.Component>,?> entityMetadata)
void	setDisplayNameVisible(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.BooleanEntityMetadata entityMetadata)
void	setLeftParrot(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<org.cloudburstmc.nbt.NbtMap,?> entityMetadata)
void	setListed(boolean listed)	Whether this player is currently listed.
protected void	setNametag(@Nullable String nametag, boolean fromDisplayName)
protected void	setParrot(org.cloudburstmc.nbt.NbtMap tag, boolean isLeft)	Sets the parrot occupying the shoulder.
void	setPosition(org.cloudburstmc.math.vector.Vector3f position)
void	setRightParrot(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<org.cloudburstmc.nbt.NbtMap,?> entityMetadata)
void	setScoreVisible(boolean scoreVisible)
void	setSkinVisibility(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.ByteEntityMetadata entityMetadata)
void	setTexturesProperty(@Nullable String texturesProperty)	The textures property from the GameProfile.
void	setUsername(String username)
void	spawnEntity()
String	teamIdentifier()

Methods inherited from class org.geysermc.geyser.entity.type.LivingEntity

calculateAttribute, canUseSlot, checkInteractWithNameTag, createHealthAttribute, getBody, getBoots, getChestplate, getEquipment, getHand, getHelmet, getLeggings, getOffhand, getSaddle, hasBodyArmor, hasShield, interact, isAlive, isMaxFrozenState, isShaking, setBody, setBoots, setBoundingBoxHeight, setBoundingBoxWidth, setChestplate, setEquipment, setFreezing, setHand, setHealth, setHelmet, setLeggings, setLivingEntityFlags, setMaxFrozenState, setMaxHealth, setOffhand, setParticles, setSaddle, setScale, setSpinAttack, switchHands, updateArmor, updateAttribute, updateBedrockAttributes, updateMainHand, updateNametag, updateOffHand, updateSaddled, useArmSwingAttack

Methods inherited from class org.geysermc.geyser.entity.type.Entity

addAdditionalSpawnData, getBedrockRotation, getBoundingBoxHeight, getBoundingBoxWidth, getDefinition, getDirtyMetadata, getEntityId, getFlag, getGeyserId, getHeadYaw, getMaxAir, getMotion, getNametag, getPassengers, getPitch, getPosition, getPropertyManager, getSession, getUuid, getVehicle, getYaw, hasLeashesToDrop, interactAt, isOnGround, isSilent, isValid, javaId, moveAbsolute, moveRelative, playEntityEvent, playEntityEvent, setAir, setAirSupply, setClientSideSilent, setDefinition, setEntityId, setFlag, setFlags, setFlagsDirty, setGliding, setGravity, setHeadYaw, setInvisible, setMotion, setOnGround, setPassengers, setPitch, setPose, setRiderSeatPosition, setSilent, setSneaking, setSprinting, setUuid, setValid, setVehicle, setYaw, standardDisplayName, teleport, testInteraction, updateBedrockEntityProperties, updateBedrockMetadata, updateHeadLookRotation, updateInteractiveTag, updateMountOffset, updateNametag, updatePassengerOffsets, updatePositionAndRotation, updateRotation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.geysermc.geyser.api.entity.type.GeyserEntity

javaId

Field Details

SNEAKING_POSE_HEIGHT

public static final float SNEAKING_POSE_HEIGHT

See Also:

• Constant Field Values

BASE_ABILITY_LAYER

protected static final List<org.cloudburstmc.protocol.bedrock.data.AbilityLayer> BASE_ABILITY_LAYER

Constructor Details

PlayerEntity

public PlayerEntity(GeyserSession session,
 int entityId,
 long geyserId,
 UUID uuid,
 org.cloudburstmc.math.vector.Vector3f position,
 org.cloudburstmc.math.vector.Vector3f motion,
 float yaw,
 float pitch,
 float headYaw,
 String username,
 @Nullable String texturesProperty)

Method Details

initializeMetadata

protected void initializeMetadata()

Description copied from class: Entity

Called on entity spawn. Used to populate the entity metadata and flags with default values.

Overrides:

initializeMetadata in class LivingEntity

spawnEntity

public void spawnEntity()

Overrides:

spawnEntity in class Entity

despawnEntity

public void despawnEntity()

Description copied from class: Entity

Despawns the entity

Overrides:

despawnEntity in class Entity

resetMetadata

public void resetMetadata()

sendPlayer

public void sendPlayer()

moveAbsolute

public void moveAbsolute(org.cloudburstmc.math.vector.Vector3f position,
 float yaw,
 float pitch,
 float headYaw,
 boolean isOnGround,
 boolean teleported)

Overrides:

moveAbsolute in class Entity

moveRelative

public void moveRelative(double relX,
 double relY,
 double relZ,
 float yaw,
 float pitch,
 float headYaw,
 boolean isOnGround)

Overrides:

moveRelative in class LivingEntity

setPosition

public void setPosition(org.cloudburstmc.math.vector.Vector3f position)

Overrides:

setPosition in class Entity

setBedPosition

public @Nullable org.cloudburstmc.math.vector.Vector3i setBedPosition(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<Optional<org.cloudburstmc.math.vector.Vector3i>,?> entityMetadata)

Overrides:

setBedPosition in class LivingEntity

setAbsorptionHearts

public void setAbsorptionHearts(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.FloatEntityMetadata entityMetadata)

setSkinVisibility

public void setSkinVisibility(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.ByteEntityMetadata entityMetadata)

setLeftParrot

public void setLeftParrot(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<org.cloudburstmc.nbt.NbtMap,?> entityMetadata)

setRightParrot

public void setRightParrot(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<org.cloudburstmc.nbt.NbtMap,?> entityMetadata)

setParrot

protected void setParrot(org.cloudburstmc.nbt.NbtMap tag,
 boolean isLeft)

Sets the parrot occupying the shoulder. Bedrock Edition requires a full entity whereas Java Edition just spawns it from the NBT data provided

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Entity

setDisplayName

public void setDisplayName(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<Optional<net.kyori.adventure.text.Component>,?> entityMetadata)

Overrides:

setDisplayName in class Entity

teamIdentifier

public String teamIdentifier()

Overrides:

teamIdentifier in class Entity

setNametag

protected void setNametag(@Nullable String nametag,
 boolean fromDisplayName)

Overrides:

setNametag in class Entity

setDisplayNameVisible

public void setDisplayNameVisible(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.BooleanEntityMetadata entityMetadata)

Overrides:

setDisplayNameVisible in class Entity

setBelowNameText

public void setBelowNameText(String text)

scoreVisibility

protected void scoreVisibility(boolean show)

Overrides:

scoreVisibility in class Entity

setDimensionsFromPose

public void setDimensionsFromPose(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.Pose pose)

Description copied from class: Entity

Set the height and width of the entity's bounding box

Overrides:

setDimensionsFromPose in class LivingEntity

getTabListUuid

public UUID getTabListUuid()

Returns:

the UUID that should be used when dealing with Bedrock's tab list.

position

public org.cloudburstmc.math.vector.Vector3f position()

Specified by:

position in interface org.geysermc.geyser.api.entity.type.player.GeyserPlayerEntity

getUsername

public String getUsername()

getCachedScore

public String getCachedScore()

isScoreVisible

public boolean isScoreVisible()

getTexturesProperty

public @Nullable String getTexturesProperty()

The textures property from the GameProfile.

getBedPosition

public @Nullable org.cloudburstmc.math.vector.Vector3i getBedPosition()

getLeftParrot

public @Nullable ParrotEntity getLeftParrot()

Saves the parrot currently on the player's left shoulder; otherwise null

getRightParrot

public @Nullable ParrotEntity getRightParrot()

Saves the parrot currently on the player's right shoulder; otherwise null

isListed

public boolean isListed()

Whether this player is currently listed.

setUsername

public void setUsername(String username)

setCachedScore

public void setCachedScore(String cachedScore)

setScoreVisible

public void setScoreVisible(boolean scoreVisible)

setTexturesProperty

public void setTexturesProperty(@Nullable String texturesProperty)

The textures property from the GameProfile.

setListed

public void setListed(boolean listed)

Whether this player is currently listed.