From dbc657fd3c775b9e9bafc48104856eaf8061977e Mon Sep 17 00:00:00 2001 From: Foereaper Date: Wed, 5 Feb 2025 18:07:23 +0000 Subject: [PATCH] Update Eluna documentation --- Item/GetArmor.html | 165 ++++++++++++++++++++++++++++++++++ Item/GetDamageInfo.html | 176 +++++++++++++++++++++++++++++++++++++ Item/GetDurability.html | 165 ++++++++++++++++++++++++++++++++++ Item/GetMaxDurability.html | 165 ++++++++++++++++++++++++++++++++++ Item/GetSpeed.html | 165 ++++++++++++++++++++++++++++++++++ Item/GetStatInfo.html | 172 ++++++++++++++++++++++++++++++++++++ Item/index.html | 54 ++++++++++++ Item/sidebar.js | 6 ++ date.js | 2 +- search-index.js | 6 ++ 10 files changed, 1075 insertions(+), 1 deletion(-) create mode 100644 Item/GetArmor.html create mode 100644 Item/GetDamageInfo.html create mode 100644 Item/GetDurability.html create mode 100644 Item/GetMaxDurability.html create mode 100644 Item/GetSpeed.html create mode 100644 Item/GetStatInfo.html diff --git a/Item/GetArmor.html b/Item/GetArmor.html new file mode 100644 index 00000000..32f3657f --- /dev/null +++ b/Item/GetArmor.html @@ -0,0 +1,165 @@ + + + + + + + + + Item:GetArmor - Eluna + + + + + + + + + + + + + + + +
+

+ Method + Item:GetArmor + + + [-] + [+] + + +

+ + +
+

Returns the base armor of this Item

+ + +

+ Synopsis +

+

+ armor = Item:GetArmor() +

+ +

+ Arguments +

+

+ None. +

+ +

+ Returns +

+

+

+
number armor
+

Valid numbers: integers from 0 to 4,294,967,295.

+
+

+
+ +
+ + + + + + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Item/GetDamageInfo.html b/Item/GetDamageInfo.html new file mode 100644 index 00000000..de866b42 --- /dev/null +++ b/Item/GetDamageInfo.html @@ -0,0 +1,176 @@ + + + + + + + + + Item:GetDamageInfo - Eluna + + + + + + + + + + + + + + + +
+

+ Method + Item:GetDamageInfo + + + [-] + [+] + + +

+ + +
+

Returns the damage info of the specified damage slot of this Item

+ + +

+ Synopsis +

+

+ damageType, minDamage, maxDamage = Item:GetDamageInfo( damageSlot ) +

+ +

+ Arguments +

+

+

+
number damageSlot
+

The damage slot specified (1 or 2).

Valid numbers: integers from 0 to 255.

+
+

+ +

+ Returns +

+

+

+
number damageType
+

Valid numbers: integers from 0 to 4,294,967,295.

+
+
+
number minDamage
+

Valid numbers: all decimal numbers.

+
+
+
number maxDamage
+

Valid numbers: all decimal numbers.

+
+

+
+ +
+ + + + + + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Item/GetDurability.html b/Item/GetDurability.html new file mode 100644 index 00000000..f25c044e --- /dev/null +++ b/Item/GetDurability.html @@ -0,0 +1,165 @@ + + + + + + + + + Item:GetDurability - Eluna + + + + + + + + + + + + + + + +
+

+ Method + Item:GetDurability + + + [-] + [+] + + +

+ + +
+

Returns the current durability of this Item

+ + +

+ Synopsis +

+

+ durabiliy = Item:GetDurability() +

+ +

+ Arguments +

+

+ None. +

+ +

+ Returns +

+

+

+
number durabiliy
+

Valid numbers: integers from 0 to 4,294,967,295.

+
+

+
+ +
+ + + + + + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Item/GetMaxDurability.html b/Item/GetMaxDurability.html new file mode 100644 index 00000000..a76249e2 --- /dev/null +++ b/Item/GetMaxDurability.html @@ -0,0 +1,165 @@ + + + + + + + + + Item:GetMaxDurability - Eluna + + + + + + + + + + + + + + + +
+

+ Method + Item:GetMaxDurability + + + [-] + [+] + + +

+ + +
+

Returns the max durability of this Item

+ + +

+ Synopsis +

+

+ maxDurability = Item:GetMaxDurability() +

+ +

+ Arguments +

+

+ None. +

+ +

+ Returns +

+

+

+
number maxDurability
+

Valid numbers: integers from 0 to 4,294,967,295.

+
+

+
+ +
+ + + + + + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Item/GetSpeed.html b/Item/GetSpeed.html new file mode 100644 index 00000000..544c58f2 --- /dev/null +++ b/Item/GetSpeed.html @@ -0,0 +1,165 @@ + + + + + + + + + Item:GetSpeed - Eluna + + + + + + + + + + + + + + + +
+

+ Method + Item:GetSpeed + + + [-] + [+] + + +

+ + +
+

Returns the base attack speed of this Item

+ + +

+ Synopsis +

+

+ speed = Item:GetSpeed() +

+ +

+ Arguments +

+

+ None. +

+ +

+ Returns +

+

+

+
number speed
+

Valid numbers: integers from 0 to 4,294,967,295.

+
+

+
+ +
+ + + + + + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Item/GetStatInfo.html b/Item/GetStatInfo.html new file mode 100644 index 00000000..75902583 --- /dev/null +++ b/Item/GetStatInfo.html @@ -0,0 +1,172 @@ + + + + + + + + + Item:GetStatInfo - Eluna + + + + + + + + + + + + + + + +
+

+ Method + Item:GetStatInfo + + + [-] + [+] + + +

+ + +
+

Returns the stat info of the specified stat slot of this Item

+ + +

+ Synopsis +

+

+ statValue, statType = Item:GetStatInfo( statSlot ) +

+ +

+ Arguments +

+

+

+
number statSlot
+

The stat slot specified.

Valid numbers: integers from 0 to 255.

+
+

+ +

+ Returns +

+

+

+
number statValue
+

Valid numbers: integers from -2,147,483,647 to 2,147,483,647.

+
+
+
number statType
+

Valid numbers: integers from -2,147,483,647 to 2,147,483,647.

+
+

+
+ +
+ + + + + + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Item/index.html b/Item/index.html index 5e6fc72b..b2652a22 100644 --- a/Item/index.html +++ b/Item/index.html @@ -112,6 +112,15 @@

Methods

Returns the Player races allowed to use this Item

+ + + + GetArmor + + +

Returns the base armor of this Item

+ + @@ -166,6 +175,15 @@

Methods

Returns the Items stack count

+ + + + GetDamageInfo + + +

Returns the damage info of the specified damage slot of this Item

+ + @@ -175,6 +193,15 @@

Methods

Returns the display ID of the Item

+ + + + GetDurability + + +

Returns the current durability of this Item

+ + @@ -256,6 +283,15 @@

Methods

Returns the item set ID of this Item

+ + + + GetMaxDurability + + +

Returns the max durability of this Item

+ + @@ -346,6 +382,15 @@

Methods

Returns the Items current slot

+ + + + GetSpeed + + +

Returns the base attack speed of this Item

+ + @@ -364,6 +409,15 @@

Methods

Returns the spell trigger tied to the Item by spell index

+ + + + GetStatInfo + + +

Returns the stat info of the specified stat slot of this Item

+ + diff --git a/Item/sidebar.js b/Item/sidebar.js index a72af8dd..5e7a6301 100644 --- a/Item/sidebar.js +++ b/Item/sidebar.js @@ -3,13 +3,16 @@ document.write(` ClearEnchantment GetAllowableClass GetAllowableRace + GetArmor GetBagSize GetBagSlot GetBuyCount GetBuyPrice GetClass GetCount + GetDamageInfo GetDisplayId + GetDurability GetEnchantmentId GetExtraFlags GetFlags @@ -19,6 +22,7 @@ document.write(` GetItemLevel GetItemLink GetItemSet + GetMaxDurability GetMaxStackCount GetName GetOwner @@ -29,8 +33,10 @@ document.write(` GetRequiredLevel GetSellPrice GetSlot + GetSpeed GetSpellId GetSpellTrigger + GetStatInfo GetStatsCount GetSubClass HasQuest diff --git a/date.js b/date.js index 4b972df0..6f2e81ff 100644 --- a/date.js +++ b/date.js @@ -1 +1 @@ -document.write("30/11/2024"); \ No newline at end of file +document.write("05/02/2025"); \ No newline at end of file diff --git a/search-index.js b/search-index.js index ccd356e3..3f969a97 100644 --- a/search-index.js +++ b/search-index.js @@ -365,13 +365,16 @@ searchIndex["Aura"] = { [3, "ClearEnchantment", "", "Removes an enchant from the Item by the specified slot"], [3, "GetAllowableClass", "", "Returns the Player classes allowed to use this Item"], [3, "GetAllowableRace", "", "Returns the Player races allowed to use this Item"], + [3, "GetArmor", "", "Returns the base armor of this Item"], [3, "GetBagSize", "", "Returns the bag size of this Item, 0 if Item is not a bag"], [3, "GetBagSlot", "", "Returns the Items current bag slot"], [3, "GetBuyCount", "", "Returns the default purchase count of the Item"], [3, "GetBuyPrice", "", "Returns the purchase price of the Item"], [3, "GetClass", "", "Returns class of the Item"], [3, "GetCount", "", "Returns the Items stack count"], + [3, "GetDamageInfo", "", "Returns the damage info of the specified damage slot of this Item"], [3, "GetDisplayId", "", "Returns the display ID of the Item"], + [3, "GetDurability", "", "Returns the current durability of this Item"], [3, "GetEnchantmentId", "", "Returns the Items enchantment ID by enchant slot specified"], [3, "GetExtraFlags", "", "Returns the extraFlags of the Item"], [3, "GetFlags", "", "Returns the flags of the Item"], @@ -381,6 +384,7 @@ searchIndex["Aura"] = { [3, "GetItemLevel", "", "Returns the Items level"], [3, "GetItemLink", "", "Returns the chat link of the Item"], [3, "GetItemSet", "", "Returns the item set ID of this Item"], + [3, "GetMaxDurability", "", "Returns the max durability of this Item"], [3, "GetMaxStackCount", "", "Returns the Items max stack count"], [3, "GetName", "", "Returns the name of the Item"], [3, "GetOwner", "", "Returns the Player who currently owns the Item"], @@ -391,8 +395,10 @@ searchIndex["Aura"] = { [3, "GetRequiredLevel", "", "Returns the minimum level required to use this Item"], [3, "GetSellPrice", "", "Returns the sell price of the Item"], [3, "GetSlot", "", "Returns the Items current slot"], + [3, "GetSpeed", "", "Returns the base attack speed of this Item"], [3, "GetSpellId", "", "Returns the spell ID tied to the Item by spell index"], [3, "GetSpellTrigger", "", "Returns the spell trigger tied to the Item by spell index"], + [3, "GetStatInfo", "", "Returns the stat info of the specified stat slot of this Item"], [3, "GetStatsCount", "", "Returns the amount of stat values on this Item"], [3, "GetSubClass", "", "Returns subclass of the Item"], [3, "HasQuest", "", "Returns 'true' if the Item has the Quest specified tied to it, 'false' otherwise"],