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

Interface Player

All Superinterfaces:

ArmorEquipable, AttributeHolder, Audience, Carrier, CopyableDataHolder, DataHolder, DataHolder.Mutable, DataSerializable, Entity, EntityProjectileSource, Equipable, HoverEventSource<HoverEvent.ShowEntity>, Humanoid, Identifiable, Identified, Living, LocaleSource, Locatable, Nameable, Pointered, ProjectileSource, RandomProvider, SerializableDataHolder, SerializableDataHolder.Mutable, Sound.Emitter, Tamer, TeamMember, ValueContainer, Viewer

All Known Subinterfaces:

ClientPlayer, LocalPlayer, RemotePlayer, ServerPlayer

public interface Player
extends Humanoid, Identified, LocaleSource, Viewer, Carrier

A Player is the representation of an actual unit playing the game.

Nested Class Summary

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

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

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

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

Method Summary

Modifier and Type	Method	Description
default Value.Mutable<java.lang.Boolean>	affectsSpawning()	Keys.AFFECTS_SPAWNING
default Value.Mutable<java.lang.Boolean>	canFly()	Keys.CAN_FLY
default Value.Mutable<HandPreference>	dominantHand()	Keys.DOMINANT_HAND
Inventory	enderChestInventory()	Gets the Inventory available for this Player's shared EnderChest contents.
default Value.Mutable<java.lang.Double>	exhaustion()	Keys.EXHAUSTION
default Value.Mutable<java.lang.Integer>	experience()	Keys.EXPERIENCE
default Value<java.lang.Integer>	experienceFromStartToLevel()	Keys.EXPERIENCE_FROM_START_OF_LEVEL
default Value.Mutable<java.lang.Integer>	experienceLevel()	Keys.EXPERIENCE_LEVEL
default Value.Mutable<java.lang.Integer>	experienceSinceLevel()	Keys.EXPERIENCE_SINCE_LEVEL
default Value.Mutable<java.lang.Boolean>	flying()	Keys.IS_FLYING
default Value.Mutable<java.lang.Double>	flyingSpeed()	Keys.FLYING_SPEED
default Value.Mutable<java.lang.Integer>	foodLevel()	Keys.FOOD_LEVEL
default GameProfile	identity()
PlayerInventory	inventory()	Returns the inventory that this Carrier is holding.
default Value<java.lang.Double>	maxExhaustion()	Keys.MAX_EXHAUSTION
default Value<java.lang.Integer>	maxFoodLevel()	Keys.MAX_FOOD_LEVEL
default Value<java.lang.Double>	maxSaturation()	Keys.MAX_SATURATION
GameProfile	profile()	Gets the associated GameProfile of this player.
default Value.Mutable<java.lang.Double>	saturation()	Keys.SATURATION
default Value<java.lang.Boolean>	sleeping()	Keys.IS_SLEEPING
default Value<java.lang.Boolean>	sleepingIgnored()	Keys.IS_SLEEPING_IGNORED
default Value.Mutable<java.lang.Integer>	sleepTimer()	Keys.SLEEP_TIMER

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.entity.attribute.AttributeHolder

attribute, attribute

Methods inherited from interface net.kyori.adventure.audience.Audience

clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendTitlePart, showBossBar, showTitle, stopSound, stopSound

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.data.persistence.DataSerializable

contentVersion, toContainer

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

age, asHoverEvent, baseSize, baseVehicle, boundingBox, canSee, copy, createArchetype, createSnapshot, creator, customName, customNameVisible, damage, damage, direction, displayName, eyeHeight, eyePosition, fallDistance, fireImmuneTicks, fireTicks, glowing, gravityAffected, height, invisible, invulnerabilityTicks, invulnerable, isLoaded, isRemoved, isTransient, lookAt, maxAir, nearbyEntities, nearbyEntities, notifier, onGround, passengers, position, remainingAir, remove, rotation, scale, scoreboardTags, setLocation, setLocationAndRotation, setLocationAndRotation, setPosition, setRotation, setScale, setTransform, silent, sneaking, sprinting, swiftness, transferToWorld, transferToWorld, transform, type, vanish, vanishIgnoresCollision, vanishPreventsTargeting, vanishState, vehicle, velocity, wet

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

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

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface org.spongepowered.api.entity.living.Humanoid

skinProfile

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

uniqueId

Methods inherited from interface org.spongepowered.api.entity.living.Living

absorption, activeItem, bodyRotations, canGrief, chestRotation, elytraFlying, headDirection, headRotation, health, lastAttacker, lastDamageReceived, maxHealth, potionEffects, stuckArrows, walkingSpeed

Methods inherited from interface org.spongepowered.api.util.locale.LocaleSource

locale

Methods inherited from interface org.spongepowered.api.world.Locatable

blockPosition, location, serverLocation, world

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

name

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Methods inherited from interface org.spongepowered.api.projectile.source.ProjectileSource

launchProjectile, launchProjectile, launchProjectile, launchProjectile, launchProjectileTo, launchProjectileTo

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

random

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

validateRawData

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

setRawData

Methods inherited from interface org.spongepowered.api.scoreboard.TeamMember

teamRepresentation

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

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

Methods inherited from interface org.spongepowered.api.effect.Viewer

playMusicDisc, playSound, resetBlockChange, resetBlockChange, sendBlockChange, sendBlockChange, sendWorldType, spawnParticles, spawnParticles, stopMusicDisc

Method Detail

profile

GameProfile profile()

Gets the associated GameProfile of this player.

Returns:

The user's profile

identity

default GameProfile identity()

Specified by:

identity in interface Identified

inventory

PlayerInventory inventory()

Description copied from interface: Carrier

Returns the inventory that this Carrier is holding.

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

affectsSpawning

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

Keys.AFFECTS_SPAWNING

Returns:

Whether the player affects spawning

canFly

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

Keys.CAN_FLY

Returns:

Whether the player can fly

dominantHand

default Value.Mutable<HandPreference> dominantHand()

Keys.DOMINANT_HAND

Returns:

The dominant HandPreference of the player

exhaustion

default Value.Mutable<java.lang.Double> exhaustion()

Keys.EXHAUSTION

Returns:

The player's exhaustion

experience

default Value.Mutable<java.lang.Integer> experience()

Keys.EXPERIENCE

Returns:

The amount of experience the player has

experienceFromStartToLevel

default Value<java.lang.Integer> experienceFromStartToLevel()

Keys.EXPERIENCE_FROM_START_OF_LEVEL

Returns:

The experience requires to advance from the current level to the next one

experienceLevel

default Value.Mutable<java.lang.Integer> experienceLevel()

Keys.EXPERIENCE_LEVEL

Returns:

The current level the player has

experienceSinceLevel

default Value.Mutable<java.lang.Integer> experienceSinceLevel()

Keys.EXPERIENCE_SINCE_LEVEL

Returns:

The amount of experience the player has collected towards the next level

flyingSpeed

default Value.Mutable<java.lang.Double> flyingSpeed()

Keys.FLYING_SPEED

Returns:

The speed at which the player flies

foodLevel

default Value.Mutable<java.lang.Integer> foodLevel()

Keys.FOOD_LEVEL

Returns:

The player's food level

flying

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

Keys.IS_FLYING

Returns:

Whether the entity is flying

sleeping

default Value<java.lang.Boolean> sleeping()

Keys.IS_SLEEPING

Returns:

Whether the player is sleeping

sleepingIgnored

default Value<java.lang.Boolean> sleepingIgnored()

Keys.IS_SLEEPING_IGNORED

Returns:

Whether this player is going to be ignored for sleeping to "reset" the day

maxExhaustion

default Value<java.lang.Double> maxExhaustion()

Keys.MAX_EXHAUSTION

Returns:

The maximum exhaustion of the player

maxFoodLevel

default Value<java.lang.Integer> maxFoodLevel()

Keys.MAX_FOOD_LEVEL

Returns:

The maximum food level of the player

maxSaturation

default Value<java.lang.Double> maxSaturation()

Keys.MAX_SATURATION

Returns:

The maximum saturation of the player

saturation

default Value.Mutable<java.lang.Double> saturation()

Keys.SATURATION

Returns:

The player's saturation

sleepTimer

default Value.Mutable<java.lang.Integer> sleepTimer()

Keys.SLEEP_TIMER

Returns:

The sleep timer of the player