Player (common 2.6 API)

All Superinterfaces:

CommandSender, Entity, NegativityObject, OfflinePlayer

All Known Implementing Classes:

AbstractPlayer, AbstractProxyPlayer, CompensatedPlayer
```
public interface Player
extends OfflinePlayer
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addPotionEffect(PotionEffect pe)`
`void`	`addPotionEffect(PotionEffectType type, int duration, int amplifier)`
`void`	`applyTheoricVelocity()`
`void`	`closeInventory()`
`void`	`damage(double amount)` Damage player according to damage amount
`List<PotionEffect>`	`getActivePotionEffect()`
`InetSocketAddress`	`getAddress()` Get the player address
`boolean`	`getAllowFlight()` Check if the player is authorized to fly
`float`	`getFallDistance()` Get the player fall distance when player fall
`float`	`getFlySpeed()` Get player fly speed
`int`	`getFoodLevel()` Get the current player food level
`GameMode`	`getGameMode()` Get player gamemode
`double`	`getHealth()` Get the player health
`PlayerInventory`	`getInventory()`
`@Nullable String`	`getIP()` Get the player IP
`ItemStack`	`getItemInHand()` Get the item in main hand Return null if there is not any item in hand
`ItemStack`	`getItemInOffHand()` Get the item in second hand Compatible with 1.8 and lower.
`int`	`getLevel()` Get player XP level
`double`	`getMaxHealth()` Get the max player health
`List<Entity>`	`getNearbyEntities(double x, double y, double z)`
`Inventory`	`getOpenInventory()`
`int`	`getPing()` Get current player latency
`Version`	`getPlayerVersion()` Get player version (Compatible with ViaVersion and ProtocolSupport for multiple client version)
`Optional<PotionEffect>`	`getPotionEffect(PotionEffectType type)`
`int`	`getProtocolVersion()`
`String`	`getServerName()` Get the name of the server where the player is actually
`List<Block>`	`getTargetBlock(int maxDistance)`
`Vector`	`getTheoricVelocity()` Get the velocity that the entity SHOULD be take
`Entity`	`getVehicle()` Get the entity which is used as vehicle.
`Vector`	`getVelocity()` Get current entity velocity
`float`	`getWalkSpeed()` Get player walk speed
`CompensatedWorld`	`getWorld()` Get player world
`boolean`	`hasElytra()` Check if the player is using elytra (flying with it) (compatible with 1.8 and lower)
`boolean`	`hasLineOfSight(Entity entity)` Check if player can see the specified entity
`boolean`	`hasOpenInventory()`
`boolean`	`hasPermission(String perm)` Check if the player has the specified permission
`default boolean`	`hasPlayedBefore()` Check if it's a new player
`boolean`	`hasPotionEffect(PotionEffectType type)`
`default boolean`	`hasThorns()`
`boolean`	`isDead()` Know if the player is dead
`boolean`	`isFlying()` Check if the player is flying
`default boolean`	`isInBoat()`
`boolean`	`isInsideVehicle()` Check if player is in a vehicle.
`static boolean`	`isSamePlayer(Player player1, Player player2)`
`boolean`	`isSleeping()` Know if the player is sleeping
`boolean`	`isSneaking()`
`boolean`	`isSprinting()`
`boolean`	`isSwimming()` Know if the player is swimming (compatible with 1.8 and lower)
`boolean`	`isUsingRiptide()` Know if the player is currently using riptide effect (compatible with 1.12 and lower)
`void`	`kick(String reason)` Kick player with the specified reason
`void`	`openInventory(Inventory inv)`
`default void`	`queuePacket(NPacket packet)`
`void`	`removePotionEffect(PotionEffectType type)`
`default void`	`sendPacket(NPacket packet)` Send packet to the given player
`void`	`sendPluginMessage(String channelId, byte[] writeMessage)` Send plugin message : bungee to spigot OR spigot to bungee On the specified channel
`default void`	`sendPluginMessage(String channelId, NegativityMessage message)` Send plugin message : bungee to spigot OR spigot to bungee On the specified channel
`void`	`sendToServer(String serverName)` Send current player to the given server name.
`void`	`setAllowFlight(boolean b)` Edit the authorization to fly
`void`	`setFlying(boolean b)`
`void`	`setFoodLevel(int foodlevel)` Change the food level
`void`	`setGameMode(GameMode gameMode)` Set the player gamemode Warn: support only default gamemode.
`void`	`setHealth(double health)` Change the player health
`void`	`setInternalWorld(CompensatedWorld w)` This does NOT change the platform world (aka teleport)
`void`	`setLocation(Location loc)`
`void`	`setPlayerVersion(Version version)`
`void`	`setProtocolVersion(int protocolVersion)`
`default void`	`setSleeping(boolean b)`
`void`	`setSneaking(boolean b)`
`void`	`setSprinting(boolean b)`
`void`	`setVanished(boolean vanished)` Sets whether the play should be visible to other players.
`void`	`setVelocity(Vector vel)` Edit the entity velocity
`void`	`teleport(Entity et)` Teleport player to specified entity
`void`	`teleport(Location loc)` Teleport player to specified location
`void`	`updateInventory()`

Methods inherited from interface com.elikill58.negativity.api.entity.OfflinePlayer
getBoundingBox, getEntityId, getEyeHeight, getLocation, getType, getUniqueId, isOnGround, isOnline, sendMessage

Methods inherited from interface com.elikill58.negativity.api.entity.Entity
getEyeLocation, getRotation, isOp, isSameId, isSameId, isSameId

Methods inherited from interface com.elikill58.negativity.api.commands.CommandSender
getName

Methods inherited from interface com.elikill58.negativity.api.NegativityObject
getDefault

- Method Detail
  - getIP
```
@Nullable String getIP()
```
    Get the player IP
    
    Returns:
    
    player IP
  - isDead
```
boolean isDead()
```
    Know if the player is dead
    
    Specified by:
    
    isDead in interface Entity
    
    Specified by:
    
    isDead in interface OfflinePlayer
    
    Returns:
    
    true if the player is dead
  - isSleeping
```
boolean isSleeping()
```
    Know if the player is sleeping
    
    Returns:
    
    true is the player is sleeping
  - setSleeping
```
default void setSleeping(boolean b)
```
  - isSwimming
```
boolean isSwimming()
```
    Know if the player is swimming (compatible with 1.8 and lower)
    
    Returns:
    
    true if it's swimming
  - isUsingRiptide
```
boolean isUsingRiptide()
```
    Know if the player is currently using riptide effect (compatible with 1.12 and lower)
    
    Returns:
    
    true if it's ripting
  - hasElytra
```
boolean hasElytra()
```
    Check if the player is using elytra (flying with it) (compatible with 1.8 and lower)
    
    Returns:
    
    true if is elytra flying
  - hasPermission
```
boolean hasPermission(String perm)
```
    Check if the player has the specified permission
    
    Parameters:
    
    perm - the needed permission
    
    Returns:
    
    true if the player has permission
  - hasLineOfSight
```
boolean hasLineOfSight(Entity entity)
```
    Check if player can see the specified entity
    
    Parameters:
    
    entity - the entity to see
    
    Returns:
    
    true if the player can see it
  - isFlying
```
boolean isFlying()
```
    Check if the player is flying
    
    Returns:
    
    true is the player fly
  - setFlying
```
void setFlying(boolean b)
```
  - getAllowFlight
```
boolean getAllowFlight()
```
    Check if the player is authorized to fly
    
    Returns:
    
    true if the player can fly
  - setAllowFlight
```
void setAllowFlight(boolean b)
```
    Edit the authorization to fly
    
    Parameters:
    
    b - true if the player is allowed to fly
  - getPing
```
int getPing()
```
    Get current player latency
    
    Returns:
    
    the player ping
  - getLevel
```
int getLevel()
```
    Get player XP level
    
    Returns:
    
    the player level
  - getFlySpeed
```
float getFlySpeed()
```
    Get player fly speed
    
    Returns:
    
    the speed when player fly
  - getWalkSpeed
```
float getWalkSpeed()
```
    Get player walk speed
    
    Returns:
    
    the speed when player walk
  - getFallDistance
```
float getFallDistance()
```
    Get the player fall distance when player fall
    
    Returns:
    
    the player fall distance
  - getHealth
```
double getHealth()
```
    Get the player health
    
    Returns:
    
    the health
  - getMaxHealth
```
double getMaxHealth()
```
    Get the max player health
    
    Returns:
    
    the max health
  - setHealth
```
void setHealth(double health)
```
    Change the player health
    
    Parameters:
    
    health - next health
  - getFoodLevel
```
int getFoodLevel()
```
    Get the current player food level
    
    Returns:
    
    the food level
  - setFoodLevel
```
void setFoodLevel(int foodlevel)
```
    Change the food level
    
    Parameters:
    
    foodlevel - the new food level
  - getGameMode
```
GameMode getGameMode()
```
    Get player gamemode
    
    Returns:
    
    the Gamemode
  - setGameMode
```
void setGameMode(GameMode gameMode)
```
    Set the player gamemode Warn: support only default gamemode. Not modded server.
    
    Parameters:
    
    gameMode - the new player gamemode
  - damage
```
void damage(double amount)
```
    Damage player according to damage amount
    
    Parameters:
    
    amount - the quantity of damage
  - kick
```
void kick(String reason)
```
    Kick player with the specified reason
    
    Parameters:
    
    reason - the reason of kick
  - teleport
```
void teleport(Location loc)
```
    Teleport player to specified location
    
    Parameters:
    
    loc - location destination
  - teleport
```
void teleport(Entity et)
```
    Teleport player to specified entity
    
    Parameters:
    
    et - entity destination
  - isSneaking
```
boolean isSneaking()
```
  - setSneaking
```
void setSneaking(boolean b)
```
  - isSprinting
```
boolean isSprinting()
```
  - setSprinting
```
void setSprinting(boolean b)
```
  - getWorld
```
CompensatedWorld getWorld()
```
    Get player world
    
    Specified by:
    
    getWorld in interface Entity
    
    Specified by:
    
    getWorld in interface OfflinePlayer
    
    Returns:
    
    the world where the player is
  - setInternalWorld
```
void setInternalWorld(CompensatedWorld w)
```
    This does NOT change the platform world (aka teleport)
    
    Parameters:
    
    w - the new world
  - getPlayerVersion
```
Version getPlayerVersion()
```
    Get player version (Compatible with ViaVersion and ProtocolSupport for multiple client version)
    
    Returns:
    
    the version which player use on server
  - setPlayerVersion
```
void setPlayerVersion(Version version)
```
  - getProtocolVersion
```
int getProtocolVersion()
```
  - setProtocolVersion
```
void setProtocolVersion(int protocolVersion)
```
  - applyTheoricVelocity
```
void applyTheoricVelocity()
```
  - getTheoricVelocity
```
Vector getTheoricVelocity()
```
    Get the velocity that the entity SHOULD be take
    
    Returns:
    
    the theoric (and platform) velocity
  - getVelocity
```
Vector getVelocity()
```
    Get current entity velocity
    
    Returns:
    
    the entity velocity
  - setVelocity
```
void setVelocity(Vector vel)
```
    Edit the entity velocity
    
    Parameters:
    
    vel - the new velocity
  - getTargetBlock
```
List<Block> getTargetBlock(int maxDistance)
```
  - getVehicle
```
Entity getVehicle()
```
    Get the entity which is used as vehicle. It can be a wagon or a zombie.
    
    Returns:
    
    the vehicle entity
  - isInsideVehicle
```
boolean isInsideVehicle()
```
    Check if player is in a vehicle.
    
    Returns:
    
    true if it is in vehicle
  - getItemInHand
```
ItemStack getItemInHand()
```
    Get the item in main hand Return null if there is not any item in hand
    
    Returns:
    
    the item in hand
  - getItemInOffHand
```
ItemStack getItemInOffHand()
```
    Get the item in second hand Compatible with 1.8 and lower. Return null if there is any item in second hand or if the server is on 1.8 or lower
    
    Returns:
    
    the item in off hand
  - hasPotionEffect
```
boolean hasPotionEffect(PotionEffectType type)
```
  - getActivePotionEffect
```
List<PotionEffect> getActivePotionEffect()
```
  - getPotionEffect
```
Optional<PotionEffect> getPotionEffect(PotionEffectType type)
```
  - addPotionEffect
```
default void addPotionEffect(PotionEffect pe)
```
  - addPotionEffect
```
void addPotionEffect(PotionEffectType type,
                     int duration,
                     int amplifier)
```
  - removePotionEffect
```
void removePotionEffect(PotionEffectType type)
```
  - sendPluginMessage
```
default void sendPluginMessage(String channelId,
                               NegativityMessage message)
```
    Send plugin message : bungee to spigot OR spigot to bungee On the specified channel
    
    Parameters:
    
    channelId - the channel ID
    
    message - the message to sent
  - sendPluginMessage
```
void sendPluginMessage(String channelId,
                       byte[] writeMessage)
```
    Send plugin message : bungee to spigot OR spigot to bungee On the specified channel
    
    Parameters:
    
    channelId - the channel ID
    
    writeMessage - the message to sent
  - getNearbyEntities
```
List<Entity> getNearbyEntities(double x,
                               double y,
                               double z)
```
  - getInventory
```
PlayerInventory getInventory()
```
  - getOpenInventory
```
Inventory getOpenInventory()
```
  - hasOpenInventory
```
boolean hasOpenInventory()
```
  - openInventory
```
void openInventory(Inventory inv)
```
  - closeInventory
```
void closeInventory()
```
  - updateInventory
```
void updateInventory()
```
  - setVanished
```
void setVanished(boolean vanished)
```
    Sets whether the play should be visible to other players.
    
    Parameters:
    
    vanished - true is the player should NOT be visible
  - setLocation
```
void setLocation(Location loc)
```
  - getAddress
```
InetSocketAddress getAddress()
```
    Get the player address
    
    Returns:
    
    the player inet address
  - hasPlayedBefore
```
default boolean hasPlayedBefore()
```
    Check if it's a new player
    
    Specified by:
    
    hasPlayedBefore in interface OfflinePlayer
    
    Returns:
    
    true if the player has already played
  - sendToServer
```
void sendToServer(String serverName)
```
    Send current player to the given server name.
    Work only with proxy (Bungee/Velocity)
    
    Parameters:
    
    serverName - the name of the proxy server
  - getServerName
```
String getServerName()
```
    Get the name of the server where the player is actually
    
    Returns:
    
    the name of actual server
  - sendPacket
```
default void sendPacket(NPacket packet)
```
    Send packet to the given player
    
    Parameters:
    
    packet - the packet to send
  - queuePacket
```
default void queuePacket(NPacket packet)
```
  - isInBoat
```
default boolean isInBoat()
```
  - hasThorns
```
default boolean hasThorns()
```
  - isSamePlayer
```
static boolean isSamePlayer(Player player1,
                            Player player2)
```

Interface Player

Method Summary

Methods inherited from interface com.elikill58.negativity.api.entity.OfflinePlayer

Methods inherited from interface com.elikill58.negativity.api.entity.Entity

Methods inherited from interface com.elikill58.negativity.api.commands.CommandSender

Methods inherited from interface com.elikill58.negativity.api.NegativityObject

Method Detail

getIP

isDead

isSleeping

setSleeping

isSwimming

isUsingRiptide

hasElytra

hasPermission

hasLineOfSight

isFlying

setFlying

getAllowFlight

setAllowFlight

getPing

getLevel

getFlySpeed

getWalkSpeed

getFallDistance

getHealth

getMaxHealth

setHealth

getFoodLevel

setFoodLevel

getGameMode

setGameMode

damage

kick

teleport

teleport

isSneaking

setSneaking

isSprinting

setSprinting

getWorld

setInternalWorld

getPlayerVersion

setPlayerVersion

getProtocolVersion

setProtocolVersion

applyTheoricVelocity

getTheoricVelocity

getVelocity

setVelocity

getTargetBlock

getVehicle

isInsideVehicle

getItemInHand

getItemInOffHand

hasPotionEffect

getActivePotionEffect

getPotionEffect

addPotionEffect

addPotionEffect

removePotionEffect

sendPluginMessage

sendPluginMessage

getNearbyEntities

getInventory

getOpenInventory

hasOpenInventory

openInventory

closeInventory

updateInventory

setVanished

setLocation

getAddress

hasPlayedBefore

sendToServer

getServerName

sendPacket

queuePacket

isInBoat

hasThorns