cPawn is a controllable pawn object, controlled by either AI or a player. cPawn inherits all functions and members of cEntity
| Name | Parameters | Return value | Notes |
|---|
| AddPosX |
|
|
Moves the entity by the specified amount in the X axis direction |
| AddPosY |
|
|
Moves the entity by the specified amount in the Y axis direction |
| AddPosZ |
|
|
Moves the entity by the specified amount in the Z axis direction |
| AddPosition |
|
|
Moves the entity by the specified amount in each direction |
| AddPosition |
| OffsetX | number | | OffsetY | number | | OffsetZ | number |
|
|
Moves the entity by the specified amount in each axis direction |
| AddSpeed |
| AddX | number | | AddY | number | | AddZ | number |
|
|
Adds the specified amount of speed in each axis direction. |
| AddSpeed |
|
|
Adds the specified amount of speed in each axis direction. |
| AddSpeedX |
|
|
Adds the specified amount of speed in the X axis direction. |
| AddSpeedY |
|
|
Adds the specified amount of speed in the Y axis direction. |
| AddSpeedZ |
|
|
Adds the specified amount of speed in the Z axis direction. |
| ApplyArmorDamage |
|
|
Lowers armor durability, as if the armor blocked the given amount of damage. |
| ArmorCoversAgainst |
|
|
Returns whether armor will protect against the specified damage type |
| Destroy |
| ShouldBroadcast (DEPRECATED) | boolean |
|
|
Schedules the entity to be destroyed; broadcasts the DestroyEntity packet |
| DoesPreventBlockPlacement |
|
|
Returns true if this entity doesn't allow blocks to be placed intersecting the entity. |
| GetAirDrag |
|
|
(undocumented) |
| GetAirLevel |
|
|
Returns the air level (number of ticks of air left). Note, this function is only updated with mobs or players. |
| GetArmorCoverAgainst |
|
|
Returns the number of hitpoints out of RawDamage that the currently equipped armor would cover. See TakeDamageInfo for more information on attack damage. |
| GetBoundingBox |
|
|
Returns the bounding box of the entity, which has width and height corresponding to the entity, and is aligned with the block grid. |
| GetChunkX |
|
|
Returns the X-coord of the chunk in which the entity is placed |
| GetChunkZ |
|
|
Returns the Z-coord of the chunk in which the entity is placed |
| GetClass |
|
|
Returns the classname of the entity, such as "cSpider" or "cPickup" |
| GetClassStatic |
|
|
(STATIC) Returns the entity classname that this class implements. Each descendant overrides this function. |
| GetEnchantmentBlastKnockbackReduction |
|
|
Returns explosion knock back reduction percent from blast protection level. |
| GetEnchantmentCoverAgainst |
|
|
Returns the number of hitpoints out of RawDamage that the enchantments on the currently equipped armor would cover. See TakeDamageInfo for more information on attack damage. |
| GetEntityType |
|
|
Returns the type of the entity, one of the etXXX constants. Note that to check specific entity type, you should use one of the IsXXX functions instead of comparing the value returned by this call. |
| GetEquippedBoots |
|
|
Returns the boots that the entity has equipped. Returns an empty cItem if no boots equipped or not applicable. |
| GetEquippedChestplate |
|
|
Returns the chestplate that the entity has equipped. Returns an empty cItem if no chestplate equipped or not applicable. |
| GetEquippedHelmet |
|
|
Returns the helmet that the entity has equipped. Returns an empty cItem if no helmet equipped or not applicable. |
| GetEquippedLeggings |
|
|
Returns the leggings that the entity has equipped. Returns an empty cItem if no leggings equipped or not applicable. |
| GetEquippedWeapon |
|
|
Returns the weapon that the entity has equipped. Returns an empty cItem if no weapon equipped or not applicable. |
| GetGravity |
|
|
Returns the number that is used as the gravity for physics simulation. 1G (9.78) by default. |
| GetHeadYaw |
|
|
Returns the pitch of the entity's head (FIXME: Rename to GetHeadPitch() ). |
| GetHealth |
|
|
Returns the current health of the entity. |
| GetHeight |
|
|
Returns the height (Y size) of the entity |
| GetInvulnerableTicks |
|
|
Returns the number of ticks that this entity will be invulnerable for. This is used for after-hit recovery - the entities are invulnerable for half a second after being hit. |
| GetKnockbackAmountAgainst |
|
|
Returns the amount of knockback that the currently equipped items would cause when attacking the ReceiverEntity. |
| GetLookVector |
|
|
Returns the vector that defines the direction in which the entity is looking |
| GetMass |
|
|
Returns the mass of the entity. Currently unused. |
| GetMaxHealth |
|
|
Returns the maximum number of hitpoints this entity is allowed to have. |
| GetOffHandEquipedItem |
|
|
Returns the item that the entity has equipped on off-hand. Returns an empty cItem if no item equipped or not applicable. |
| GetParentClass |
|
|
Returns the name of the direct parent class for this entity |
| GetPitch |
|
|
Returns the pitch (nose-down rotation) of the entity. Measured in degrees, normal values range from -90 to +90. +90 means looking down, 0 means looking straight ahead, -90 means looking up. |
| GetPosX |
|
|
Returns the X-coord of the entity's pivot |
| GetPosY |
|
|
Returns the Y-coord of the entity's pivot |
| GetPosZ |
|
|
Returns the Z-coord of the entity's pivot |
| GetPosition |
|
|
Returns the entity's pivot position as a 3D vector |
| GetRawDamageAgainst |
|
|
Returns the raw damage that this entity's equipment would cause when attacking the ReceiverEntity. This includes this entity's weapon enchantments, but excludes the receiver's armor or potion effects. See TakeDamageInfo for more information on attack damage. |
| GetRoll |
|
|
Returns the roll (sideways rotation) of the entity. Currently unused. |
| GetSpeed |
|
|
Returns the complete speed vector of the entity |
| GetSpeedX |
|
|
Returns the X-part of the speed vector |
| GetSpeedY |
|
|
Returns the Y-part of the speed vector |
| GetSpeedZ |
|
|
Returns the Z-part of the speed vector |
| GetTicksAlive |
|
|
Returns the number of ticks that this entity has been alive for. |
| GetUniqueID |
|
|
Returns the ID that uniquely identifies the entity within the running server. Note that this ID is not persisted to the data files. |
| GetWidth |
|
|
Returns the width (X and Z size) of the entity. |
| GetWorld |
|
|
Returns the world where the entity resides |
| GetYaw |
|
|
Returns the yaw (direction) of the entity. Measured in degrees, values range from -180 to +180. 0 means ZP, 90 means XM, -180 means ZM, -90 means XP. |
| HandleSpeedFromAttachee |
| ForwardAmount | number | | SidewaysAmount | number |
|
|
Updates the entity's speed based on the attachee exerting the specified force forward and sideways. Used for entities being driven by other entities attached to them - usually players driving minecarts and boats. |
| Heal |
|
|
Heals the specified number of hitpoints. Hitpoints is expected to be a positive number. |
| IsA |
|
|
Returns true if the entity class is a descendant of the specified class name, or the specified class itself |
| IsArrow |
|
|
Returns true if the entity is an arrow. |
| IsBoat |
|
|
Returns true if the entity is a boat. |
| IsCrouched |
|
|
Returns true if the entity is crouched. Always false for entities that don't support crouching. |
| IsDestroyed |
|
|
(DEPRECATED) Please use cEntity:IsTicking(). |
| IsElytraFlying |
|
|
Returns true if the entity is flying with an elytra. Entities that cannot fly with an elytra return always false. |
| IsEnderCrystal |
|
|
Returns true if the entity is an ender crystal. |
| IsExpOrb |
|
|
Returns true if the entity represents an experience orb |
| IsFallingBlock |
|
|
Returns true if the entity represents a cFallingBlock entity. |
| IsFireproof |
|
|
Returns true if the entity takes no damage from being on fire. |
| IsFloater |
|
|
Returns true if the entity represents a fishing rod floater |
| IsHeadInWater |
|
|
Returns true if the entity's head is in a water block |
| IsInFire |
|
|
Returns true if any part of the entity is in a fire block |
| IsInLava |
|
|
Returns true if any part of the entity is in a lava block |
| IsInWater |
|
|
Returns true if any part of the entity is in a water block |
| IsInvisible |
|
|
Returns true if the entity is invisible. |
| IsItemFrame |
|
|
Returns true if the entity is an item frame. |
| IsLeashKnot |
|
|
Returns true if the entity is a leash knot. |
| IsMinecart |
|
|
Returns true if the entity represents a minecart |
| IsMob |
|
|
Returns true if the entity represents any mob. |
| IsOnFire |
|
|
Returns true if the entity is on fire |
| IsOnGround |
|
|
Returns true if the entity is on ground (not falling, not jumping, not flying) |
| IsPainting |
|
|
Returns if this entity is a painting. |
| IsPawn |
|
|
Returns true if the entity is a cPawn descendant. |
| IsPickup |
|
|
Returns true if the entity represents a pickup. |
| IsPlayer |
|
|
Returns true if the entity represents a player |
| IsProjectile |
|
|
Returns true if the entity is a cProjectileEntity descendant. |
| IsRclking |
|
|
Currently unimplemented |
| IsRiding |
|
|
Returns true if the entity is attached to (riding) another entity. |
| IsSprinting |
|
|
Returns true if the entity is sprinting. Entities that cannot sprint return always false |
| IsSubmerged |
|
|
Returns true if the entity's head is in a water block Currently deprecated in favour of IsHeadInWater() |
| IsSwimming |
|
|
Returns true if any part of the entity is in a water block. Note, this function is only updated with mobs or players. Currently deprecated in favour of IsInWater() |
| IsTNT |
|
|
Returns true if the entity represents a TNT entity |
| IsTicking |
|
|
Returns true if the entity is valid and ticking. Returns false if the entity is not ticking and is about to leave its current world either via teleportation or destruction. If this returns false, you must stop using the cEntity pointer you have. |
| Killed |
|
|
This entity has killed another entity (the Victim). For players, adds the scoreboard statistics about the kill. |
| MoveToWorld |
| WorldName | string | | ShouldSendRespawn | boolean |
|
|
Removes the entity from this world and starts moving it to the specified world's spawn point. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions). |
| MoveToWorld |
| World | cWorld | | ShouldSendRespawn | boolean |
|
|
Removes the entity from this world and starts moving it to the specified world's spawn point. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions). |
| MoveToWorld |
|
|
Removes the entity from this world and starts moving it to the specified world. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions). The Position parameter specifies the location that the entity should be placed in, in the new world. |
| MoveToWorld |
| World | cWorld | | Position | Vector3d | | ShouldSetPortalCooldown | boolean | | ShouldSendRespawn | boolean |
|
|
Removes the entity from this world and starts moving it to the specified world. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. If ShouldSetPortalCooldown is false (default), doesn't set any portal cooldown, if it is true, the default portal cooldown is applied to the entity. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions). The Position parameter specifies the location that the entity should be placed in, in the new world. |
| SetAirDrag |
|
|
(undocumented) |
| SetGravity |
|
|
Sets the number that is used as the gravity for physics simulation. 1G (9.78) by default. |
| SetHeadYaw |
|
|
Sets the head pitch (FIXME: Rename to SetHeadPitch() ). |
| SetHealth |
|
|
Sets the entity's health to the specified amount of hitpoints. Doesn't broadcast any hurt animation. Doesn't kill the entity if health drops below zero. Use the TakeDamage() function instead for taking damage. |
| SetInvulnerableTicks |
|
|
Sets the amount of ticks for which the entity will not receive any damage from other entities. |
| SetIsFireproof |
|
|
Sets whether the entity receives damage from being on fire. |
| SetMass |
|
|
Sets the mass of the entity. Currently unused. |
| SetMaxHealth |
|
|
Sets the maximum hitpoints of the entity. If current health is above MaxHitpoints, it is capped to MaxHitpoints. |
| SetPitch |
|
|
Sets the pitch (nose-down rotation) of the entity |
| SetPitchFromSpeed |
|
|
Sets the entity pitch to match its speed (entity looking forwards as it moves) |
| SetPosX |
|
|
Sets the X-coord of the entity's pivot |
| SetPosY |
|
|
Sets the Y-coord of the entity's pivot |
| SetPosZ |
|
|
Sets the Z-coord of the entity's pivot |
| SetPosition |
|
|
Sets all three coords of the entity's pivot |
| SetPosition |
| PosX | number | | PosY | number | | PosZ | number |
|
|
Sets all three coords of the entity's pivot |
| SetRoll |
|
|
Sets the roll (sideways rotation) of the entity. Currently unused. |
| SetSpeed |
|
|
Sets the current speed of the entity |
| SetSpeed |
| SpeedX | number | | SpeedY | number | | SpeedZ | number |
|
|
Sets the current speed of the entity |
| SetSpeedX |
|
|
Sets the X component of the entity speed |
| SetSpeedY |
|
|
Sets the Y component of the entity speed |
| SetSpeedZ |
|
|
Sets the Z component of the entity speed |
| SetYaw |
|
|
Sets the yaw (direction) of the entity. |
| SetYawFromSpeed |
|
|
Sets the entity's yaw to match its current speed (entity looking forwards as it moves). |
| StartBurning |
|
|
Sets the entity on fire for the specified number of ticks. If entity is on fire already, makes it burn for either NumTicks or the number of ticks left from the previous fire, whichever is larger. |
| SteerVehicle |
| ForwardAmount | number | | SidewaysAmount | number |
|
|
Applies the specified steering to the vehicle this entity is attached to. Ignored if not attached to any entity. |
| StopBurning |
|
|
Extinguishes the entity fire, cancels all fire timers. |
| TakeDamage |
|
|
Causes this entity to take damage that AttackerEntity would inflict. Includes their weapon and this entity's armor. |
| TakeDamage |
| DamageType | eDamageType | | AttackerEntity | cEntity | | RawDamage | number | | FinalDamage | number | | KnockbackAmount | number |
|
|
Causes this entity to take damage of the specified type, from the specified attacker (may be nil). The values are wrapped into a TakeDamageInfo structure and applied directly. |
| TakeDamage |
|
|
Causes this entity to take damage of the specified type, from the specified attacker (may be nil). The final damage is calculated from RawDamage using the currently equipped armor. |
| TeleportToCoords |
| PosX | number | | PosY | number | | PosZ | number |
|
|
Teleports the entity to the specified coords. Asks plugins if the teleport is allowed. |
| TeleportToEntity |
|
|
Teleports this entity to the specified destination entity. Asks plugins if the teleport is allowed. |