listFiles
action_wheel
Action
BlockRaycastTypes Acts as a proxy for a player entity in the Minecraft world
A global instance exists for the avatar's user, under the name "player" 
Returns the amount of this entity's absorption (yellow hearts)
overload 1:
PlayerAPI.getAbsorptionAmount(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns "OFF_HAND" or "MAIN_HAND", depending on which hand this entity uses an item with
overload 1:
PlayerAPI.getActiveHand(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns an ItemStack representing the item the entity is currently using
If they're not using any item, returns air
overload 1:
PlayerAPI.getActiveItem(): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-148280555
Returns the ticks this entity's active item has been used for
overload 1:
PlayerAPI.getActiveItemTime(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns the amount of armor points this entity has
overload 1:
PlayerAPI.getArmor(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns the number of arrows sticking out of this entity
overload 1:
PlayerAPI.getArrowCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the yaw of this entity's body in degrees
If delta is passed in, then it will be used to linearly interpolate the rotation of the body between the previous tick and the current tick
The default value of delta is 1
overload 1:
PlayerAPI.getBodyYaw(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
overload 2:
PlayerAPI.getBodyYaw(delta: Number): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| delta accepts | typings.-1950496919||
| Return Value | typings.-1950496919
Returns the size of this entity's bounding box as a Vector3
{x, y, z} are the width, height, and width
Minecraft entity hitboxes always have square bases
overload 1:
PlayerAPI.getBoundingBox(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns the delay (in ticks) of charged attacks
overload 1:
PlayerAPI.getChargedAttackDelay(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Return the vehicle that this entity is controlling
overload 1:
PlayerAPI.getControlledVehicle(): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1263373079
Returns the entity that is controlling this entity
overload 1:
PlayerAPI.getControllingPassenger(): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1263373079
Returns the whether a given ItemStack has an active cool down as a percent from 0.0 to 1.0
If it has none, it returns 0.0
Takes two parameters stack, and delta, delta offsets the cooldown's tick count by it, used for smoother animation.
overload 1:
PlayerAPI.getCooldownPercent(stack: ItemStack, delta: Number): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| stack accepts | typings.-148280555||
| delta accepts | typings.-1950496919||
| Return Value | typings.-1950496919
Returns the number of ticks this entity has been dead for
overload 1:
PlayerAPI.getDeathTime(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets the Minecraft identifier of the dimension this entity is in
overload 1:
PlayerAPI.getDimensionName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the category of this entity
The categories are: "ARTHROPOD", "UNDEAD", "WATER", "ILLAGER" and by default, "UNDEFINED"
overload 1:
PlayerAPI.getEntityCategory(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the current exhaustion level of the player
overload 1:
PlayerAPI.getExhaustion(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets the player's current level
overload 1:
PlayerAPI.getExperienceLevel(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the progress of the way towards the player's next level, as a value from 0 to 1
overload 1:
PlayerAPI.getExperienceProgress(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns the current eye height of this entity
overload 1:
PlayerAPI.getEyeHeight(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns the Y level of this entity's eyes
Not to be confused with getEyeHeight, this function also takes the entity itself's Y position into account
overload 1:
PlayerAPI.getEyeY(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets the current food level of the player, from 0 to 20
overload 1:
PlayerAPI.getFood(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the number of ticks this entity has been freezing in powder snow for
overload 1:
PlayerAPI.getFrozenTicks(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns "SURVIVAL", "CREATIVE", "ADVENTURE", or "SPECTATOR" depending on the player's gamemode
If the gamemode is unknown, returns nil
overload 1:
PlayerAPI.getGamemode(): String | nil | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1209970754
Returns the amount of health this entity has remaining
overload 1:
PlayerAPI.getHealth(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns an ItemStack representing the item in this entity's main hand
If true is passed in for "offhand", then it will instead look at the item in the entity's offhand
If the entity isn't holding an item in that hand, returns air
overload 1:
PlayerAPI.getHeldItem(): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-148280555
overload 2:
PlayerAPI.getHeldItem(offhand: Boolean): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| offhand accepts | typings.1729365000||
| Return Value | typings.-148280555
Gets an ItemStack for the item in the given slot
For the player, slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet
If an invalid slot number is given, this will return nil
overload 1:
PlayerAPI.getItem(index: Integer): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| index accepts | typings.-672261858||
| Return Value | typings.-148280555
Returns a unit vector pointing in the direction that this entity is looking
See the blue line in the F3+B screen for an example
overload 1:
PlayerAPI.getLookDir(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Gets the maximum amount of air this entity can have
overload 1:
PlayerAPI.getMaxAir(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns the maximum amount of health this entity can have
overload 1:
PlayerAPI.getMaxHealth(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns "SLIM" or "DEFAULT", depending on the player's model type
overload 1:
PlayerAPI.getModelType(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the name of this entity, if it has a custom name
If it doesn't, returns a translated form of getType()
overload 1:
PlayerAPI.getName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets a table containing the NBT of this entity
Please note that not all values in the entity's NBT may be synced, as some are handled only on the server side
overload 1:
PlayerAPI.getNbt(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Returns the closest entity to this entity
If `type` is an entity id, (e.g. `minecraft:bee`), only entities of that type will be considered
Radius defaults to 20, and controls the size of the area for checking entities as a box expanding in every direction from the player
overload 1:
PlayerAPI.getNearestEntity(type: String, radius: Number): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| type accepts | typings.-1808118735||
| radius accepts | typings.-1950496919||
| Return Value | typings.1263373079
overload 2:
PlayerAPI.getNearestEntity(type: String): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| type accepts | typings.-1808118735||
| Return Value | typings.1263373079
overload 3:
PlayerAPI.getNearestEntity(): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1263373079
Returns a List of entities of all passengers this entity has
overload 1:
PlayerAPI.getPassengers(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Returns the permission level number of this entity
Server Operators, by default, have the permission level of 4
overload 1:
PlayerAPI.getPermissionLevel(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the position of the entity in the world
If delta is passed in, then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
PlayerAPI.getPos(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
overload 2:
PlayerAPI.getPos(delta: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| delta accepts | typings.-1950496919||
| Return Value | typings.2002444080
Returns the current pose of the player
This can be one of: "STANDING", "FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING"
overload 1:
PlayerAPI.getPose(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the rotation of the entity in degrees
If delta is passed in, then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick
The default value of delta is 1
overload 1:
PlayerAPI.getRot(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
overload 2:
PlayerAPI.getRot(delta: Number): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| delta accepts | typings.-1950496919||
| Return Value | typings.2002444079
Gets the current saturation level of the player
overload 1:
PlayerAPI.getSaturation(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns a table of the nbt of this entity left or right shoulder entity
overload 1:
PlayerAPI.getShoulderEntity(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
overload 2:
PlayerAPI.getShoulderEntity(right: Boolean): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| right accepts | typings.1729365000||
| Return Value | typings.80563118
Returns the number of bee stingers sticking out of this entity
overload 1:
PlayerAPI.getStingerCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns "OFF_HAND" or "MAIN_HAND", based on the arm this entity is currently swinging
overload 1:
PlayerAPI.getSwingArm(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the number of ticks this entity will have while swinging its arms
overload 1:
PlayerAPI.getSwingDuration(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns the number of ticks this entity has the arm swinging
overload 1:
PlayerAPI.getSwingTime(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns a proxy for your currently targeted BlockState
This BlockState appears on the F3 screen
The maximum (and default) distance is 20, minimum is -20
Returns the block, the hit position, and the targeted block face as three separate values
overload 1:
PlayerAPI.getTargetedBlock(): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1901216868
overload 2:
PlayerAPI.getTargetedBlock(ignoreLiquids: Boolean): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | typings.1729365000||
| Return Value | typings.1901216868
overload 3:
PlayerAPI.getTargetedBlock(ignoreLiquids: Boolean, distance: Number): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | typings.1729365000||
| distance accepts | typings.-1950496919||
| Return Value | typings.1901216868
Returns a proxy for your currently targeted Entity
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0
overload 1:
PlayerAPI.getTargetedEntity(): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1901216868
overload 2:
PlayerAPI.getTargetedEntity(distance: Number): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| distance accepts | typings.-1950496919||
| Return Value | typings.1901216868
Returns a table with information about the team of this player
Returns nil if the player doesn't have a team
overload 1:
PlayerAPI.getTeamInfo(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Gets the Minecraft identifier of this entity
For instance, "minecraft:pig"
overload 1:
PlayerAPI.getType(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the UUID of the proxied entity
overload 1:
PlayerAPI.getUUID(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the value of a variable this entity stored in themselves using the Avatar API's store() function
overload 1:
PlayerAPI.getVariable(): AnyType | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.821772070
overload 2:
PlayerAPI.getVariable(key: String): AnyType | Method Property | Fluent Description | Representation |
|---|---|---|
| key accepts | typings.-1808118735||
| Return Value | typings.821772070
Returns a proxy for the entity that this player is currently riding
If the player isn't riding anything, returns nil
overload 1:
PlayerAPI.getVehicle(): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1263373079
Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick
overload 1:
PlayerAPI.getVelocity(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns true if Figura has an avatar loaded for this entity
overload 1:
PlayerAPI.hasAvatar(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns whether the player has a cape loaded
overload 1:
PlayerAPI.hasCape(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the entity has a container (Chest Boats, Minecarts with Chests, …)
overload 1:
PlayerAPI.hasContainer(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the entity has an inventory (Horses, Camels, LLamas, …)
overload 1:
PlayerAPI.hasInventory(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns whether the player has a custom skin loaded
overload 1:
PlayerAPI.hasSkin(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns whether this entity is alive or not
overload 1:
PlayerAPI.isAlive(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Return if this entity is blocking with a shield
overload 1:
PlayerAPI.isBlocking(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if the entity is currently using a climbable block, like a ladder or vine
overload 1:
PlayerAPI.isClimbing(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is visually sneaking
overload 1:
PlayerAPI.isCrouching(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity has negative Y-velocity and is not on the ground
overload 1:
PlayerAPI.isFalling(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if the player is currently fishing
overload 1:
PlayerAPI.isFishing(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if this entity is gliding with an elytra
overload 1:
PlayerAPI.isGliding(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is currently glowing
overload 1:
PlayerAPI.isGlowing(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is currently in lava
overload 1:
PlayerAPI.isInLava(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is currently standing in rain
overload 1:
PlayerAPI.isInRain(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is currently in a water block, including waterlogging
overload 1:
PlayerAPI.isInWater(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is invisible, for one reason or another
overload 1:
PlayerAPI.isInvisible(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if the entity's main hand is its left
overload 1:
PlayerAPI.isLeftHanded(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets if this entity is a Living Entity
overload 1:
PlayerAPI.isLiving(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if this entity object is still being updated and loaded
A non-loaded entity would be someone or something which is in another dimension or out of the render distance for example
overload 1:
PlayerAPI.isLoaded(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity has some velocity
Takes a boolean parameter, where if true, the y velocity is ignored
overload 1:
PlayerAPI.isMoving(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
overload 2:
PlayerAPI.isMoving(ignoreY: Boolean): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreY accepts | typings.1729365000||
| Return Value | typings.1729365000
Returns true if this entity is currently on fire
overload 1:
PlayerAPI.isOnFire(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns whether or not this entity is currently on the ground
overload 1:
PlayerAPI.isOnGround(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets if this entity is a Player Entity
overload 1:
PlayerAPI.isPlayer(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if this entity takes damage to water
overload 1:
PlayerAPI.isSensitiveToWater(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is silent
overload 1:
PlayerAPI.isSilent(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns whether the specified skin layer, from the Skin Customizations settings, is currently visible
overload 1:
PlayerAPI.isSkinLayerVisible(part: String): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| part accepts | typings.-1808118735||
| Return Value | typings.1729365000
Returns true if this entity is logically sneaking (can't fall from blocks edges, can't see nameplate behind walls, etc)
overload 1:
PlayerAPI.isSneaking(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity is currently sprinting
overload 1:
PlayerAPI.isSprinting(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if the entity is currently swinging its arm
overload 1:
PlayerAPI.isSwingingArm(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this entity's eyes are touching water
overload 1:
PlayerAPI.isUnderwater(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if the entity is currently using an item
overload 1:
PlayerAPI.isUsingItem(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if this entity has the swimming pose
overload 1:
PlayerAPI.isVisuallySwimming(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column
Otherwise, returns false
overload 1:
PlayerAPI.isWet(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if this entity is riptide spinning
overload 1:
PlayerAPI.riptideSpinning(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000