Player (Cloudburst API 0.0.1-SNAPSHOT API)

All Superinterfaces:: Creature, Entity, InventoryHolder

public interface Player
extends Creature, InventoryHolder

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default byte`	`addWindow(Inventory window)`
`default byte`	`addWindow(Inventory window, Byte forceId)`
`byte`	`addWindow(Inventory window, Byte forceId, boolean isPermanent)`
`CardinalDirection`	`getCardinalDirection()`
`CraftingGrid`	`getCraftingInventory()`
`String`	`getDisplayName()`
`ContainerInventory`	`getEnderChestInventory()`
`OptionalLong`	`getFirstPlayed()` Returns the time this player first played on this server.
`GameMode`	`getGamemode()`
`PlayerInventory`	`getInventory()`
`OptionalLong`	`getLastPlayed()` Returns the time this player last joined in this server.
`Level`	`getLevel()`
`float`	`getMovementSpeed()`
`String`	`getName()` Returns the name of this player.
`Server`	`getServer()` Returns the `Server` object carrying this player.
`UUID`	`getServerId()`
`Skin`	`getSkin()`
`Location`	`getSpawn()`
`EnderChest`	`getViewingEnderChest()`
`byte`	`getWindowId(Inventory inventory)`
`String`	`getXuid()`
`boolean`	`hasPlayedBefore()` Checks if the player has played on this server before.
`boolean`	`isAdventure()`
`boolean`	`isBanned()` Checks if this player is banned.
`boolean`	`isConnected()`
`boolean`	`isCreative()`
`boolean`	`isInsideOfWater()`
`boolean`	`isOnGround()`
`boolean`	`isOnline()` Checks if this player is currently online.
`boolean`	`isOp()`
`boolean`	`isSleeping()`
`boolean`	`isSneaking()`
`boolean`	`isSpawned()`
`boolean`	`isSpectator()`
`boolean`	`isSurvival()`
`boolean`	`isWhitelisted()` Checks if this player is whitelisted.
`void`	`removeWindow(Inventory inventory)`
`void`	`resetInAirTicks()`
`default void`	`save()`
`void`	`save(boolean async)`
`void`	`setBanned(boolean value)` Sets this player to be banned or to be pardoned.
`void`	`setMovementSpeed(float speed)`
`void`	`setOp(boolean value)`
`void`	`setSkin(Skin newSkin)`
`void`	`setSpawn(Location spawn)`
`void`	`setViewingEnderChest(EnderChest chest)`
`void`	`setWhitelisted(boolean value)` Adds or removes this player from the whitelist.
`boolean`	`sleepOn(com.nukkitx.math.vector.Vector3i pos)`
`void`	`stopSleep()`

Methods inherited from interface org.cloudburstmc.api.entity.Entity
addEffect, attack, attack, canBeMovedByCurrents, canCollide, canCollideWith, canPassThrough, canTriggerPressurePlate, close, despawnFrom, despawnFromAll, dismount, extinguish, fall, getAbsorption, getBoundingBox, getChunk, getDirection, getDirectionPlane, getDirectionVector, getDrag, getEffect, getEffect, getEffects, getEyeHeight, getFireTicks, getGravity, getHealth, getHeight, getHighestPosition, getHorizontalDirection, getLastDamageCause, getLength, getLocation, getMaxHealth, getMotion, getNameTag, getNoDamageTicks, getOwner, getPassengers, getPitch, getPosition, getRuntimeId, getScale, getSeatPosition, getType, getUniqueId, getVehicle, getViewers, getWidth, getX, getY, getYaw, getZ, hasControllingPassenger, hasEffect, hasEffect, hasNameTag, heal, heal, isAlive, isClosed, isControlling, isNameTagVisible, isOnFire, isPassenger, isUndead, kill, mount, mount, onDismount, onEntityCollision, onInteract, onMount, onStruckByLightning, onUpdate, removeAllEffects, removeEffect, removeEffect, resetFallDistance, setAbsorption, setHealth, setHighestPosition, setMaxHealth, setMotion, setNameTag, setNameTagVisible, setNoDamageTicks, setOnFire, setOnGround, setOwner, setPosition, setPositionAndRotation, setRotation, setScale, setSeatPosition, spawnTo, spawnToAll, teleport, teleport, teleport, teleport

- Method Detail
  - isOnline
```
boolean isOnline()
```
    Checks if this player is currently online.
    
    Returns:
    
    true if they are online
  - getName
```
String getName()
```
    Returns the name of this player.
    
    Specified by:
    
    getName in interface Entity
    
    Returns:
    
    Player name
  - getServerId
```
UUID getServerId()
```
  - isBanned
```
boolean isBanned()
```
    Checks if this player is banned.
    
    Returns:
    
    true if banned
  - setBanned
```
void setBanned(boolean value)
```
    Sets this player to be banned or to be pardoned.
    
    Parameters:
    
    value - true if banned
  - isWhitelisted
```
boolean isWhitelisted()
```
    Checks if this player is whitelisted.
    
    Returns:
    
    true if whitelisted
  - setWhitelisted
```
void setWhitelisted(boolean value)
```
    Adds or removes this player from the whitelist.
    
    Parameters:
    
    value - true if whitelisted
  - getServer
```
Server getServer()
```
    Returns the Server object carrying this player.
    
    Specified by:
    
    getServer in interface Entity
    
    Returns:
    
    The server instance
  - getFirstPlayed
```
OptionalLong getFirstPlayed()
```
    Returns the time this player first played on this server.
    If the player has never played before, this will return 0. Otherwise, it will be the amount of milliseconds since midnight, January 1, 1970 UTC.
    
    Returns:
    
    An optional with the time this player first played on this server
  - getLastPlayed
```
OptionalLong getLastPlayed()
```
    Returns the time this player last joined in this server.
    If the player has never played before, this will return 0. Otherwise, it will be the amount of milliseconds since midnight, January 1, 1970 UTC.
    
    Returns:
    
    An optional with the time this player last played on this server
  - hasPlayedBefore
```
boolean hasPlayedBefore()
```
    Checks if the player has played on this server before.
    
    Returns:
    
    true if this player has played before
  - isInsideOfWater
```
boolean isInsideOfWater()
```
  - isSneaking
```
boolean isSneaking()
```
  - isSleeping
```
boolean isSleeping()
```
  - sleepOn
```
boolean sleepOn(com.nukkitx.math.vector.Vector3i pos)
```
  - stopSleep
```
void stopSleep()
```
  - isOnGround
```
boolean isOnGround()
```
    Specified by:
    
    isOnGround in interface Entity
  - getInventory
```
PlayerInventory getInventory()
```
    Specified by:
    
    getInventory in interface InventoryHolder
  - getEnderChestInventory
```
ContainerInventory getEnderChestInventory()
```
  - getCraftingInventory
```
CraftingGrid getCraftingInventory()
```
  - setOp
```
void setOp(boolean value)
```
  - isOp
```
boolean isOp()
```
  - setMovementSpeed
```
void setMovementSpeed(float speed)
```
  - getMovementSpeed
```
float getMovementSpeed()
```
  - getLevel
```
Level getLevel()
```
    Specified by:
    
    getLevel in interface Entity
  - isSpectator
```
boolean isSpectator()
```
  - isCreative
```
boolean isCreative()
```
  - isSurvival
```
boolean isSurvival()
```
  - resetInAirTicks
```
void resetInAirTicks()
```
  - isSpawned
```
boolean isSpawned()
```
  - getGamemode
```
GameMode getGamemode()
```
  - getWindowId
```
byte getWindowId(Inventory inventory)
```
  - addWindow
```
default byte addWindow(Inventory window)
```
  - addWindow
```
default byte addWindow(Inventory window,
                       Byte forceId)
```
  - addWindow
```
byte addWindow(Inventory window,
               Byte forceId,
               boolean isPermanent)
```
  - removeWindow
```
void removeWindow(Inventory inventory)
```
  - getDisplayName
```
String getDisplayName()
```
  - getXuid
```
String getXuid()
```
  - isConnected
```
boolean isConnected()
```
  - save
```
default void save()
```
  - save
```
void save(boolean async)
```
  - getCardinalDirection
```
CardinalDirection getCardinalDirection()
```
  - isAdventure
```
boolean isAdventure()
```
  - getSpawn
```
Location getSpawn()
```
  - setSpawn
```
void setSpawn(Location spawn)
```
  - getSkin
```
Skin getSkin()
```
  - setSkin
```
void setSkin(Skin newSkin)
```
  - getViewingEnderChest
```
EnderChest getViewingEnderChest()
```
  - setViewingEnderChest
```
void setViewingEnderChest(EnderChest chest)
```

Interface Player

Method Summary

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

Method Detail

isOnline

getName

getServerId

isBanned

setBanned

isWhitelisted

setWhitelisted

getServer

getFirstPlayed

getLastPlayed

hasPlayedBefore

isInsideOfWater

isSneaking

isSleeping

sleepOn

stopSleep

isOnGround

getInventory

getEnderChestInventory

getCraftingInventory

setOp

isOp

setMovementSpeed

getMovementSpeed

getLevel

isSpectator

isCreative

isSurvival

resetInAirTicks

isSpawned

getGamemode

getWindowId

addWindow

addWindow

addWindow

removeWindow

getDisplayName

getXuid

isConnected

save

save

getCardinalDirection

isAdventure

getSpawn

setSpawn

getSkin

setSkin

getViewingEnderChest

setViewingEnderChest