Package org.spongepowered.api.entity.living.player

Interface User

All Superinterfaces:

ArmorEquipable, Carrier, Contextual, DataHolder, DataHolder.Mutable, Equipable, Identifiable, Nameable, Subject, Tamer, ValueContainer

@DoNotStore
public interface User
extends DataHolder.Mutable, ArmorEquipable, Tamer, Subject, Carrier

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
Inventory	enderChestInventory()	Gets the Inventory available for this Player's shared EnderChest contents.
default java.util.Optional<Value.Mutable<java.time.Instant>>	firstJoined()	Keys.FIRST_DATE_JOINED
CarriedInventory<? extends Carrier>	inventory()	Returns the inventory that this Carrier is holding.
default Value.Mutable<java.lang.Boolean>	invisible()	Keys.IS_INVISIBLE
default Value.Mutable<java.lang.Boolean>	invulnerable()	Keys.INVULNERABLE
boolean	isOnline()	Checks if this user is online or not.
default java.util.Optional<Value.Mutable<java.time.Instant>>	lastJoined()	Keys.LAST_DATE_JOINED
java.lang.String	name()	Gets the player's last known username.
java.util.Optional<ServerPlayer>	player()	Gets the related online player if the player is in fact online.
Vector3d	position()	Gets the position of this User
GameProfile	profile()	Gets the associated GameProfile of this player.
default MapValue.Mutable<ResourceKey,RespawnLocation>	respawnLocations()	Keys.RESPAWN_LOCATIONS
Vector3d	rotation()	Gets the rotation.
boolean	setLocation(ResourceKey world, Vector3d position)	Sets the world and position of this User.
void	setRotation(Vector3d rotation)	Sets the rotation of this entity.
default Value.Mutable<java.lang.Boolean>	vanish()	Deprecated.
default Value.Mutable<java.lang.Boolean>	vanishIgnoresCollision()	Deprecated.
default Value.Mutable<java.lang.Boolean>	vanishPreventsTargeting()	Deprecated.
default Value.Mutable<VanishState>	vanishState()
ResourceKey	worldKey()	Gets the world key of this User.

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

chest, feet, head, itemInHand, itemInHand, legs, setChest, setFeet, setHead, setItemInHand, setItemInHand, setLegs

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

friendlyIdentifier, identifier

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

copyFrom, copyFrom, offer, offer, offer, offer, offerAll, offerAll, offerAll, offerAll, offerAll, offerAll, offerSingle, offerSingle, offerSingle, offerSingle, remove, remove, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeKey, removeKey, removeSingle, removeSingle, transform, transform, tryOffer, tryOffer, tryOffer, undo

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

canEquip, canEquip, canEquip, canEquip, equip, equip, equipment, equipped, equipped

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

uniqueId

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

associatedObject, asSubjectReference, containingCollection, contextCause, hasPermission, hasPermission, hasPermission, isChildOf, isChildOf, isChildOf, isSubjectDataPersisted, option, option, option, parents, parents, parents, permissionValue, permissionValue, permissionValue, subjectData, transientSubjectData

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

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Detail

profile

GameProfile profile()

Gets the associated GameProfile of this player.

Returns:

The user's profile

name

java.lang.String name()

Gets the player's last known username.

Specified by:

name in interface Nameable

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

player

java.util.Optional<ServerPlayer> player()

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

Returns:

The associated online player, if available

position

Vector3d position()

Gets the position of this User

Returns:

The position of this User

worldKey

ResourceKey worldKey()

Gets the world key of this User.

Returns:

The key, if found

setLocation

boolean setLocation(ResourceKey world,
                    Vector3d position)

Sets the world and position of this User.

The key must belong to an existing world.

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

Parameters:

position - The position to set

world - The world key

Returns:

True if the location was accepted

setRotation

void setRotation(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

rotation

Vector3d rotation()

Gets the rotation.

The format of the rotation is represented by:

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

Returns:

The rotation

inventory

CarriedInventory<? extends Carrier> inventory()

Returns the inventory that this Carrier is holding. Note that this may be either a PlayerInventory or UserInventory, depending on whether the user is online or not.

Specified by:

inventory in interface Carrier

Returns:

The inventory this Carrier is holding

enderChestInventory

Inventory enderChestInventory()

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

Returns:

The ender chest inventory

respawnLocations

default MapValue.Mutable<ResourceKey,RespawnLocation> respawnLocations()

Keys.RESPAWN_LOCATIONS

Returns:

The spawn locations of the user may have for various worlds

firstJoined

default java.util.Optional<Value.Mutable<java.time.Instant>> firstJoined()

Keys.FIRST_DATE_JOINED

Returns:

The timestamp value when this user first joined

lastJoined

default java.util.Optional<Value.Mutable<java.time.Instant>> lastJoined()

Keys.LAST_DATE_JOINED

Returns:

The last timestamp value when this user has joined

invulnerable

default Value.Mutable<java.lang.Boolean> invulnerable()

Keys.INVULNERABLE

Returns:

Whether the user is invulnerable

invisible

default Value.Mutable<java.lang.Boolean> invisible()

Keys.IS_INVISIBLE

Returns:

Whether the user is invisible

vanishState

default Value.Mutable<VanishState> vanishState()

vanish

@Deprecated
default Value.Mutable<java.lang.Boolean> vanish()

Deprecated.

Keys.VANISH

Returns:

Whether the user is vanished

vanishIgnoresCollision

@Deprecated
default Value.Mutable<java.lang.Boolean> vanishIgnoresCollision()

Deprecated.

Keys.VANISH_IGNORES_COLLISION

Returns:

Whether the user ignores collision with other entities

vanishPreventsTargeting

@Deprecated
default Value.Mutable<java.lang.Boolean> vanishPreventsTargeting()

Deprecated.

Keys.VANISH_PREVENTS_TARGETING

Returns:

Whether the user can be targeted for attack by another entity