player

docs.globals.player

field signature:

player

typings.-1901885695

Method Property	Fluent Description	Representation
Field Type

Player.getFood

docs.player.getfood

overload 1:
                        
player:getFood()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getSaturation

docs.player.getsaturation

overload 1:
                        
player:getSaturation()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Player.getExperienceLevel

docs.player.getexperiencelevel

overload 1:
                        
player:getExperienceLevel()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getModelType

docs.player.getmodeltype

overload 1:
                        
player:getModelType()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.getGamemode

docs.player.getgamemode

overload 1:
                        
player:getGamemode()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.isFlying

docs.player.isflying

overload 1:
                        
player:isFlying()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getExperienceProgress

docs.player.getexperienceprogress

overload 1:
                        
player:getExperienceProgress()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Player.getBodyYaw

Inherited from LivingEntity

docs.player.getbodyyaw

overload 1:
                        
player:getBodyYaw()  
 Method Property Fluent Description Representation
Return Value a Number Number 
   
overload 2:
                        
player:getBodyYaw(delta)  
 Method Property Fluent Description Representation
delta accepts a Number Number 
   
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Method Property	Fluent Description	Representation
delta accepts	a Number	`Number`
Return Value	a Number	`Number`

Player.getHeldItem

Inherited from LivingEntity

docs.player.gethelditem

overload 1:
                        
player:getHeldItem()  
 Method Property Fluent Description Representation
Return Value an ItemStack ItemStack 
   
overload 2:
                        
player:getHeldItem(offhand)  
 Method Property Fluent Description Representation
offhand accepts a Boolean Boolean 
   
Return Value an ItemStack ItemStack

Method Property	Fluent Description	Representation
Return Value	an ItemStack	`ItemStack`

Method Property	Fluent Description	Representation
offhand accepts	a Boolean	`Boolean`
Return Value	an ItemStack	`ItemStack`

Player.getArmor

Inherited from LivingEntity

docs.player.getarmor

overload 1:
                        
player:getArmor()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getMaxHealth

Inherited from LivingEntity

docs.player.getmaxhealth

overload 1:
                        
player:getMaxHealth()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Player.getHealth

Inherited from LivingEntity

docs.player.gethealth

overload 1:
                        
player:getHealth()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Player.getArrowCount

Inherited from LivingEntity

docs.player.getarrowcount

overload 1:
                        
player:getArrowCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getActiveItem

Inherited from LivingEntity

docs.player.getactiveitem

overload 1:
                        
player:getActiveItem()  
 Method Property Fluent Description Representation
Return Value an ItemStack ItemStack

Method Property	Fluent Description	Representation
Return Value	an ItemStack	`ItemStack`

Player.getStingerCount

Inherited from LivingEntity

docs.player.getstingercount

overload 1:
                        
player:getStingerCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.isClimbing

Inherited from LivingEntity

docs.player.isclimbing

overload 1:
                        
player:isClimbing()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getActiveHand

Inherited from LivingEntity

docs.player.getactivehand

overload 1:
                        
player:getActiveHand()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.isLeftHanded

Inherited from LivingEntity

docs.player.islefthanded

overload 1:
                        
player:isLeftHanded()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getStatusEffects

Inherited from LivingEntity

docs.player.getstatuseffects

overload 1:
                        
player:getStatusEffects()  
 Method Property Fluent Description Representation
Return Value a table Table

Method Property	Fluent Description	Representation
Return Value	a table	`Table`

Player.isUsingItem

Inherited from LivingEntity

docs.player.isusingitem

overload 1:
                        
player:isUsingItem()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getDeathTime

Inherited from LivingEntity

docs.player.getdeathtime

overload 1:
                        
player:getDeathTime()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getName

Inherited from LivingEntity

docs.player.getname

overload 1:
                        
player:getName()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.getType

Inherited from LivingEntity

docs.player.gettype

overload 1:
                        
player:getType()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.exists

Inherited from LivingEntity

docs.player.exists

overload 1:
                        
player:exists()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getItem

Inherited from LivingEntity

docs.player.getitem

overload 1:
                        
player:getItem(index)  
 Method Property Fluent Description Representation
index accepts an Integer Integer 
   
Return Value an ItemStack ItemStack

Method Property	Fluent Description	Representation
index accepts	an Integer	`Integer`
Return Value	an ItemStack	`ItemStack`

Player.getPos

Inherited from LivingEntity

docs.player.getpos

overload 1:
                        
player:getPos()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3 
   
overload 2:
                        
player:getPos(delta)  
 Method Property Fluent Description Representation
delta accepts a Number Number 
   
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

Method Property	Fluent Description	Representation
delta accepts	a Number	`Number`
Return Value	a Vector3	`Vector3`

Player.getRot

Inherited from LivingEntity

docs.player.getrot

overload 1:
                        
player:getRot()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2 
   
overload 2:
                        
player:getRot(delta)  
 Method Property Fluent Description Representation
delta accepts a Number Number 
   
Return Value a Vector2 Vector2

Method Property	Fluent Description	Representation
Return Value	a Vector2	`Vector2`

Method Property	Fluent Description	Representation
delta accepts	a Number	`Number`
Return Value	a Vector2	`Vector2`

Player.isHamburger

Inherited from LivingEntity

docs.player.ishamburger

overload 1:
                        
player:isHamburger()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getLookDir

Inherited from LivingEntity

docs.player.getlookdir

overload 1:
                        
player:getLookDir()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

Player.getFrozenTicks

Inherited from LivingEntity

docs.player.getfrozenticks

overload 1:
                        
player:getFrozenTicks()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getUUID

Inherited from LivingEntity

docs.player.getuuid

overload 1:
                        
player:getUUID()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.getAir

Inherited from LivingEntity

docs.player.getair

overload 1:
                        
player:getAir()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getFireTicks

Inherited from LivingEntity

docs.player.getfireticks

overload 1:
                        
player:getFireTicks()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getMaxAir

Inherited from LivingEntity

docs.player.getmaxair

overload 1:
                        
player:getMaxAir()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Player.getDimensionName

Inherited from LivingEntity

docs.player.getdimensionname

overload 1:
                        
player:getDimensionName()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.getVelocity

Inherited from LivingEntity

docs.player.getvelocity

overload 1:
                        
player:getVelocity()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

Player.getPose

Inherited from LivingEntity

docs.player.getpose

overload 1:
                        
player:getPose()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

Player.getEyeY

Inherited from LivingEntity

docs.player.geteyey

overload 1:
                        
player:getEyeY()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Player.isSprinting

Inherited from LivingEntity

docs.player.issprinting

overload 1:
                        
player:isSprinting()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getVehicle

Inherited from LivingEntity

docs.player.getvehicle

overload 1:
                        
player:getVehicle()  
 typings.2080559107Method Property Fluent Description Representation
Return Value   
 

Method Property	Fluent Description	Representation
Return Value

Player.isInWater

Inherited from LivingEntity

docs.player.isinwater

overload 1:
                        
player:isInWater()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getEyeHeight

Inherited from LivingEntity

docs.player.geteyeheight

overload 1:
                        
player:getEyeHeight()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Player.isWet

Inherited from LivingEntity

docs.player.iswet

overload 1:
                        
player:isWet()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.isUnderwater

Inherited from LivingEntity

docs.player.isunderwater

overload 1:
                        
player:isUnderwater()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Player.getBoundingBox

Inherited from LivingEntity

docs.player.getboundingbox

overload 1:
                        
player:getBoundingBox()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

Player.hasAvatar

Inherited from LivingEntity

docs.player.hasavatar

overload 1:
                        
player:hasAvatar()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.isInLava

Inherited from LivingEntity

docs.player.isinlava

overload 1:
                        
player:isInLava()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.isInRain

Inherited from LivingEntity

docs.player.isinrain

overload 1:
                        
player:isInRain()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.isGlowing

Inherited from LivingEntity

docs.player.isglowing

overload 1:
                        
player:isGlowing()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.isInvisible

Inherited from LivingEntity

docs.player.isinvisible

overload 1:
                        
player:isInvisible()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.isSilent

Inherited from LivingEntity

docs.player.issilent

overload 1:
                        
player:isSilent()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.isSneaking

Inherited from LivingEntity

docs.player.issneaking

overload 1:
                        
player:isSneaking()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.isOnGround

Inherited from LivingEntity

docs.player.isonground

overload 1:
                        
player:isOnGround()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.getVariable

Inherited from LivingEntity

docs.player.getvariable

overload 1:
                        
player:getVariable(key)  
 Method Property Fluent Description Representation
key accepts a String String 
   
Return Value anything AnyType

Player.isOnFire

Inherited from LivingEntity

docs.player.isonfire

overload 1:
                        
player:isOnFire()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Player.getTargetedBlock

Inherited from LivingEntity

docs.player.gettargetedblock

overload 1:
                        
player:getTargetedBlock()  
 Method Property Fluent Description Representation
Return Value a BlockState BlockState 
   
overload 2:
                        
player:getTargetedBlock(ignoreLiquids)  
 Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean Boolean 
   
Return Value a BlockState BlockState 
   
overload 3:
                        
player:getTargetedBlock(ignoreLiquids, distance)  
 Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean Boolean 
   
distance accepts a Number Number 
   
Return Value a BlockState BlockState

Player.getNbt

Inherited from LivingEntity

docs.player.getnbt

overload 1:
                        
player:getNbt()  
 Method Property Fluent Description Representation
Return Value a table Table

Method Property	Fluent Description	Representation
ignoreLiquids accepts	a Boolean	`Boolean`
Return Value	a BlockState	`BlockState`

Global Objects

Miscellaneous Types

action_wheel

world

keybind

model

math

event

nameplate

entity

misc

Miscellaneous Enums

player

Player.getFood

Player.getSaturation

Player.getExperienceLevel

Player.getModelType

Player.getGamemode

Player.isFlying

Player.getExperienceProgress

Player.getBodyYaw

Player.getHeldItem

Player.getArmor

Player.getMaxHealth

Player.getHealth

Player.getArrowCount

Player.getActiveItem

Player.getStingerCount

Player.isClimbing

Player.getActiveHand

Player.isLeftHanded

Player.getStatusEffects

Player.isUsingItem

Player.getDeathTime

Player.getName

Player.getType

Player.exists

Player.getItem

Player.getPos

Player.getRot

Player.isHamburger

Player.getLookDir

Player.getFrozenTicks

Player.getUUID

Player.getAir

Player.getFireTicks

Player.getMaxAir

Player.getDimensionName

Player.getVelocity

Player.getPose

Player.getEyeY

Player.isSprinting

Player.getVehicle

Player.isInWater

Player.getEyeHeight

Player.isWet

Player.isUnderwater

Player.getBoundingBox

Player.hasAvatar

Player.isInLava

Player.isInRain

Player.isGlowing

Player.isInvisible

Player.isSilent

Player.isSneaking

Player.isOnGround

Player.getVariable

Player.isOnFire

Player.getTargetedBlock

Player.getNbt