CompensatedPlayer (common 2.6 API)

java.lang.Object
- com.elikill58.negativity.api.entity.AbstractPlayer
- - com.elikill58.negativity.api.impl.server.entity.CompensatedPlayer

All Implemented Interfaces:

CommandSender, Entity, OfflinePlayer, Player, NegativityObject
```
public class CompensatedPlayer
extends AbstractPlayer
```

Field Summary
- Fields inherited from class com.elikill58.negativity.api.entity.AbstractPlayer
  location, playerVersion, protocolVersion, velocity

Constructor Summary

Constructors
Constructor and Description

CompensatedPlayer(int entityId, UUID uuid, CompensatedWorld world)

Constructors
Constructor and Description
`CompensatedPlayer(int entityId, UUID uuid, CompensatedWorld world)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPotionEffect(PotionEffectType type, int duration, int amplifier)`
`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
`BoundingBox`	`getBoundingBox()` Get the bounding box of the current entity
`Object`	`getDefault()` Get default object which is abstracted by Negativity structure.
`int`	`getEntityId()` Get the entity ID
`double`	`getEyeHeight()`
`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
`String`	`getName()`
`List<Entity>`	`getNearbyEntities(double x, double y, double z)`
`Inventory`	`getOpenInventory()`
`int`	`getPing()` Get current player latency
`Optional<PotionEffect>`	`getPotionEffect(PotionEffectType type)`
`String`	`getServerName()` Get the name of the server where the player is actually
`Vector`	`getTheoricVelocity()` Get the velocity that the entity SHOULD be take
`UUID`	`getUniqueId()`
`Entity`	`getVehicle()` Get the entity which is used as vehicle.
`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
`boolean`	`hasPotionEffect(PotionEffectType type)`
`boolean`	`isDead()` Know if the player is dead
`boolean`	`isFlying()` Check if the player is flying
`boolean`	`isInsideVehicle()` Check if player is in a vehicle.
`boolean`	`isOnline()`
`boolean`	`isOp()` Check if the actual entity is OP or not
`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)`
`void`	`removePotionEffect(PotionEffectType type)`
`void`	`sendPluginMessage(String channelId, byte[] writeMessage)` 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`	`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`	`setWorld(CompensatedWorld world)`
`void`	`teleport(Entity et)` Teleport player to specified entity
`void`	`teleport(Location loc)` Teleport player to specified location
`String`	`toString()`
`void`	`updateInventory()`

Methods inherited from class com.elikill58.negativity.api.entity.AbstractPlayer
applyTheoricVelocity, equals, getLocation, getPlayerVersion, getProtocolVersion, getTargetBlock, getVelocity, init, setInternalWorld, setLocation, setPlayerVersion, setProtocolVersion

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.elikill58.negativity.api.entity.Player
addPotionEffect, hasPlayedBefore, hasThorns, isInBoat, isSamePlayer, queuePacket, sendPacket, sendPluginMessage, setSleeping

Methods inherited from interface com.elikill58.negativity.api.entity.OfflinePlayer
getType, isOnGround, sendMessage

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

- Constructor Detail
  - CompensatedPlayer
```
public CompensatedPlayer(int entityId,
                         UUID uuid,
                         CompensatedWorld world)
```
- Method Detail
  - getEyeHeight
```
public double getEyeHeight()
```
  - getWorld
```
public CompensatedWorld getWorld()
```
    Description copied from interface: Player
    
    Get player world
    
    Specified by:
    
    getWorld in interface Entity
    
    Specified by:
    
    getWorld in interface OfflinePlayer
    
    Specified by:
    
    getWorld in interface Player
    
    Overrides:
    
    getWorld in class AbstractPlayer
    
    Returns:
    
    the world where the player is
  - setWorld
```
public void setWorld(CompensatedWorld world)
```
  - getEntityId
```
public int getEntityId()
```
    Description copied from interface: Entity
    
    Get the entity ID
    
    Returns:
    
    the ID of the entity
  - getIP
```
public @Nullable String getIP()
```
    Description copied from interface: Player
    
    Get the player IP
    
    Returns:
    
    player IP
  - isDead
```
public boolean isDead()
```
    Description copied from interface: Player
    
    Know if the player is dead
    
    Returns:
    
    true if the player is dead
  - isSleeping
```
public boolean isSleeping()
```
    Description copied from interface: Player
    
    Know if the player is sleeping
    
    Returns:
    
    true is the player is sleeping
  - isSwimming
```
public boolean isSwimming()
```
    Description copied from interface: Player
    
    Know if the player is swimming (compatible with 1.8 and lower)
    
    Returns:
    
    true if it's swimming
  - isUsingRiptide
```
public boolean isUsingRiptide()
```
    Description copied from interface: Player
    
    Know if the player is currently using riptide effect (compatible with 1.12 and lower)
    
    Returns:
    
    true if it's ripting
  - hasElytra
```
public boolean hasElytra()
```
    Description copied from interface: Player
    
    Check if the player is using elytra (flying with it) (compatible with 1.8 and lower)
    
    Returns:
    
    true if is elytra flying
  - hasPermission
```
public boolean hasPermission(String perm)
```
    Description copied from interface: Player
    
    Check if the player has the specified permission
    
    Parameters:
    
    perm - the needed permission
    
    Returns:
    
    true if the player has permission
  - hasLineOfSight
```
public boolean hasLineOfSight(Entity entity)
```
    Description copied from interface: Player
    
    Check if player can see the specified entity
    
    Parameters:
    
    entity - the entity to see
    
    Returns:
    
    true if the player can see it
  - isFlying
```
public boolean isFlying()
```
    Description copied from interface: Player
    
    Check if the player is flying
    
    Returns:
    
    true is the player fly
  - setFlying
```
public void setFlying(boolean b)
```
  - getAllowFlight
```
public boolean getAllowFlight()
```
    Description copied from interface: Player
    
    Check if the player is authorized to fly
    
    Returns:
    
    true if the player can fly
  - setAllowFlight
```
public void setAllowFlight(boolean b)
```
    Description copied from interface: Player
    
    Edit the authorization to fly
    
    Parameters:
    
    b - true if the player is allowed to fly
  - getPing
```
public int getPing()
```
    Description copied from interface: Player
    
    Get current player latency
    
    Returns:
    
    the player ping
  - getLevel
```
public int getLevel()
```
    Description copied from interface: Player
    
    Get player XP level
    
    Returns:
    
    the player level
  - getFlySpeed
```
public float getFlySpeed()
```
    Description copied from interface: Player
    
    Get player fly speed
    
    Returns:
    
    the speed when player fly
  - getWalkSpeed
```
public float getWalkSpeed()
```
    Description copied from interface: Player
    
    Get player walk speed
    
    Returns:
    
    the speed when player walk
  - getFallDistance
```
public float getFallDistance()
```
    Description copied from interface: Player
    
    Get the player fall distance when player fall
    
    Returns:
    
    the player fall distance
  - getHealth
```
public double getHealth()
```
    Description copied from interface: Player
    
    Get the player health
    
    Returns:
    
    the health
  - getMaxHealth
```
public double getMaxHealth()
```
    Description copied from interface: Player
    
    Get the max player health
    
    Returns:
    
    the max health
  - setHealth
```
public void setHealth(double health)
```
    Description copied from interface: Player
    
    Change the player health
    
    Parameters:
    
    health - next health
  - getFoodLevel
```
public int getFoodLevel()
```
    Description copied from interface: Player
    
    Get the current player food level
    
    Returns:
    
    the food level
  - setFoodLevel
```
public void setFoodLevel(int foodlevel)
```
    Description copied from interface: Player
    
    Change the food level
    
    Parameters:
    
    foodlevel - the new food level
  - getGameMode
```
public GameMode getGameMode()
```
    Description copied from interface: Player
    
    Get player gamemode
    
    Returns:
    
    the Gamemode
  - setGameMode
```
public void setGameMode(GameMode gameMode)
```
    Description copied from interface: Player
    
    Set the player gamemode Warn: support only default gamemode. Not modded server.
    
    Parameters:
    
    gameMode - the new player gamemode
  - damage
```
public void damage(double amount)
```
    Description copied from interface: Player
    
    Damage player according to damage amount
    
    Parameters:
    
    amount - the quantity of damage
  - kick
```
public void kick(String reason)
```
    Description copied from interface: Player
    
    Kick player with the specified reason
    
    Parameters:
    
    reason - the reason of kick
  - teleport
```
public void teleport(Location loc)
```
    Description copied from interface: Player
    
    Teleport player to specified location
    
    Parameters:
    
    loc - location destination
  - teleport
```
public void teleport(Entity et)
```
    Description copied from interface: Player
    
    Teleport player to specified entity
    
    Parameters:
    
    et - entity destination
  - isSneaking
```
public boolean isSneaking()
```
  - setSneaking
```
public void setSneaking(boolean b)
```
  - isSprinting
```
public boolean isSprinting()
```
  - setSprinting
```
public void setSprinting(boolean b)
```
  - getTheoricVelocity
```
public Vector getTheoricVelocity()
```
    Description copied from interface: Player
    
    Get the velocity that the entity SHOULD be take
    
    Returns:
    
    the theoric (and platform) velocity
  - setVelocity
```
public void setVelocity(Vector vel)
```
    Description copied from interface: Player
    
    Edit the entity velocity
    
    Parameters:
    
    vel - the new velocity
  - getVehicle
```
public Entity getVehicle()
```
    Description copied from interface: Player
    
    Get the entity which is used as vehicle. It can be a wagon or a zombie.
    
    Returns:
    
    the vehicle entity
  - isInsideVehicle
```
public boolean isInsideVehicle()
```
    Description copied from interface: Player
    
    Check if player is in a vehicle.
    
    Returns:
    
    true if it is in vehicle
  - getItemInHand
```
public ItemStack getItemInHand()
```
    Description copied from interface: Player
    
    Get the item in main hand Return null if there is not any item in hand
    
    Returns:
    
    the item in hand
  - getItemInOffHand
```
public ItemStack getItemInOffHand()
```
    Description copied from interface: Player
    
    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
```
public boolean hasPotionEffect(PotionEffectType type)
```
  - getActivePotionEffect
```
public List<PotionEffect> getActivePotionEffect()
```
  - getPotionEffect
```
public Optional<PotionEffect> getPotionEffect(PotionEffectType type)
```
  - addPotionEffect
```
public void addPotionEffect(PotionEffectType type,
                            int duration,
                            int amplifier)
```
  - removePotionEffect
```
public void removePotionEffect(PotionEffectType type)
```
  - sendPluginMessage
```
public void sendPluginMessage(String channelId,
                              byte[] writeMessage)
```
    Description copied from interface: Player
    
    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
```
public List<Entity> getNearbyEntities(double x,
                                      double y,
                                      double z)
```
  - getInventory
```
public PlayerInventory getInventory()
```
  - getOpenInventory
```
public Inventory getOpenInventory()
```
  - hasOpenInventory
```
public boolean hasOpenInventory()
```
  - openInventory
```
public void openInventory(Inventory inv)
```
  - closeInventory
```
public void closeInventory()
```
  - updateInventory
```
public void updateInventory()
```
  - setVanished
```
public void setVanished(boolean vanished)
```
    Description copied from interface: Player
    
    Sets whether the play should be visible to other players.
    
    Parameters:
    
    vanished - true is the player should NOT be visible
  - getAddress
```
public InetSocketAddress getAddress()
```
    Description copied from interface: Player
    
    Get the player address
    
    Returns:
    
    the player inet address
  - sendToServer
```
public void sendToServer(String serverName)
```
    Description copied from interface: Player
    
    Send current player to the given server name.
    Work only with proxy (Bungee/Velocity)
    
    Parameters:
    
    serverName - the name of the proxy server
  - getServerName
```
public String getServerName()
```
    Description copied from interface: Player
    
    Get the name of the server where the player is actually
    
    Returns:
    
    the name of actual server
  - getUniqueId
```
public UUID getUniqueId()
```
  - isOnline
```
public boolean isOnline()
```
  - isOp
```
public boolean isOp()
```
    Description copied from interface: Entity
    
    Check if the actual entity is OP or not
    
    Returns:
    
    true if entity OP
  - getBoundingBox
```
public BoundingBox getBoundingBox()
```
    Description copied from interface: Entity
    
    Get the bounding box of the current entity
    
    Returns:
    
    the bounding box
  - getName
```
public String getName()
```
  - getDefault
```
public Object getDefault()
```
    Description copied from interface: NegativityObject
    
    Get default object which is abstracted by Negativity structure.
    For example, when we use World, beside there is the Spigot/Sponge... world. We can get the default platform object, in the example, the platform world.
    
    Returns:
    
    default object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CompensatedPlayer

Field Summary

Fields inherited from class com.elikill58.negativity.api.entity.AbstractPlayer

Constructor Summary

Method Summary

Methods inherited from class com.elikill58.negativity.api.entity.AbstractPlayer

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

CompensatedPlayer

Method Detail

getEyeHeight

getWorld

setWorld

getEntityId

getIP

isDead

isSleeping

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

getTheoricVelocity

setVelocity

getVehicle

isInsideVehicle

getItemInHand

getItemInOffHand

hasPotionEffect

getActivePotionEffect

getPotionEffect

addPotionEffect

removePotionEffect

sendPluginMessage

getNearbyEntities

getInventory

getOpenInventory

hasOpenInventory

openInventory

closeInventory

updateInventory

setVanished

getAddress

sendToServer

getServerName

getUniqueId

isOnline

isOp

getBoundingBox

getName

getDefault

toString