diff options
Diffstat (limited to 'Server/Plugins/APIDump/APIDesc.lua')
| -rw-r--r-- | Server/Plugins/APIDump/APIDesc.lua | 116 |
1 files changed, 45 insertions, 71 deletions
diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua index bebcda6d6..888ce9aef 100644 --- a/Server/Plugins/APIDump/APIDesc.lua +++ b/Server/Plugins/APIDump/APIDesc.lua @@ -3831,6 +3831,16 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") }, Notes = "(<b>DEPRECATED</b>) Please use cEntity:IsTicking().", }, + IsElytraFlying = + { + Returns = + { + { + Type = "boolean", + }, + }, + Notes = "Returns true if the entity is flying with an elytra. Entities that cannot fly with an elytra return always false.", + }, IsEnderCrystal = { Returns = @@ -3881,7 +3891,7 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") }, Notes = "Returns true if the entity represents a fishing rod floater", }, - IsInvisible = + IsHeadInWater = { Returns = { @@ -3889,9 +3899,9 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") Type = "boolean", }, }, - Notes = "Returns true if the entity is invisible", + Notes = "Returns true if the entity's head is in a water block", }, - IsInFire = + IsInvisible = { Returns = { @@ -3899,9 +3909,9 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") Type = "boolean", }, }, - Notes = "Returns true if any part of the entity is in a fire block", + Notes = "Returns true if the entity is invisible.", }, - IsInLava = + IsInFire = { Returns = { @@ -3909,9 +3919,9 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") Type = "boolean", }, }, - Notes = "Returns true if any part of the entity is in a lava block", + Notes = "Returns true if any part of the entity is in a fire block", }, - IsInWater = + IsInLava = { Returns = { @@ -3919,9 +3929,9 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") Type = "boolean", }, }, - Notes = "Returns true if any part of the entity is in a water block", + Notes = "Returns true if any part of the entity is in a lava block", }, - IsHeadInWater = + IsInWater = { Returns = { @@ -3929,7 +3939,7 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") Type = "boolean", }, }, - Notes = "Returns true if the entity's head is in a water block", + Notes = "Returns true if any part of the entity is in a water block", }, IsItemFrame = { @@ -4071,16 +4081,6 @@ local Hash = cCryptoHash.sha1HexString("DataToHash") }, Notes = "Returns true if the entity is sprinting. Entities that cannot sprint return always false", }, - IsElytraFlying = - { - Returns = - { - { - Type = "boolean", - }, - }, - Notes = "Returns true if the entity is flying with an elytra. Entities that cannot fly with an elytra return always false", - }, IsSubmerged = { Returns = @@ -10449,16 +10449,6 @@ a_Player:OpenWindow(Window); }, Notes = "Returns the player's current maximum speed, relative to the game default speed. Takes into account the sprinting / flying status.", }, - GetMainHand = - { - Returns = - { - { - Type = "eMainHand", - }, - }, - Notes = "Returns the player's main hand.", - }, GetName = { Returns = @@ -10771,6 +10761,16 @@ a_Player:OpenWindow(Window); }, Notes = "Returns true if the player is currently lying in a bed.", }, + IsLeftHanded = + { + Returns = + { + { + Type = "boolean", + }, + }, + Notes = "Returns true if the player's left hand is dominant.", + }, IsSatiated = { Returns = @@ -11101,6 +11101,17 @@ a_Player:OpenWindow(Window); }, Notes = "Sets the item that the player is dragging in a UI window. If no UI window is open, this function does nothing." }, + SetElytraFlight = + { + Params = + { + { + Name = "IsElytraFlying", + Type = "boolean", + }, + }, + Notes = "Sets whether the player is elytra flying or not.", + }, SetFlying = { Params = @@ -11194,16 +11205,16 @@ a_Player:OpenWindow(Window); }, Notes = "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", }, - SetMainHand = + SetLeftHanded = { Params = { { - Name = "Hand", - Type = "eMainHand", + Name = "IsLeftHanded", + Type = "boolean", }, }, - Notes = "Sets the main hand of the player.", + Notes = "Sets the dominant hand of the player.", }, SetName = { @@ -11249,17 +11260,6 @@ a_Player:OpenWindow(Window); }, Notes = "Sets the skin part flags of the player. The value should be a bitwise OR of several {{Globals#eSkinPart|eSkinPart}} constants.", }, - SetElytraFlight = - { - Params = - { - { - Name = "IsElytraFlying", - Type = "boolean", - }, - }, - Notes = "Sets whether the player is elytra flying or not.", - }, SetSprintingMaxSpeed = { Params = @@ -17925,32 +17925,6 @@ end gmXXX constants, the eGameMode_ constants are deprecated and will be removed from the API. ]], }, - eHand = - { - Include = - { - "hMain", - "hOff", - }, - TextBefore = [[ - These constants represent the main and off hand. Currently, these constants are not used, but - are provided for future use when dual-wielding is functional. An action or item can be in the - main hand or the off hand. The main hand can be either the left or the right hand - use - {{cPlayer}}:GetMainHand() to determine which (see {{Globals#eMainHand|eMainHand}}). - ]], - }, - eMainHand = - { - Include = - { - "^mh.*", - }, - TextBefore = [[ - These constants identify which hand is the main hand. The main hand can either be the left hand - or the right hand. Note that this is only visual, as the client behaves the same regardless of the - main hand setting. See {{cPlayer}}:GetMainHand(). - ]], - }, EMCSBiome = { Include = "^bi.*", |