Package net.luckperms.api.platform

Interface PlatformEntity

public interface PlatformEntity

Represents an entity on the server.

This does not relate directly to a "Minecraft Entity". The closest comparison is to a "CommandSender" or "CommandSource".

The various types of PlatformEntity are detailed in PlatformEntity.Type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PlatformEntity.Type	The different types of PlatformEntity

Method Summary

Modifier and Type	Method	Description
@NonNull String	getName()	Gets the name of the object
@NonNull PlatformEntity.Type	getType()	Gets the entities type.
@Nullable UUID	getUniqueId()	Gets the unique id of the entity, if it has one.

Method Details

getUniqueId

@Nullable UUID getUniqueId()

Gets the unique id of the entity, if it has one.

For players, this returns their uuid assigned by the server.

Returns:

the uuid of the object, if available

getName

@NonNull String getName()

Gets the name of the object

Returns:

the object name

getType

@NonNull PlatformEntity.Type getType()

Gets the entities type.

Returns:

the type