org.spongepowered.api.entity.living.player

Interface User

All Superinterfaces:

ArmorEquipable, Carrier, CompositeValueStore<DataHolder,DataManipulator<?,?>>, Contextual, DataHolder, DataSerializable, Equipable, Identifiable, PropertyHolder, Subject, Tamer, ValueContainer<DataHolder>

All Known Subinterfaces:

Player

public interface User
extends DataHolder, ArmorEquipable, Tamer, Subject

A User is the data usually associated with a Player that is persisted across server restarts. This is in contrast to Player which represents the in-game entity associated with an online User.

Method Summary

Modifier and Type	Method and Description
Inventory	getEnderChestInventory() Gets the Inventory available for this Player's shared EnderChest contents.
String	getName() Gets the player's last known username.
Optional<Player>	getPlayer() Gets the related online Player if the player is in fact online.
com.flowpowered.math.vector.Vector3d	getPosition() Gets the position of this User
GameProfile	getProfile() Gets the associated GameProfile of this player.
com.flowpowered.math.vector.Vector3d	getRotation() Gets the rotation.
default StatisticData	getStatisticData() Gets a copy of the StatisticData for this user.
Optional<UUID>	getWorldUniqueId() Gets the World UUID of this User.
boolean	isOnline() Checks if this user is online or not.
boolean	setLocation(com.flowpowered.math.vector.Vector3d position, UUID world) Sets the position and world of this User.
void	setRotation(com.flowpowered.math.vector.Vector3d rotation) Sets the rotation of this entity.

Methods inherited from interface org.spongepowered.api.data.DataHolder

setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.entity.ArmorEquipable

getBoots, getChestplate, getHelmet, getItemInHand, getLeggings, setBoots, setChestplate, setHelmet, setItemInHand, setLeggings

Methods inherited from interface org.spongepowered.api.entity.Equipable

canEquip, canEquip, equip, getEquipped

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Methods inherited from interface org.spongepowered.api.item.inventory.Carrier

getInventory

Methods inherited from interface org.spongepowered.api.service.permission.Subject

asSubjectReference, getCommandSource, getContainingCollection, getOption, getOption, getParents, getParents, getPermissionValue, getSubjectData, getTransientSubjectData, hasPermission, hasPermission, isChildOf, isChildOf, isSubjectDataPersisted

Methods inherited from interface org.spongepowered.api.service.context.Contextual

getActiveContexts, getFriendlyIdentifier, getIdentifier

Method Detail

getProfile

GameProfile getProfile()

Gets the associated GameProfile of this player.

Returns:

The user's profile

getName

String getName()

Gets the player's last known username.

Specified by:

getName in interface Tamer

Returns:

The player's last known username

isOnline

boolean isOnline()

Checks if this user is online or not.

Returns:

True if the corresponding player is online

getPlayer

Optional<Player> getPlayer()

Gets the related online Player if the player is in fact online.

Returns:

The associated online Player, if available

getPosition

com.flowpowered.math.vector.Vector3d getPosition()

Gets the position of this User

Returns:

The position of this User

getWorldUniqueId

Optional<UUID> getWorldUniqueId()

Gets the World UUID of this User.

May return empty when the world the player is in does not exist anymore

Returns:

The World UUID of this User if found

setLocation

boolean setLocation(com.flowpowered.math.vector.Vector3d position,
                    UUID world)

Sets the position and world of this User.

The UUID must belong to an existing world.

When the User isOnline() this redirects to Entity.setLocation(Location)

Parameters:

position - The position to set

world - The world UUID to set

Throws:

IllegalArgumentException - When the UUID does not belong to an existing world.

setRotation

void setRotation(com.flowpowered.math.vector.Vector3d rotation)

Sets the rotation of this entity.

The format of the rotation is represented by:

x -> pitch, y -> yaw, z -> roll

Parameters:

rotation - The rotation to set the entity to

getRotation

com.flowpowered.math.vector.Vector3d getRotation()

Gets the rotation.

The format of the rotation is represented by:

x -> pitch, y -> yaw, z -> roll

Returns:

The rotation

getStatisticData

default StatisticData getStatisticData()

Gets a copy of the StatisticData for this user.

Returns:

A copy of the statistic data

getEnderChestInventory

Inventory getEnderChestInventory()

Gets the Inventory available for this Player's shared EnderChest contents.

Returns:

The ender chest inventory