Package org.bukkit.entity

Interface Player

    • Method Detail

      • getDisplayName

        @NotNull
String getDisplayName()
        Gets the "friendly" name to display of this player. This may include color.

        Note that this name will not be displayed in game, only in chat and places defined by plugins.

        Returns:
        the friendly name

      • setDisplayName

        void setDisplayName​(@Nullable
                    String name)
        Sets the "friendly" name to display of this player. This may include color.

        Note that this name will not be displayed in game, only in chat and places defined by plugins.

        Parameters:
        name - The new display name.

      • getPlayerListName

        @NotNull
String getPlayerListName()
        Gets the name that is shown on the player list.
        Returns:
        the player list name

      • setPlayerListName

        void setPlayerListName​(@Nullable
                       String name)
        Sets the name that is shown on the in-game player list.

        If the value is null, the name will be identical to HumanEntity.getName().

        Parameters:
        name - new player list name

      • getPlayerListHeader

        @Nullable
String getPlayerListHeader()
        Gets the currently displayed player list header for this player.
        Returns:
        player list header or null

      • getPlayerListFooter

        @Nullable
String getPlayerListFooter()
        Gets the currently displayed player list footer for this player.
        Returns:
        player list header or null

      • setPlayerListHeader

        void setPlayerListHeader​(@Nullable
                         String header)
        Sets the currently displayed player list header for this player.
        Parameters:
        header - player list header, null for empty

      • setPlayerListFooter

        void setPlayerListFooter​(@Nullable
                         String footer)
        Sets the currently displayed player list footer for this player.
        Parameters:
        footer - player list footer, null for empty

      • setPlayerListHeaderFooter

        void setPlayerListHeaderFooter​(@Nullable
                               String header,
                               @Nullable
                               String footer)
        Sets the currently displayed player list header and footer for this player.
        Parameters:
        header - player list header, null for empty
        footer - player list footer, null for empty

      • setCompassTarget

        void setCompassTarget​(@NotNull
                      Location loc)
        Set the target of the player's compass.
        Parameters:
        loc - Location to point to

      • getCompassTarget

        @NotNull
Location getCompassTarget()
        Get the previously set compass target.
        Returns:
        location of the target

      • getAddress

        @Nullable
InetSocketAddress getAddress()
        Gets the socket address of this player
        Returns:
        the player's address

      • sendRawMessage

        void sendRawMessage​(@NotNull
                    String message)
        Sends this sender a message raw
        Specified by:
        sendRawMessage in interface Conversable
        Parameters:
        message - Message to be displayed

      • kickPlayer

        void kickPlayer​(@Nullable
                String message)
        Kicks player with custom kick message.
        Parameters:
        message - kick message

      • chat

        void chat​(@NotNull
          String msg)
        Says a message (or runs a command).
        Parameters:
        msg - message to print

      • performCommand

        boolean performCommand​(@NotNull
                       String command)
        Makes the player perform the given command
        Parameters:
        command - Command to perform
        Returns:
        true if the command was successful, otherwise false

      • isSneaking

        boolean isSneaking()
        Returns if the player is in sneak mode
        Returns:
        true if player is in sneak mode

      • setSneaking

        void setSneaking​(boolean sneak)
        Sets the sneak mode the player
        Parameters:
        sneak - true if player should appear sneaking

      • isSprinting

        boolean isSprinting()
        Gets whether the player is sprinting or not.
        Returns:
        true if player is sprinting.

      • setSprinting

        void setSprinting​(boolean sprinting)
        Sets whether the player is sprinting or not.
        Parameters:
        sprinting - true if the player should be sprinting

      • saveData

        void saveData()
        Saves the players current location, health, inventory, motion, and other information into the username.dat file, in the world/player folder

      • loadData

        void loadData()
        Loads the players current location, health, inventory, motion, and other information from the username.dat file, in the world/player folder.

        Note: This will overwrite the players current inventory, health, motion, etc, with the state from the saved dat file.

      • setSleepingIgnored

        void setSleepingIgnored​(boolean isSleeping)
        Sets whether the player is ignored as not sleeping. If everyone is either sleeping or has this flag set, then time will advance to the next day. If everyone has this flag set but no one is actually in bed, then nothing will happen.
        Parameters:
        isSleeping - Whether to ignore.

      • isSleepingIgnored

        boolean isSleepingIgnored()
        Returns whether the player is sleeping ignored.
        Returns:
        Whether player is ignoring sleep.

      • playNote

        @Deprecated
void playNote​(@NotNull
              Location loc,
              byte instrument,
              byte note)
        Deprecated.
        Magic value
        Play a note for a player at a location. This requires a note block at the particular location (as far as the client is concerned). This will not work without a note block. This will not work with cake.
        Parameters:
        loc - The location of a note block.
        instrument - The instrument ID.
        note - The note ID.

      • playNote

        void playNote​(@NotNull
              Location loc,
              @NotNull
              Instrument instrument,
              @NotNull
              Note note)
        Play a note for a player at a location. This requires a note block at the particular location (as far as the client is concerned). This will not work without a note block. This will not work with cake.
        Parameters:
        loc - The location of a note block
        instrument - The instrument
        note - The note

      • playSound

        void playSound​(@NotNull
               Location location,
               @NotNull
               Sound sound,
               float volume,
               float pitch)
        Play a sound for a player at the location.

        This function will fail silently if Location or Sound are null.

        Parameters:
        location - The location to play the sound
        sound - The sound to play
        volume - The volume of the sound
        pitch - The pitch of the sound

      • playSound

        void playSound​(@NotNull
               Location location,
               @NotNull
               String sound,
               float volume,
               float pitch)
        Play a sound for a player at the location.

        This function will fail silently if Location or Sound are null. No sound will be heard by the player if their client does not have the respective sound for the value passed.

        Parameters:
        location - the location to play the sound
        sound - the internal sound name to play
        volume - the volume of the sound
        pitch - the pitch of the sound

      • playSound

        void playSound​(@NotNull
               Location location,
               @NotNull
               Sound sound,
               @NotNull
               SoundCategory category,
               float volume,
               float pitch)
        Play a sound for a player at the location.

        This function will fail silently if Location or Sound are null.

        Parameters:
        location - The location to play the sound
        sound - The sound to play
        category - The category of the sound
        volume - The volume of the sound
        pitch - The pitch of the sound

      • playSound

        void playSound​(@NotNull
               Location location,
               @NotNull
               String sound,
               @NotNull
               SoundCategory category,
               float volume,
               float pitch)
        Play a sound for a player at the location.

        This function will fail silently if Location or Sound are null. No sound will be heard by the player if their client does not have the respective sound for the value passed.

        Parameters:
        location - the location to play the sound
        sound - the internal sound name to play
        category - The category of the sound
        volume - the volume of the sound
        pitch - the pitch of the sound

      • stopSound

        void stopSound​(@NotNull
               Sound sound)
        Stop the specified sound from playing.
        Parameters:
        sound - the sound to stop

      • stopSound

        void stopSound​(@NotNull
               String sound)
        Stop the specified sound from playing.
        Parameters:
        sound - the sound to stop

      • stopSound

        void stopSound​(@NotNull
               Sound sound,
               @Nullable
               SoundCategory category)
        Stop the specified sound from playing.
        Parameters:
        sound - the sound to stop
        category - the category of the sound

      • stopSound

        void stopSound​(@NotNull
               String sound,
               @Nullable
               SoundCategory category)
        Stop the specified sound from playing.
        Parameters:
        sound - the sound to stop
        category - the category of the sound

      • playEffect

        @Deprecated
void playEffect​(@NotNull
                Location loc,
                @NotNull
                Effect effect,
                int data)
        Deprecated.
        Magic value
        Plays an effect to just this player.
        Parameters:
        loc - the location to play the effect at
        effect - the Effect
        data - a data bit needed for some effects

      • playEffect

        <T> void playEffect​(@NotNull
                    Location loc,
                    @NotNull
                    Effect effect,
                    @Nullable
                    T data)
        Plays an effect to just this player.
        Type Parameters:
        T - the data based based on the type of the effect
        Parameters:
        loc - the location to play the effect at
        effect - the Effect
        data - a data bit needed for some effects

      • sendBlockChange

        @Deprecated
void sendBlockChange​(@NotNull
                     Location loc,
                     @NotNull
                     Material material,
                     byte data)
        Deprecated.
        Magic value
        Send a block change. This fakes a block change packet for a user at a certain location. This will not actually change the world in any way.
        Parameters:
        loc - The location of the changed block
        material - The new block
        data - The block data

      • sendBlockChange

        void sendBlockChange​(@NotNull
                     Location loc,
                     @NotNull
                     BlockData block)
        Send a block change. This fakes a block change packet for a user at a certain location. This will not actually change the world in any way.
        Parameters:
        loc - The location of the changed block
        block - The new block

      • sendChunkChange

        @Deprecated
boolean sendChunkChange​(@NotNull
                        Location loc,
                        int sx,
                        int sy,
                        int sz,
                        @NotNull
                        byte[] data)
        Deprecated.
        Magic value
        Send a chunk change. This fakes a chunk change packet for a user at a certain location. The updated cuboid must be entirely within a single chunk. This will not actually change the world in any way.

        At least one of the dimensions of the cuboid must be even. The size of the data buffer must be 2.5*sx*sy*sz and formatted in accordance with the Packet51 format.

        Parameters:
        loc - The location of the cuboid
        sx - The x size of the cuboid
        sy - The y size of the cuboid
        sz - The z size of the cuboid
        data - The data to be sent
        Returns:
        true if the chunk change packet was sent

      • sendMap

        void sendMap​(@NotNull
             MapView map)
        Render a map and send it to the player in its entirety. This may be used when streaming the map in the normal manner is not desirable.
        Parameters:
        map - The map to be sent

      • updateInventory

        void updateInventory()
        Forces an update of the player's entire inventory.

      • awardAchievement

        @Deprecated
void awardAchievement​(@NotNull
                      Achievement achievement)
        Deprecated.
        future versions of Minecraft do not have achievements
        Awards the given achievement and any parent achievements that the player does not have.
        Parameters:
        achievement - Achievement to award
        Throws:
        IllegalArgumentException - if achievement is null

      • removeAchievement

        @Deprecated
void removeAchievement​(@NotNull
                       Achievement achievement)
        Deprecated.
        future versions of Minecraft do not have achievements
        Removes the given achievement and any children achievements that the player has.
        Parameters:
        achievement - Achievement to remove
        Throws:
        IllegalArgumentException - if achievement is null

      • hasAchievement

        @Deprecated
boolean hasAchievement​(@NotNull
                       Achievement achievement)
        Deprecated.
        future versions of Minecraft do not have achievements
        Gets whether this player has the given achievement.
        Parameters:
        achievement - the achievement to check
        Returns:
        whether the player has the achievement
        Throws:
        IllegalArgumentException - if achievement is null

      • incrementStatistic

        void incrementStatistic​(@NotNull
                        Statistic statistic)
                 throws IllegalArgumentException
        Increments the given statistic for this player.

        This is equivalent to the following code: incrementStatistic(Statistic, 1)

        Parameters:
        statistic - Statistic to increment
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if the statistic requires an additional parameter

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        Statistic statistic)
                 throws IllegalArgumentException
        Decrements the given statistic for this player.

        This is equivalent to the following code: decrementStatistic(Statistic, 1)

        Parameters:
        statistic - Statistic to decrement
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if the statistic requires an additional parameter

      • incrementStatistic

        void incrementStatistic​(@NotNull
                        Statistic statistic,
                        @NotNull
                        Material material)
                 throws IllegalArgumentException
        Increments the given statistic for this player for the given material.

        This is equivalent to the following code: incrementStatistic(Statistic, Material, 1)

        Parameters:
        statistic - Statistic to increment
        material - Material to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if material is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        Statistic statistic,
                        @NotNull
                        Material material)
                 throws IllegalArgumentException
        Decrements the given statistic for this player for the given material.

        This is equivalent to the following code: decrementStatistic(Statistic, Material, 1)

        Parameters:
        statistic - Statistic to decrement
        material - Material to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if material is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • incrementStatistic

        void incrementStatistic​(@NotNull
                        Statistic statistic,
                        @NotNull
                        EntityType entityType)
                 throws IllegalArgumentException
        Increments the given statistic for this player for the given entity.

        This is equivalent to the following code: incrementStatistic(Statistic, EntityType, 1)

        Parameters:
        statistic - Statistic to increment
        entityType - EntityType to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if entityType is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        Statistic statistic,
                        @NotNull
                        EntityType entityType)
                 throws IllegalArgumentException
        Decrements the given statistic for this player for the given entity.

        This is equivalent to the following code: decrementStatistic(Statistic, EntityType, 1)

        Parameters:
        statistic - Statistic to decrement
        entityType - EntityType to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if entityType is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        Statistic statistic,
                        @NotNull
                        EntityType entityType,
                        int amount)
        Decrements the given statistic for this player for the given entity.
        Parameters:
        statistic - Statistic to decrement
        entityType - EntityType to offset the statistic with
        amount - Amount to decrement this statistic by
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if entityType is null
        IllegalArgumentException - if amount is negative
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • setPlayerTime

        void setPlayerTime​(long time,
                   boolean relative)
        Sets the current time on the player's client. When relative is true the player's time will be kept synchronized to its world time with the specified offset.

        When using non relative time the player's time will stay fixed at the specified time parameter. It's up to the caller to continue updating the player's time. To restore player time to normal use resetPlayerTime().

        Parameters:
        time - The current player's perceived time or the player's time offset from the server time.
        relative - When true the player time is kept relative to its world time.

      • getPlayerTime

        long getPlayerTime()
        Returns the player's current timestamp.
        Returns:
        The player's time

      • getPlayerTimeOffset

        long getPlayerTimeOffset()
        Returns the player's current time offset relative to server time, or the current player's fixed time if the player's time is absolute.
        Returns:
        The player's time

      • isPlayerTimeRelative

        boolean isPlayerTimeRelative()
        Returns true if the player's time is relative to the server time, otherwise the player's time is absolute and will not change its current time unless done so with setPlayerTime().
        Returns:
        true if the player's time is relative to the server time.

      • resetPlayerTime

        void resetPlayerTime()
        Restores the normal condition where the player's time is synchronized with the server time.

        Equivalent to calling setPlayerTime(0, true).

      • setPlayerWeather

        void setPlayerWeather​(@NotNull
                      WeatherType type)
        Sets the type of weather the player will see. When used, the weather status of the player is locked until resetPlayerWeather() is used.
        Parameters:
        type - The WeatherType enum type the player should experience

      • getPlayerWeather

        @Nullable
WeatherType getPlayerWeather()
        Returns the type of weather the player is currently experiencing.
        Returns:
        The WeatherType that the player is currently experiencing or null if player is seeing server weather.

      • resetPlayerWeather

        void resetPlayerWeather()
        Restores the normal condition where the player's weather is controlled by server conditions.

      • giveExp

        void giveExp​(int amount)
        Gives the player the amount of experience specified.
        Parameters:
        amount - Exp amount to give

      • giveExpLevels

        void giveExpLevels​(int amount)
        Gives the player the amount of experience levels specified. Levels can be taken by specifying a negative amount.
        Parameters:
        amount - amount of experience levels to give or take

      • getExp

        float getExp()
        Gets the players current experience points towards the next level.

        This is a percentage value. 0 is "no progress" and 1 is "next level".

        Returns:
        Current experience points

      • setExp

        void setExp​(float exp)
        Sets the players current experience points towards the next level

        This is a percentage value. 0 is "no progress" and 1 is "next level".

        Parameters:
        exp - New experience points

      • getLevel

        int getLevel()
        Gets the players current experience level
        Returns:
        Current experience level

      • setLevel

        void setLevel​(int level)
        Sets the players current experience level
        Parameters:
        level - New experience level

      • getTotalExperience

        int getTotalExperience()
        Gets the players total experience points.
        This refers to the total amount of experience the player has collected over time and is only displayed as the player's "score" upon dying.
        Returns:
        Current total experience points

      • setTotalExperience

        void setTotalExperience​(int exp)
        Sets the players current experience points.
        This refers to the total amount of experience the player has collected over time and is only displayed as the player's "score" upon dying.
        Parameters:
        exp - New total experience points

      • getExhaustion

        float getExhaustion()
        Gets the players current exhaustion level.

        Exhaustion controls how fast the food level drops. While you have a certain amount of exhaustion, your saturation will drop to zero, and then your food will drop to zero.

        Returns:
        Exhaustion level

      • setExhaustion

        void setExhaustion​(float value)
        Sets the players current exhaustion level
        Parameters:
        value - Exhaustion level

      • getSaturation

        float getSaturation()
        Gets the players current saturation level.

        Saturation is a buffer for food level. Your food level will not drop if you are saturated > 0.

        Returns:
        Saturation level

      • setSaturation

        void setSaturation​(float value)
        Sets the players current saturation level
        Parameters:
        value - Saturation level

      • getFoodLevel

        int getFoodLevel()
        Gets the players current food level
        Returns:
        Food level

      • setFoodLevel

        void setFoodLevel​(int value)
        Sets the players current food level
        Parameters:
        value - New food level

      • getAllowFlight

        boolean getAllowFlight()
        Determines if the Player is allowed to fly via jump key double-tap like in creative mode.
        Returns:
        True if the player is allowed to fly.

      • setAllowFlight

        void setAllowFlight​(boolean flight)
        Sets if the Player is allowed to fly via jump key double-tap like in creative mode.
        Parameters:
        flight - If flight should be allowed.

      • hidePlayer

        void hidePlayer​(@NotNull
                Plugin plugin,
                @NotNull
                Player player)
        Hides a player from this player
        Parameters:
        plugin - Plugin that wants to hide the player
        player - Player to hide

      • showPlayer

        void showPlayer​(@NotNull
                Plugin plugin,
                @NotNull
                Player player)
        Allows this player to see a player that was previously hidden. If another another plugin had hidden the player too, then the player will remain hidden until the other plugin calls this method too.
        Parameters:
        plugin - Plugin that wants to show the player
        player - Player to show

      • canSee

        boolean canSee​(@NotNull
               Player player)
        Checks to see if a player has been hidden from this player
        Parameters:
        player - Player to check
        Returns:
        True if the provided player is not being hidden from this player

      • isFlying

        boolean isFlying()
        Checks to see if this player is currently flying or not.
        Returns:
        True if the player is flying, else false.

      • setFlying

        void setFlying​(boolean value)
        Makes this player start or stop flying.
        Parameters:
        value - True to fly.

      • setFlySpeed

        void setFlySpeed​(float value)
          throws IllegalArgumentException
        Sets the speed at which a client will fly. Negative values indicate reverse directions.
        Parameters:
        value - The new speed, from -1 to 1.
        Throws:
        IllegalArgumentException - If new speed is less than -1 or greater than 1

      • setWalkSpeed

        void setWalkSpeed​(float value)
           throws IllegalArgumentException
        Sets the speed at which a client will walk. Negative values indicate reverse directions.
        Parameters:
        value - The new speed, from -1 to 1.
        Throws:
        IllegalArgumentException - If new speed is less than -1 or greater than 1

      • getFlySpeed

        float getFlySpeed()
        Gets the current allowed speed that a client can fly.
        Returns:
        The current allowed speed, from -1 to 1

      • getWalkSpeed

        float getWalkSpeed()
        Gets the current allowed speed that a client can walk.
        Returns:
        The current allowed speed, from -1 to 1

      • setTexturePack

        @Deprecated
void setTexturePack​(@NotNull
                    String url)
        Deprecated.
        Minecraft no longer uses textures packs. Instead you should use setResourcePack(String).
        Request that the player's client download and switch texture packs.

        The player's client will download the new texture pack asynchronously in the background, and will automatically switch to it once the download is complete. If the client has downloaded and cached the same texture pack in the past, it will perform a file size check against the response content to determine if the texture pack has changed and needs to be downloaded again. When this request is sent for the very first time from a given server, the client will first display a confirmation GUI to the player before proceeding with the download.

        Notes:

        • Players can disable server textures on their client, in which case this method will have no affect on them. Use the PlayerResourcePackStatusEvent to figure out whether or not the player loaded the pack!
        • There is no concept of resetting texture packs back to default within Minecraft, so players will have to relog to do so or you have to send an empty pack.
        • The request is send with "null" as the hash. This might result in newer versions not loading the pack correctly.
        Parameters:
        url - The URL from which the client will download the texture pack. The string must contain only US-ASCII characters and should be encoded as per RFC 1738.
        Throws:
        IllegalArgumentException - Thrown if the URL is null.
        IllegalArgumentException - Thrown if the URL is too long.

      • setResourcePack

        void setResourcePack​(@NotNull
                     String url)
        Request that the player's client download and switch resource packs.

        The player's client will download the new resource pack asynchronously in the background, and will automatically switch to it once the download is complete. If the client has downloaded and cached the same resource pack in the past, it will perform a file size check against the response content to determine if the resource pack has changed and needs to be downloaded again. When this request is sent for the very first time from a given server, the client will first display a confirmation GUI to the player before proceeding with the download.

        Notes:

        • Players can disable server resources on their client, in which case this method will have no affect on them. Use the PlayerResourcePackStatusEvent to figure out whether or not the player loaded the pack!
        • There is no concept of resetting resource packs back to default within Minecraft, so players will have to relog to do so or you have to send an empty pack.
        • The request is send with "null" as the hash. This might result in newer versions not loading the pack correctly.
        Parameters:
        url - The URL from which the client will download the resource pack. The string must contain only US-ASCII characters and should be encoded as per RFC 1738.
        Throws:
        IllegalArgumentException - Thrown if the URL is null.
        IllegalArgumentException - Thrown if the URL is too long. The length restriction is an implementation specific arbitrary value.

      • setResourcePack

        void setResourcePack​(@NotNull
                     String url,
                     @NotNull
                     byte[] hash)
        Request that the player's client download and switch resource packs.

        The player's client will download the new resource pack asynchronously in the background, and will automatically switch to it once the download is complete. If the client has downloaded and cached a resource pack with the same hash in the past it will not download but directly apply the cached pack. When this request is sent for the very first time from a given server, the client will first display a confirmation GUI to the player before proceeding with the download.

        Notes:

        • Players can disable server resources on their client, in which case this method will have no affect on them. Use the PlayerResourcePackStatusEvent to figure out whether or not the player loaded the pack!
        • There is no concept of resetting resource packs back to default within Minecraft, so players will have to relog to do so or you have to send an empty pack.
        Parameters:
        url - The URL from which the client will download the resource pack. The string must contain only US-ASCII characters and should be encoded as per RFC 1738.
        hash - The sha1 hash sum of the resource pack file which is used to apply a cached version of the pack directly without downloading if it is available. Hast to be 20 bytes long!
        Throws:
        IllegalArgumentException - Thrown if the URL is null.
        IllegalArgumentException - Thrown if the URL is too long. The length restriction is an implementation specific arbitrary value.
        IllegalArgumentException - Thrown if the hash is null.
        IllegalArgumentException - Thrown if the hash is not 20 bytes long.

      • getScoreboard

        @NotNull
Scoreboard getScoreboard()
        Gets the Scoreboard displayed to this player
        Returns:
        The current scoreboard seen by this player

      • isHealthScaled

        boolean isHealthScaled()
        Gets if the client is displayed a 'scaled' health, that is, health on a scale from 0-getHealthScale().
        Returns:
        if client health display is scaled
        See Also:
        setHealthScaled(boolean)

      • setHealthScaled

        void setHealthScaled​(boolean scale)
        Sets if the client is displayed a 'scaled' health, that is, health on a scale from 0-getHealthScale().

        Displayed health follows a simple formula displayedHealth = getHealth() / getMaxHealth() * getHealthScale().

        Parameters:
        scale - if the client health display is scaled

      • getHealthScale

        double getHealthScale()
        Gets the number that health is scaled to for the client.
        Returns:
        the number that health would be scaled to for the client if HealthScaling is set to true
        See Also:
        setHealthScale(double), setHealthScaled(boolean)

      • getSpectatorTarget

        @Nullable
Entity getSpectatorTarget()
        Gets the entity which is followed by the camera when in GameMode.SPECTATOR.
        Returns:
        the followed entity, or null if not in spectator mode or not following a specific entity.

      • sendTitle

        @Deprecated
void sendTitle​(@Nullable
               String title,
               @Nullable
               String subtitle)
        Deprecated.
        API behavior subject to change
        Sends a title and a subtitle message to the player. If either of these values are null, they will not be sent and the display will remain unchanged. If they are empty strings, the display will be updated as such. If the strings contain a new line, only the first line will be sent. The titles will be displayed with the client's default timings.
        Parameters:
        title - Title text
        subtitle - Subtitle text

      • sendTitle

        void sendTitle​(@Nullable
               String title,
               @Nullable
               String subtitle,
               int fadeIn,
               int stay,
               int fadeOut)
        Sends a title and a subtitle message to the player. If either of these values are null, they will not be sent and the display will remain unchanged. If they are empty strings, the display will be updated as such. If the strings contain a new line, only the first line will be sent. All timings values may take a value of -1 to indicate that they will use the last value sent (or the defaults if no title has been displayed).
        Parameters:
        title - Title text
        subtitle - Subtitle text
        fadeIn - time in ticks for titles to fade in. Defaults to 10.
        stay - time in ticks for titles to stay. Defaults to 70.
        fadeOut - time in ticks for titles to fade out. Defaults to 20.

      • resetTitle

        void resetTitle()
        Resets the title displayed to the player. This will clear the displayed title / subtitle and reset timings to their default values.

      • spawnParticle

        void spawnParticle​(@NotNull
                   Particle particle,
                   @NotNull
                   Location location,
                   int count)
        Spawns the particle (the number of times specified by count) at the target location.
        Parameters:
        particle - the particle to spawn
        location - the location to spawn at
        count - the number of particles

      • spawnParticle

        void spawnParticle​(@NotNull
                   Particle particle,
                   double x,
                   double y,
                   double z,
                   int count)
        Spawns the particle (the number of times specified by count) at the target location.
        Parameters:
        particle - the particle to spawn
        x - the position on the x axis to spawn at
        y - the position on the y axis to spawn at
        z - the position on the z axis to spawn at
        count - the number of particles

      • spawnParticle

        <T> void spawnParticle​(@NotNull
                       Particle particle,
                       @NotNull
                       Location location,
                       int count,
                       @Nullable
                       T data)
        Spawns the particle (the number of times specified by count) at the target location.
        Type Parameters:
        T - type of particle data (see Particle.getDataType()
        Parameters:
        particle - the particle to spawn
        location - the location to spawn at
        count - the number of particles
        data - the data to use for the particle or null, the type of this depends on Particle.getDataType()

      • spawnParticle

        <T> void spawnParticle​(@NotNull
                       Particle particle,
                       double x,
                       double y,
                       double z,
                       int count,
                       @Nullable
                       T data)
        Spawns the particle (the number of times specified by count) at the target location.
        Type Parameters:
        T - type of particle data (see Particle.getDataType()
        Parameters:
        particle - the particle to spawn
        x - the position on the x axis to spawn at
        y - the position on the y axis to spawn at
        z - the position on the z axis to spawn at
        count - the number of particles
        data - the data to use for the particle or null, the type of this depends on Particle.getDataType()

      • spawnParticle

        void spawnParticle​(@NotNull
                   Particle particle,
                   @NotNull
                   Location location,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Parameters:
        particle - the particle to spawn
        location - the location to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis

      • spawnParticle

        void spawnParticle​(@NotNull
                   Particle particle,
                   double x,
                   double y,
                   double z,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Parameters:
        particle - the particle to spawn
        x - the position on the x axis to spawn at
        y - the position on the y axis to spawn at
        z - the position on the z axis to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis

      • spawnParticle

        <T> void spawnParticle​(@NotNull
                       Particle particle,
                       @NotNull
                       Location location,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       @Nullable
                       T data)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Type Parameters:
        T - type of particle data (see Particle.getDataType()
        Parameters:
        particle - the particle to spawn
        location - the location to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis
        data - the data to use for the particle or null, the type of this depends on Particle.getDataType()

      • spawnParticle

        <T> void spawnParticle​(@NotNull
                       Particle particle,
                       double x,
                       double y,
                       double z,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       @Nullable
                       T data)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Type Parameters:
        T - type of particle data (see Particle.getDataType()
        Parameters:
        particle - the particle to spawn
        x - the position on the x axis to spawn at
        y - the position on the y axis to spawn at
        z - the position on the z axis to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis
        data - the data to use for the particle or null, the type of this depends on Particle.getDataType()

      • spawnParticle

        void spawnParticle​(@NotNull
                   Particle particle,
                   @NotNull
                   Location location,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ,
                   double extra)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Parameters:
        particle - the particle to spawn
        location - the location to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis
        extra - the extra data for this particle, depends on the particle used (normally speed)

      • spawnParticle

        void spawnParticle​(@NotNull
                   Particle particle,
                   double x,
                   double y,
                   double z,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ,
                   double extra)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Parameters:
        particle - the particle to spawn
        x - the position on the x axis to spawn at
        y - the position on the y axis to spawn at
        z - the position on the z axis to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis
        extra - the extra data for this particle, depends on the particle used (normally speed)

      • spawnParticle

        <T> void spawnParticle​(@NotNull
                       Particle particle,
                       @NotNull
                       Location location,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       double extra,
                       @Nullable
                       T data)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Type Parameters:
        T - type of particle data (see Particle.getDataType()
        Parameters:
        particle - the particle to spawn
        location - the location to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis
        extra - the extra data for this particle, depends on the particle used (normally speed)
        data - the data to use for the particle or null, the type of this depends on Particle.getDataType()

      • spawnParticle

        <T> void spawnParticle​(@NotNull
                       Particle particle,
                       double x,
                       double y,
                       double z,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       double extra,
                       @Nullable
                       T data)
        Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
        Type Parameters:
        T - type of particle data (see Particle.getDataType()
        Parameters:
        particle - the particle to spawn
        x - the position on the x axis to spawn at
        y - the position on the y axis to spawn at
        z - the position on the z axis to spawn at
        count - the number of particles
        offsetX - the maximum random offset on the X axis
        offsetY - the maximum random offset on the Y axis
        offsetZ - the maximum random offset on the Z axis
        extra - the extra data for this particle, depends on the particle used (normally speed)
        data - the data to use for the particle or null, the type of this depends on Particle.getDataType()

      • getAdvancementProgress

        @NotNull
AdvancementProgress getAdvancementProgress​(@NotNull
                                           Advancement advancement)
        Return the player's progression on the specified advancement.
        Parameters:
        advancement - advancement
        Returns:
        object detailing the player's progress

      • getClientViewDistance

        int getClientViewDistance()
        Get the player's current client side view distance.
        Will default to the server view distance if the client has not yet communicated this information,
        Returns:
        client view distance as above

      • getLocale

        @NotNull
String getLocale()
        Gets the player's current locale. The value of the locale String is not defined properly.
        The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.
        Returns:
        the player's locale

      • updateCommands

        void updateCommands()
        Update the list of commands sent to the client.
        Generally useful to ensure the client has a complete list of commands after permission changes are done.