This class describes a player in the server. cPlayer inherits all functions and members of
cPawn. It handles all the aspects of the gameplay, such as hunger, sprinting, inventory
etc.
| Name | Parameters | Return value | Notes |
|---|
| AddFoodExhaustion |
|
|
Adds the specified number to the food exhaustion. Only positive numbers expected. |
| CalcLevelFromXp |
|
|
(STATIC) Returns the level which is reached with the specified amount of XP. Inverse of XpForLevel(). |
| CanFly |
|
|
Returns if the player is able to fly. |
| CanMobsTarget |
|
|
Returns if the player can be targeted by mobs. |
| CloseWindow |
|
|
Closes the currently open UI window. If CanRefuse is true (default), the window may refuse the closing. |
| CloseWindowIfID |
| WindowID | number | | CanRefuse | boolean |
|
|
Closes the currently open UI window if its ID matches the given ID. If CanRefuse is true (default), the window may refuse the closing. |
| DeltaExperience |
|
|
Adds or removes XP from the current XP amount. Won't allow XP to go negative. Returns the new experience, -1 on error (XP overflow). |
| Feed |
| AddFood | number | | AddSaturation | number |
|
|
Tries to add the specified amounts to food level and food saturation level (only positive amounts expected). Returns true if player was hungry and the food was consumed, false if too satiated. |
| ForceSetSpeed |
|
|
Forces the player to move to the given direction. |
| Freeze |
|
|
Teleports the player to "Location" and prevents them from moving, locking them in place until unfreeze() is called |
| GetClientHandle |
|
|
Returns the client handle representing the player's connection. May be nil (AI players). |
| GetColor |
|
|
Returns the full color code to be used for this player's messages (based on their rank). Prefix player messages with this code. |
| GetCurrentXp |
|
|
Returns the current amount of XP |
| GetCustomName |
|
|
Returns the custom name of this player. If the player hasn't a custom name, it will return an empty string. |
| GetDraggingItem |
|
|
Returns the item the player is dragging in a UI window. |
| GetEffectiveGameMode |
|
|
(OBSOLETE) Returns the current resolved game mode of the player. If the player is set to inherit the world's gamemode, returns that instead. See also GetGameMode() and IsGameModeXXX() functions. Note that this function is the same as GetGameMode(), use that function instead. |
| GetEquippedItem |
|
|
Returns the item that the player is currently holding; empty item if holding nothing. |
| GetEyeHeight |
|
|
Returns the height of the player's eyes, in absolute coords |
| GetEyePosition |
|
|
Returns the position of the player's eyes, as a Vector3d |
| GetFloaterID |
|
|
Returns the Entity ID of the fishing hook floater that belongs to the player. Returns -1 if no floater is associated with the player. FIXME: Undefined behavior when the player has used multiple fishing rods simultanously. |
| GetFlyingMaxSpeed |
|
|
Returns the maximum flying speed, relative to the default game flying speed. Defaults to 1, but plugins may modify it for faster or slower flying. |
| GetFoodExhaustionLevel |
|
|
Returns the food exhaustion level |
| GetFoodLevel |
|
|
Returns the food level (number of half-drumsticks on-screen) |
| GetFoodSaturationLevel |
|
|
Returns the food saturation (overcharge of the food level, is depleted before food level) |
| GetFoodTickTimer |
|
|
Returns the number of ticks past the last food-based heal or damage action; when this timer reaches 80, a new heal / damage is applied. |
| GetGameMode |
|
|
Returns the player's gamemode. The player may have their gamemode unassigned, in which case they inherit the gamemode from the current world.
NOTE: Instead of comparing the value returned by this function to the gmXXX constants, use the IsGameModeXXX() functions. These functions handle the gamemode inheritance automatically. |
| GetIP |
|
|
Returns the IP address of the player, if available. Returns an empty string if there's no IP to report. |
| GetInventory |
|
|
Returns the player's inventory |
| GetLastBedPos |
|
|
Returns the player's respawn position. The player is guaranteed to respawn from death here if cPlayer:IsRespawnPointForced is true or if a bed exists at this position. |
| GetMaxSpeed |
|
|
Returns the player's current maximum speed, relative to the game default speed. Takes into account the sprinting / flying status. |
| GetName |
|
|
Returns the player's name |
| GetNormalMaxSpeed |
|
|
Returns the player's maximum walking speed, relative to the game default speed. Defaults to 1, but plugins may modify it for faster or slower walking. |
| GetPermissions |
|
|
Returns an array-table of all permissions (strings) that the player has assigned to them through their rank. |
| GetPlayerListName |
|
|
Returns the name that is used in the playerlist. |
| GetPrefix |
|
|
Returns the prefix to player names for messages (based on their rank), may contain @ format codes. |
| GetRestrictions |
|
|
Returns an array-table of all the restrictions that the player has assigned to them. |
| GetSkinParts |
|
|
Returns the player's current set of skin part flags. This is a bitwise OR of various eSkinPart constants. Note that HasSkinPart may be easier to use in most situations. |
| GetSprintingMaxSpeed |
|
|
Returns the player's maximum sprinting speed, relative to the game default speed. Defaults to 1.3, but plugins may modify it for faster or slower sprinting. |
| GetStatistics |
|
|
Returns the player's statistics manager. |
| GetSuffix |
|
|
Returns the suffix to player names for messages (based on their rank), may contain @ format codes. |
| GetTeam |
|
|
Returns the team that the player belongs to, or nil if none. |
| GetThrowSpeed |
|
|
Returns the speed vector for an object thrown with the specified speed coeff. Basically returns the normalized look vector multiplied by the coeff, with a slight random variation. |
| GetThrowStartPos |
|
|
Returns the position where the projectiles should start when thrown by this player. |
| GetUUID |
|
|
Returns the (short) UUID that the player is using. Could be empty string for players that don't have a Mojang account assigned to them (in the future, bots for example). |
| GetWindow |
|
|
Returns the currently open UI window. If the player doesn't have any UI window open, returns the inventory window. |
| GetXpLevel |
|
|
Returns the current XP level (based on current XP amount). |
| GetXpLifetimeTotal |
|
|
Returns the amount of XP that has been accumulated throughout the player's lifetime. |
| GetXpPercentage |
|
|
Returns the percentage of the experience bar - the amount of XP towards the next XP level. Between 0 and 1. |
| HasCustomName |
|
|
Returns true if the player has a custom name. |
| HasPermission |
|
|
Returns true if the player has the specified permission |
| HasSkinPart |
|
|
Returns true if the player has the specified skin part enabled |
| Heal |
|
|
Heals the player by the specified amount of HPs. Only positive amounts are expected. Sends a health update to the client. |
| IsEating |
|
|
Returns true if the player is currently eating the item in their hand. |
| IsFireproof |
|
|
Returns true if a player is fireproof. This is when the flag has been explicitly set, or the player is in creative or spectator mode. |
| IsFishing |
|
|
Returns true if the player is currently fishing |
| IsFlying |
|
|
Returns true if the player is flying. |
| IsFrozen |
|
|
Returns true if the player is frozen. See Freeze() |
| IsGameModeAdventure |
|
|
Returns true if the player is in the gmAdventure gamemode, or has their gamemode unset and the world is a gmAdventure world. |
| IsGameModeCreative |
|
|
Returns true if the player is in the gmCreative gamemode, or has their gamemode unset and the world is a gmCreative world. |
| IsGameModeSpectator |
|
|
Returns true if the player is in the gmSpectator gamemode, or has their gamemode unset and the world is a gmSpectator world. |
| IsGameModeSurvival |
|
|
Returns true if the player is in the gmSurvival gamemode, or has their gamemode unset and the world is a gmSurvival world. |
| IsInBed |
|
|
Returns true if the player is currently lying in a bed. |
| IsLeftHanded |
|
|
Returns true if the player's left hand is dominant. |
| IsRespawnPointForced |
|
|
Returns true if the player unconditionally respawns from death at the position given by cPlayer:GetLastBedPos with no bed checks performed. |
| IsSatiated |
|
|
Returns true if the player is satiated (cannot eat). |
| LoadRank |
|
|
Reloads the player's rank, message visuals and permissions from the cRankManager, based on the player's current rank. |
| OpenWindow |
|
|
Opens the specified UI window for the player. |
| PermissionMatches |
| Permission | string | | Template | string |
|
|
(STATIC) Returns true if the specified permission matches the specified template. The template may contain asterisk as a wildcard for any word. |
| PlaceBlock |
| BlockPos | Vector3i | | BlockType | number | | BlockMeta | number |
|
|
Places a block while impersonating the player. The HOOK_PLAYER_PLACING_BLOCK hook is called before the placement, and if it succeeds, the block is placed and the HOOK_PLAYER_PLACED_BLOCK hook is called. Returns true iff the block is successfully placed. |
| ReplaceOneEquippedItemTossRest |
|
|
Removes one item from the the current equipped item stack, and attempts to add the specified item stack back to the same slot. If it is not possible to place the item in the same slot, tries to place the specified item elsewhere in the inventory. If this is not possible, then any remaining items are tossed. If the currently equipped slot is empty, its contents are simply set to the given Item. |
| Respawn |
|
|
Restores the health, extinguishes fire, makes visible and sends the Respawn packet. |
| SendAboveActionBarMessage |
|
|
Sends the specified message to the player (shows above action bar). |
| SendBlocksAround |
| BlockX | number | | BlockY | number | | BlockZ | number | | BlockRange | number |
|
|
Sends all the world's blocks in BlockRange from the specified coords to the player, as a BlockChange packet. Range defaults to 1 (only one block sent). |
| SendMessage |
|
|
Sends the specified message to the player. |
| SendMessage |
|
|
Sends the cCompositeChat to the player, using a severity defined by the CompositeChat's MessageType. |
| SendMessageFailure |
|
|
Prepends Rose [INFO] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. For a command that failed to run because of insufficient permissions, etc. |
| SendMessageFatal |
|
|
Prepends Red [FATAL] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. For something serious, such as a plugin crash, etc. |
| SendMessageInfo |
|
|
Prepends Yellow [INFO] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. Informational message, such as command usage, etc. |
| SendMessagePrivateMsg |
| Message | string | | SenderName | string |
|
|
Prepends Light Blue [MSG: *SenderName*] / prepends SenderName and colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. For private messaging. |
| SendMessageRaw |
| Json | string | | eChatType | number |
|
|
Sends the specified json string to the player. The optional value eChatType (default ctChatBox) can be ctChatBox, ctSystem or ctAboveActionBar. You can use cJson to build a json string. |
| SendMessageSuccess |
|
|
Prepends Green [INFO] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. Success notification. |
| SendMessageWarning |
|
|
Prepends Rose [WARN] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. Denotes that something concerning, such as plugin reload, is about to happen. |
| SendRotation |
| YawDegrees | number | | PitchDegrees | number |
|
|
Sends the specified rotation to the player, forcing them to look that way |
| SendSystemMessage |
|
|
Sends the specified message to the player. |
| SetBedPos |
|
|
Sets the position and world of the player's bed. If the world is not specified, it is set to the player's current world. The player will respawn at this position and world upon death if there is a bed there. |
| SetCanFly |
|
|
Sets if the player can fly or not. |
| SetCrouch |
|
|
Sets the crouch state, broadcasts the change to other players. |
| SetCurrentExperience |
|
|
Sets the current amount of experience (and indirectly, the XP level). |
| SetCustomName |
|
|
Sets the custom name for this player. If you want to disable the custom name, simply set an empty string. The custom name will be used in the tab-list, in the player nametag and in the tab-completion. |
| SetDraggingItem |
|
|
Sets the item that the player is dragging in a UI window. If no UI window is open, this function does nothing. |
| SetElytraFlight |
|
|
Sets whether the player is elytra flying or not. |
| SetFlying |
|
|
Sets if the player is flying or not. |
| SetFlyingMaxSpeed |
|
|
Sets the flying maximum speed, relative to the game default speed. The default value is 1. Sends the updated speed to the client. |
| SetFoodExhaustionLevel |
|
|
Sets the food exhaustion to the specified level. |
| SetFoodLevel |
|
|
Sets the food level (number of half-drumsticks on-screen) |
| SetFoodSaturationLevel |
| FoodSaturationLevel | number |
|
|
Sets the food saturation (overcharge of the food level). |
| SetFoodTickTimer |
|
|
Sets the number of ticks past the last food-based heal or damage action; when this timer reaches 80, a new heal / damage is applied. |
| SetGameMode |
|
|
Sets the gamemode for the player. The new gamemode overrides the world's default gamemode, unless it is set to gmInherit. |
| SetIsFishing |
| IsFishing | boolean | | FloaterEntityID | number |
|
|
Sets the 'IsFishing' flag for the player. The floater entity ID is expected for the true variant, it can be omitted when IsFishing is false. FIXME: Undefined behavior when multiple fishing rods are used simultanously |
| SetLeftHanded |
|
|
Sets the dominant hand of the player. |
| SetNormalMaxSpeed |
|
|
Sets the normal (walking) maximum speed, relative to the game default speed. The default value is 1. Sends the updated speed to the client, if appropriate. |
| SetRespawnPosition |
|
|
Sets the position and world of the player's respawn point. The player will respawn at this position and world upon death. |
| SetSkinParts |
|
|
Sets the skin part flags of the player. The value should be a bitwise OR of several eSkinPart constants. |
| SetSprint |
|
|
Sets whether the player is sprinting or not. |
| SetSprintingMaxSpeed |
|
|
Sets the sprinting maximum speed, relative to the game default speed. The default value is 1.3. Sends the updated speed to the client, if appropriate. |
| SetTeam |
|
|
Moves the player to the specified team. |
| SetVisible |
|
|
Sets the player visibility to other players |
| SpectateEntity |
|
|
Spectates the target entity. Does not change the player's gamemode to spectator mode. When called with self or nil as the target, resets the spectation. |
| TossEquippedItem |
|
|
Tosses the item that the player has selected in their hotbar. Amount defaults to 1. |
| TossHeldItem |
|
|
Tosses the item held by the cursor, when the player is in a UI window. Amount defaults to 1. |
| TossPickup |
|
|
Tosses a pickup newly created from the specified item. |
| Unfreeze |
|
|
Allows the player to move again, canceling the effects of Freeze() |
| XpForLevel |
|
|
(STATIC) Returns the total amount of XP needed for the specified XP level. Inverse of CalcLevelFromXp(). |
| 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. |