Package org.geysermc.geyser.api.entity

Interface EntityData

public interface EntityData

This class holds all the methods that relate to entities. Can be accessed through GeyserConnection.entities().

Method Summary

Modifier and Type	Method	Description
@Nullable GeyserEntity	byGeyserId(@org.checkerframework.checker.index.qual.NonNegative long geyserId)	Returns a GeyserEntity based on a Geyser entity id
@Nullable GeyserEntity	byJavaId(@org.checkerframework.checker.index.qual.NonNegative int javaId)	Returns a GeyserEntity to e.g.
@Nullable GeyserEntity	byUuid(@NonNull UUID javaUuid)	Returns a GeyserEntity to e.g.
@NonNull CompletableFuture<@Nullable GeyserEntity>	entityByJavaId(@org.checkerframework.checker.index.qual.NonNegative int javaId)	Deprecated. use byGeyserId(long)
boolean	isMovementLocked()	Returns whether the client's movement is currently locked.
boolean	lockMovement(boolean lock, @NonNull UUID owner)	(Un)locks the client's movement inputs, so that they cannot move.
@NonNull GeyserPlayerEntity	playerEntity()	Deprecated. Use GeyserConnection.playerEntity() instead.
void	showEmote(@NonNull GeyserPlayerEntity emoter, @NonNull String emoteId)	Deprecated. Use GeyserConnection.showEmote(GeyserPlayerEntity, String) instead.
void	switchHands()	Deprecated. use GeyserConnection.requestOffhandSwap() instead

Method Details

entityByJavaId

@Deprecated
@NonNull CompletableFuture<@Nullable GeyserEntity> entityByJavaId(@org.checkerframework.checker.index.qual.NonNegative int javaId)

Deprecated.

use byGeyserId(long)

byJavaId

@Nullable GeyserEntity byJavaId(@org.checkerframework.checker.index.qual.NonNegative int javaId)

Returns a GeyserEntity to e.g. make them play an emote.

Parameters:

javaId - the Java entity ID to look up

Returns:

a GeyserEntity if present in this connection's entity tracker

byUuid

@Nullable GeyserEntity byUuid(@NonNull UUID javaUuid)

Returns a GeyserEntity to e.g. update entity properties.

byGeyserId

@Nullable GeyserEntity byGeyserId(@org.checkerframework.checker.index.qual.NonNegative long geyserId)

Returns a GeyserEntity based on a Geyser entity id

lockMovement

boolean lockMovement(boolean lock,
 @NonNull UUID owner)

(Un)locks the client's movement inputs, so that they cannot move. To ensure that movement is only unlocked when all locks are released, you must supply a UUID with this method, and use the same UUID to unlock the camera.

Parameters:

lock - whether to lock the movement

owner - the owner of the lock

Returns:

if the movement is locked after this method call

isMovementLocked

boolean isMovementLocked()

Returns whether the client's movement is currently locked.

Returns:

whether the movement is locked

switchHands

@Deprecated(since="2.9.3")
void switchHands()

Deprecated.

use GeyserConnection.requestOffhandSwap() instead

showEmote

@Deprecated(since="2.9.3")
void showEmote(@NonNull GeyserPlayerEntity emoter,
 @NonNull String emoteId)

Deprecated.

Use GeyserConnection.showEmote(GeyserPlayerEntity, String) instead.

playerEntity

@Deprecated(since="2.9.3")
@NonNull GeyserPlayerEntity playerEntity()

Deprecated.

Use GeyserConnection.playerEntity() instead.