org.spongepowered.api.entity.living.player

Interface Player

All Superinterfaces:

ArmorEquipable, Carrier, ChatTypeMessageReceiver, CommandSource, CompositeValueStore<DataHolder,DataManipulator<?,?>>, Contextual, DataHolder, DataSerializable, Entity, Equipable, Humanoid, Identifiable, Living, Locatable, MessageReceiver, ProjectileLauncher, ProjectileSource, PropertyHolder, RemoteSource, Subject, Tamer, TeamMember, Translatable, User, ValueContainer<DataHolder>, Viewer

public interface Player
extends Humanoid, User, RemoteSource, Viewer, ChatTypeMessageReceiver

A Player represents the in-game entity of a human playing on a server. This is in contrast to User which represents the storage and data associated with a Player.

Any methods called on Player that are not on User do not store any data that persists across server restarts.

Field Summary

Fields inherited from interface org.spongepowered.api.entity.projectile.source.ProjectileSource

UNKNOWN

Method Summary

Modifier and Type	Method and Description
boolean	closeInventory() Closes the currently viewed entity of this player, if it is currently viewing one.
default Value<Instant>	firstPlayed() Gets the Value of the Instant that a Player joined the Server the first time.
default Value<GameMode>	gameMode() Gets the current GameMode for this Player.
ChatVisibility	getChatVisibility() Gets the current player chat visibility setting.
PlayerConnection	getConnection() Gets the appropriate PlayerConnection linking this Player to a client.
CooldownTracker	getCooldownTracker() Gets the CooldownTracker for this player, allowing control over the player's item cooldowns.
Set<SkinPart>	getDisplayedSkinParts() Gets the skin parts that this player has allowed to render.
default DisplayNameData	getDisplayNameData() Gets a copy of the current DisplayNameData for this Player.
Inventory	getEnderChestInventory() Gets the Inventory available for this Player's shared EnderChest contents.
default GameModeData	getGameModeData() Gets a copy of the current GameModeData for this Player.
default JoinData	getJoinData() Gets a copy of the current JoinData.
Optional<Container>	getOpenInventory() Gets the currently viewed inventory of this player, if it is currently viewing one.
AdvancementProgress	getProgress(Advancement advancement) Gets the AdvancementProgress for the specified Advancement.
Scoreboard	getScoreboard() Gets the Scoreboard displayed to the player.
Optional<Entity>	getSpectatorTarget() Gets the Entity followed by the camera when in the spectator gamemode.
TabList	getTabList() Gets this player's TabList.
Collection<AdvancementTree>	getUnlockedAdvancementTrees() Gets all the AdvancementTrees that this Player already unlocked.
int	getViewDistance() Gets the view distance setting of the player.
Optional<WorldBorder>	getWorldBorder() Gets the WorldBorder for this player, if present.
default boolean	hasPlayedBefore() Gets if the Player has played on the Server before.
boolean	isChatColorsEnabled() Gets whether the player has colors enabled in chat.
boolean	isSleepingIgnored() Gets whether this Player will be ignored when checking whether to skip the night due to players sleeping.
default boolean	isViewingInventory() Returns whether this player has an open inventory at the moment or not.
void	kick() Kicks the player, showing the default kick reason (the translation key disconnect.disconnected).
void	kick(Text reason) Kicks the player given a reason.
default Value<Instant>	lastPlayed() Gets the Value of the Instant that a Player joined the Server the last time.
Optional<Container>	openInventory(Inventory inventory) Opens the given Inventory for the player to view.
Optional<Container>	openInventory(Inventory inventory, Text displayName) Opens a given Inventory for the player to view with a custom displayName.
boolean	respawnPlayer() Manually respawns the player.
void	sendResourcePack(ResourcePack pack) Sends a given ResourcePack to this player.
void	setScoreboard(Scoreboard scoreboard) Sets the Scoreboard displayed to the player.
void	setSleepingIgnored(boolean sleepingIgnored) Sets whether this Player will be ignored when checking whether to skip the night due to players sleeping.
void	setSpectatorTarget(Entity entity) Sets the Entity followed by the camera when in the spectator gamemode.
void	setWorldBorder(WorldBorder border, Cause cause) Sets the WorldBorder instance for this player to the given world border.
MessageChannelEvent.Chat	simulateChat(Text message, Cause cause) Simulates a chat message from a player.

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

exhaustion, foodLevel, getFoodData, saturation

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

getDamageableData, getHeadRotation, getHealthData, health, lastAttacker, lastDamage, lookAt, maxHealth, setHeadRotation

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

addPassenger, addTag, canSee, clearPassengers, createArchetype, createSnapshot, damage, getBaseVehicle, getBoundingBox, getCreator, getNearbyEntities, getNearbyEntities, getNotifier, getPassengers, getRandom, getRotation, getScale, getTags, getTransform, getType, getVehicle, getVelocity, gravity, hasPassenger, hasTag, isLoaded, isOnGround, isRemoved, remove, removePassenger, removeTag, setCreator, setLocation, setLocationAndRotation, setLocationAndRotation, setLocationAndRotationSafely, setLocationAndRotationSafely, setLocationSafely, setNotifier, setRotation, setScale, setTransform, setTransformSafely, setVehicle, setVelocity, transferToWorld, transferToWorld, transferToWorld, transferToWorld

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

getLocation, getWorld

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.text.translation.Translatable

getTranslation

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

launchProjectile, launchProjectile

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

getTeamRepresentation

Methods inherited from interface org.spongepowered.api.entity.living.player.User

getName, getPlayer, getPosition, getProfile, getRotation, getStatisticData, getWorldUniqueId, isOnline, setLocation, setRotation

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.item.inventory.Carrier

getInventory

Methods inherited from interface org.spongepowered.api.command.CommandSource

getLocale, getName

Methods inherited from interface org.spongepowered.api.text.channel.MessageReceiver

getMessageChannel, sendMessage, sendMessage, sendMessage, sendMessages, sendMessages, setMessageChannel

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

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

clearTitle, playRecord, playSound, playSound, playSound, playSound, playSound, playSound, resetBlockChange, resetBlockChange, resetTitle, sendBlockChange, sendBlockChange, sendBookView, sendTitle, spawnParticles, spawnParticles, stopRecord, stopSounds, stopSounds, stopSounds, stopSounds

Methods inherited from interface org.spongepowered.api.text.channel.ChatTypeMessageReceiver

sendMessage, sendMessage, sendMessage, sendMessages, sendMessages

Method Detail

isViewingInventory

default boolean isViewingInventory()

Returns whether this player has an open inventory at the moment or not.

Returns:

Whether this player is viewing an inventory or not

getOpenInventory

Optional<Container> getOpenInventory()

Gets the currently viewed inventory of this player, if it is currently viewing one.

Returns:

An inventory if this player is viewing one, otherwise Optional.empty()

openInventory

Optional<Container> openInventory(Inventory inventory)
                           throws IllegalArgumentException

Opens the given Inventory for the player to view.

Parameters:

inventory - The inventory to view

Returns:

The opened Container if the inventory was opened, otherwise Optional.empty()

Throws:

IllegalArgumentException - if a PluginContainer is not the root of the cause

openInventory

Optional<Container> openInventory(Inventory inventory,
                                  Text displayName)

Opens a given Inventory for the player to view with a custom displayName.

Note that not all inventories support a custom display name.

Parameters:

inventory - The inventory to view

displayName - The display name to set

Returns:

The opened Container if the inventory was opened, otherwise Optional.empty()

closeInventory

boolean closeInventory()
                throws IllegalArgumentException

Closes the currently viewed entity of this player, if it is currently viewing one.

Returns:

whether or not closing the inventory succeeded

Throws:

IllegalArgumentException - if a PluginContainer is not the root of the cause

getViewDistance

int getViewDistance()

Gets the view distance setting of the player. This value represents the radius (around the player) in unit chunks.

Returns:

The player's view distance

getChatVisibility

ChatVisibility getChatVisibility()

Gets the current player chat visibility setting.

Returns:

Chat visibility setting

isChatColorsEnabled

boolean isChatColorsEnabled()

Gets whether the player has colors enabled in chat.

Returns:

True if colors are enabled in chat

simulateChat

MessageChannelEvent.Chat simulateChat(Text message,
                                      Cause cause)

Simulates a chat message from a player.

This method sends a message as if it came from this player. To send a message to this player instead, see MessageReceiver.sendMessage(Text) or ChatTypeMessageReceiver.sendMessage(ChatType, Text).

Commands cannot be sent using this method. To send commands, use CommandManager.process(CommandSource, String).

If text formatting is not supported in the implementation it will be displayed as plain text.

Parameters:

message - The message to send

cause - The cause for the message

Returns:

The event that was thrown from sending the message

getDisplayedSkinParts

Set<SkinPart> getDisplayedSkinParts()

Gets the skin parts that this player has allowed to render.

Returns:

A set of skin parts displayed

getConnection

PlayerConnection getConnection()

Gets the appropriate PlayerConnection linking this Player to a client.

Specified by:

getConnection in interface RemoteSource

Returns:

The connection

sendResourcePack

void sendResourcePack(ResourcePack pack)

Sends a given ResourcePack to this player.

Parameters:

pack - The ResourcePack to send

getTabList

TabList getTabList()

Gets this player's TabList.

Returns:

This player's TabList

kick

void kick()

Kicks the player, showing the default kick reason (the translation key disconnect.disconnected).

kick

void kick(Text reason)

Kicks the player given a reason.

Parameters:

reason - The reason for the kick

getScoreboard

Scoreboard getScoreboard()

Gets the Scoreboard displayed to the player.

Returns:

The scoreboard displayed to the player

setScoreboard

void setScoreboard(Scoreboard scoreboard)

Sets the Scoreboard displayed to the player.

Parameters:

scoreboard - The scoreboard to display

getJoinData

default JoinData getJoinData()

Gets a copy of the current JoinData.

Since a Player is already online, it means that the player has joined the server at least once, meaning there is a guaranteed initial join Instant. Users may not have ever joined a server before.

Returns:

A copy of the join data

firstPlayed

default Value<Instant> firstPlayed()

Gets the Value of the Instant that a Player joined the Server the first time.

Returns:

The value for the first time a player joined

lastPlayed

default Value<Instant> lastPlayed()

Gets the Value of the Instant that a Player joined the Server the last time.

Returns:

The value for the last time a player joined

hasPlayedBefore

default boolean hasPlayedBefore()

Gets if the Player has played on the Server before. Added as a utility.

Returns:

True if played before, false otherwise

getDisplayNameData

default DisplayNameData getDisplayNameData()

Gets a copy of the current DisplayNameData for this Player.

Returns:

A copy of the current display name data

getGameModeData

default GameModeData getGameModeData()

Gets a copy of the current GameModeData for this Player.

Returns:

A copy of the current game mode data

gameMode

default Value<GameMode> gameMode()

Gets the current GameMode for this Player.

Returns:

The current game mode value

isSleepingIgnored

boolean isSleepingIgnored()

Gets whether this Player will be ignored when checking whether to skip the night due to players sleeping. The time in a world will be advanced to day if all players in it either are sleeping or have this tag.

Returns:

Whether this Player will be ignored when checking whether to skip the night

setSleepingIgnored

void setSleepingIgnored(boolean sleepingIgnored)

Sets whether this Player will be ignored when checking whether to skip the night due to players sleeping. The time in a world will be advanced to day if all players in it either are sleeping or have this tag.

Parameters:

sleepingIgnored - Whether this Player will be ignored when checking whether to skip the night

getEnderChestInventory

Inventory getEnderChestInventory()

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

Specified by:

getEnderChestInventory in interface User

Returns:

The ender chest inventory

respawnPlayer

boolean respawnPlayer()

Manually respawns the player.

If the player is not dead, this method will return false

Returns:

Whether the respawn was successful

getSpectatorTarget

Optional<Entity> getSpectatorTarget()

Gets the Entity followed by the camera when in the spectator gamemode.

Returns:

The followed entity, if present, empty otherwise

setSpectatorTarget

void setSpectatorTarget(@Nullable
                        Entity entity)

Sets the Entity followed by the camera when in the spectator gamemode.

Parameters:

entity - The entity to spectate

getWorldBorder

Optional<WorldBorder> getWorldBorder()

Gets the WorldBorder for this player, if present. If no border is set, an empty Optional is returned.

Returns:

The WorldBorder of this player as an Optional, if present

setWorldBorder

void setWorldBorder(@Nullable
                    WorldBorder border,
                    Cause cause)

Sets the WorldBorder instance for this player to the given world border. If null is passed, the world border is unset.

Parameters:

border - The world border to be used, may be null

cause - The cause of the border's change

getCooldownTracker

CooldownTracker getCooldownTracker()

Gets the CooldownTracker for this player, allowing control over the player's item cooldowns.

Returns:

This player's cooldown tracker

getProgress

AdvancementProgress getProgress(Advancement advancement)

Gets the AdvancementProgress for the specified Advancement.

Parameters:

advancement - The advancement

Returns:

The advancement progress

getUnlockedAdvancementTrees

Collection<AdvancementTree> getUnlockedAdvancementTrees()

Gets all the AdvancementTrees that this Player already unlocked.

Returns:

The advancement trees