diff --git a/Player/AddLifetimeKills.html b/Player/AddLifetimeKills.html index a35196ac..71031983 100644 --- a/Player/AddLifetimeKills.html +++ b/Player/AddLifetimeKills.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Adds or detracts from the Players current lifetime kill count

Synopsis

- Player:AddLifetimeKills() + Player:AddLifetimeKills( kills )

Arguments

- Unknown. +

+
number kills
+

Positive number to add, negative number to detract.

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

+

Returns

- Unknown. + Nothing.

diff --git a/Player/AddTalent.html b/Player/AddTalent.html index 2a3bed0b..06db8887 100644 --- a/Player/AddTalent.html +++ b/Player/AddTalent.html @@ -87,29 +87,45 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Adds a talent to the Player for the specified spec and learning status.

Synopsis

- Player:AddTalent() + success = Player:AddTalent( spellId, spec ) +

+

+ success = Player:AddTalent( spellId, spec, learning )

Arguments

- Unknown. +

+
number spellId
+

ID of the spell for the talent.

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

+
+
+
number spec
+

The spec to which the talent applies.

Valid numbers: integers from 0 to 255.

+
+
+
boolean learning (true)
+

Whether the talent is being learned.

+

Returns

- Unknown. +

+
boolean success
+

True if the talent was added, false otherwise.

+

diff --git a/Player/BindToInstance.html b/Player/BindToInstance.html index ab5c4880..de257944 100644 --- a/Player/BindToInstance.html +++ b/Player/BindToInstance.html @@ -87,8 +87,7 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Binds the Player to their current instance.

@@ -102,14 +101,14 @@

Arguments

- Unknown. + None.

Returns

- Unknown. + Nothing.

diff --git a/Player/EquipItem.html b/Player/EquipItem.html index 4d4660d7..62b5ad20 100644 --- a/Player/EquipItem.html +++ b/Player/EquipItem.html @@ -88,37 +88,102 @@

Equips the given item or item entry to the given slot. Returns the equipped item or nil.

-
enum EquipmentSlots // 19 slots
-{
-    EQUIPMENT_SLOT_START        = 0,
-    EQUIPMENT_SLOT_HEAD         = 0,
-    EQUIPMENT_SLOT_NECK         = 1,
-    EQUIPMENT_SLOT_SHOULDERS    = 2,
-    EQUIPMENT_SLOT_BODY         = 3,
-    EQUIPMENT_SLOT_CHEST        = 4,
-    EQUIPMENT_SLOT_WAIST        = 5,
-    EQUIPMENT_SLOT_LEGS         = 6,
-    EQUIPMENT_SLOT_FEET         = 7,
-    EQUIPMENT_SLOT_WRISTS       = 8,
-    EQUIPMENT_SLOT_HANDS        = 9,
-    EQUIPMENT_SLOT_FINGER1      = 10,
-    EQUIPMENT_SLOT_FINGER2      = 11,
-    EQUIPMENT_SLOT_TRINKET1     = 12,
-    EQUIPMENT_SLOT_TRINKET2     = 13,
-    EQUIPMENT_SLOT_BACK         = 14,
-    EQUIPMENT_SLOT_MAINHAND     = 15,
-    EQUIPMENT_SLOT_OFFHAND      = 16,
-    EQUIPMENT_SLOT_RANGED       = 17,
-    EQUIPMENT_SLOT_TABARD       = 18,
-    EQUIPMENT_SLOT_END          = 19
-};
-
-enum InventorySlots // 4 slots
+
enum InventorySlots // 4 slots
 {
     INVENTORY_SLOT_BAG_START    = 19,
     INVENTORY_SLOT_BAG_END      = 23
 };
 

+        

+        

+            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SlotID
EQUIPMENT_SLOT_HEAD0
EQUIPMENT_SLOT_NECK1
EQUIPMENT_SLOT_SHOULDERS2
EQUIPMENT_SLOT_BODY3
EQUIPMENT_SLOT_CHEST4
EQUIPMENT_SLOT_WAIST5
EQUIPMENT_SLOT_LEGS6
EQUIPMENT_SLOT_FEET7
EQUIPMENT_SLOT_WRISTS8
EQUIPMENT_SLOT_HANDS9
EQUIPMENT_SLOT_FINGER110
EQUIPMENT_SLOT_FINGER211
EQUIPMENT_SLOT_TRINKET112
EQUIPMENT_SLOT_TRINKET213
EQUIPMENT_SLOT_BACK14
EQUIPMENT_SLOT_MAINHAND15
EQUIPMENT_SLOT_OFFHAND16
EQUIPMENT_SLOT_RANGED17
EQUIPMENT_SLOT_TABARD18

+        

+        

         
         
         

diff --git a/Player/GetNearbyGameObject.html b/Player/GetNearbyGameObject.html
index cd7341e9..d605afc4 100644
--- a/Player/GetNearbyGameObject.html
+++ b/Player/GetNearbyGameObject.html
@@ -87,29 +87,31 @@ 

 
     
     

-        
This method is undocumented. Use at your own risk.

-        
For temporary documentation, please check the LuaFunctions source file.

+        
Returns the closest GameObject to the Player.

         
         
         

             Synopsis
         

         

-            Player:GetNearbyGameObject()
+            gameobject = Player:GetNearbyGameObject()
         

 
         

             Arguments
         

         

-            Unknown.
+            None.
         

 
         

             Returns
         

         

-            Unknown.
+            

+                
GameObject gameobject

+                
See method description.

+            

         

     

 
diff --git a/Player/GetRecruiterId.html b/Player/GetRecruiterId.html
index 8d7a5775..0715c7ba 100644
--- a/Player/GetRecruiterId.html
+++ b/Player/GetRecruiterId.html
@@ -87,29 +87,31 @@ 

 
     
     

-        
This method is undocumented. Use at your own risk.

-        
For temporary documentation, please check the LuaFunctions source file.

+        
Returns the Players recruit-a-friend recruiter account ID

         
         
         

             Synopsis
         

         

-            Player:GetRecruiterId()
+            recruiterId = Player:GetRecruiterId()
         

 
         

             Arguments
         

         

-            Unknown.
+            None.
         

 
         

             Returns
         

         

-            Unknown.
+            

+                
number recruiterId

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

+            

         

     

 
diff --git a/Player/GetSelectedPlayer.html b/Player/GetSelectedPlayer.html
index 8e108829..26b25e9c 100644
--- a/Player/GetSelectedPlayer.html
+++ b/Player/GetSelectedPlayer.html
@@ -87,29 +87,31 @@ 

 
     
     

-        
This method is undocumented. Use at your own risk.

-        
For temporary documentation, please check the LuaFunctions source file.

+        
Returns the Players selected Player or nil.

         
         
         

             Synopsis
         

         

-            Player:GetSelectedPlayer()
+            selection = Player:GetSelectedPlayer()
         

 
         

             Arguments
         

         

-            Unknown.
+            None.
         

 
         

             Returns
         

         

-            Unknown.
+            

+                
Player selection

+                
See method description.

+            

         

     

 
diff --git a/Player/GetSelectedUnit.html b/Player/GetSelectedUnit.html
index a2df07c0..87cafafe 100644
--- a/Player/GetSelectedUnit.html
+++ b/Player/GetSelectedUnit.html
@@ -87,29 +87,31 @@ 

 
     
     

-        
This method is undocumented. Use at your own risk.

-        
For temporary documentation, please check the LuaFunctions source file.

+        
Returns the Players selected Unit.

         
         
         

             Synopsis
         

         

-            Player:GetSelectedUnit()
+            selection = Player:GetSelectedUnit()
         

 
         

             Arguments
         

         

-            Unknown.
+            None.
         

 
         

             Returns
         

         

-            Unknown.
+            

+                
Unit selection

+                
See method description.

+            

         

     

 
diff --git a/Player/GetSkillPermBonusValue.html b/Player/GetSkillPermBonusValue.html
index bdf9a879..467c3123 100644
--- a/Player/GetSkillPermBonusValue.html
+++ b/Player/GetSkillPermBonusValue.html
@@ -94,7 +94,7 @@ 

             Synopsis
         

         

-            Player:GetSkillPermBonusValue( skill, bonusVal )
+            bonusVal = Player:GetSkillPermBonusValue( skill )
         

 
         

@@ -105,17 +105,16 @@ 

                 
number skill

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

             
-            

-                
number bonusVal

-                
Valid numbers: integers from -32,767 to 32,767.

-            

         

 
         

             Returns
         

         

-            Nothing.
+            

+                
number bonusVal

+                
Valid numbers: integers from -32,767 to 32,767.

+
diff --git a/Player/GetSkillTempBonusValue.html b/Player/GetSkillTempBonusValue.html index cfb1c1db..0c00badc 100644 --- a/Player/GetSkillTempBonusValue.html +++ b/Player/GetSkillTempBonusValue.html @@ -94,7 +94,7 @@

Synopsis

- Player:GetSkillTempBonusValue( skill, bonusVal ) + bonusVal = Player:GetSkillTempBonusValue( skill )

@@ -105,17 +105,16 @@

number skill

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

-
-
number bonusVal
-

Valid numbers: integers from -32,767 to 32,767.

-

Returns

- Nothing. +

+
number bonusVal
+

Valid numbers: integers from -32,767 to 32,767.

+

diff --git a/Player/HasPendingBind.html b/Player/HasPendingBind.html index 6bc6c71b..d6ff6ad0 100644 --- a/Player/HasPendingBind.html +++ b/Player/HasPendingBind.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player has any pending dungeon bind

Synopsis

- Player:HasPendingBind() + hasPendingBind = Player:HasPendingBind()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean hasPendingBind
+
See method description.
+

diff --git a/Player/HasReceivedQuestReward.html b/Player/HasReceivedQuestReward.html index ee130281..ae993677 100644 --- a/Player/HasReceivedQuestReward.html +++ b/Player/HasReceivedQuestReward.html @@ -87,29 +87,34 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player has received the reward for a specific Quest ID

Synopsis

- Player:HasReceivedQuestReward() + isQuestRewarded = Player:HasReceivedQuestReward( questId )

Arguments

- Unknown. +

+
number questId
+

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

+

Returns

- Unknown. +

+
boolean isQuestRewarded
+
See method description.
+

diff --git a/Player/HasRecruited.html b/Player/HasRecruited.html new file mode 100644 index 00000000..45e0a6eb --- /dev/null +++ b/Player/HasRecruited.html @@ -0,0 +1,168 @@ + + + + + + + + + Player:HasRecruited - Eluna + + + + + + + + + + + +
+ Eluna Logo +
+ +

Player Methods

+ + + +
+
+ + + +
+

+ Method + Player:HasRecruited + + + [-] + [+] + + +

+ + +
+

Returns whether or not the Player recruited the other Player

+ + +

+ Synopsis +

+

+ hasRecruited = Player:HasRecruited( recruit ) +

+ +

+ Arguments +

+

+

+
Player recruit
+
See method description.
+
+

+ +

+ Returns +

+

+

+
boolean hasRecruited
+

Returns 'true' if the Player recruited the other Player, false otherwise.

+
+

+
+ +
+ + + +
+ + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Player/InRandomLfgDungeon.html b/Player/InRandomLfgDungeon.html index 76ed9a7d..9f2d36c4 100644 --- a/Player/InRandomLfgDungeon.html +++ b/Player/InRandomLfgDungeon.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player is currently in a random LFG dungeon

Synopsis

- Player:InRandomLfgDungeon() + isInRandomLFG = Player:InRandomLfgDungeon()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isInRandomLFG
+
See method description.
+

diff --git a/Player/IsARecruiter.html b/Player/IsARecruiter.html index 3d16723f..6edab400 100644 --- a/Player/IsARecruiter.html +++ b/Player/IsARecruiter.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player is a recruiter

Synopsis

- Player:IsARecruiter() + isARecruiter = Player:IsARecruiter()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isARecruiter
+
See method description.
+

diff --git a/Player/IsGMChat.html b/Player/IsGMChat.html index 2faf08fa..ea24a45c 100644 --- a/Player/IsGMChat.html +++ b/Player/IsGMChat.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player has the GM chat flag active

Synopsis

- Player:IsGMChat() + isGMChatActive = Player:IsGMChat()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isGMChatActive
+
See method description.
+

diff --git a/Player/IsGMVisible.html b/Player/IsGMVisible.html index b5de070a..2bbfd976 100644 --- a/Player/IsGMVisible.html +++ b/Player/IsGMVisible.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player has GM invisibility active

Synopsis

- Player:IsGMVisible() + isGMVisible = Player:IsGMVisible()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isGMVisible
+
See method description.
+

diff --git a/Player/IsImmuneToEnvironmentalDamage.html b/Player/IsImmuneToEnvironmentalDamage.html index f6323871..fca16ca5 100644 --- a/Player/IsImmuneToEnvironmentalDamage.html +++ b/Player/IsImmuneToEnvironmentalDamage.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player is currently immune to environmental damage

Synopsis

- Player:IsImmuneToEnvironmentalDamage() + isImmuneToEnv = Player:IsImmuneToEnvironmentalDamage()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isImmuneToEnv
+
See method description.
+

diff --git a/Player/IsNeverVisible.html b/Player/IsNeverVisible.html index 6fa42455..6c9048b2 100644 --- a/Player/IsNeverVisible.html +++ b/Player/IsNeverVisible.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player is never visible for other Units

Synopsis

- Player:IsNeverVisible() + isNeverVisible = Player:IsNeverVisible()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isNeverVisible
+
See method description.
+

diff --git a/Player/IsOutdoorPvPActive.html b/Player/IsOutdoorPvPActive.html index fdffda4c..c55b7db3 100644 --- a/Player/IsOutdoorPvPActive.html +++ b/Player/IsOutdoorPvPActive.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player is currently flagged for outdoors PvP

Synopsis

- Player:IsOutdoorPvPActive() + isPvPActive = Player:IsOutdoorPvPActive()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isPvPActive
+
See method description.
+

diff --git a/Player/IsRecruited.html b/Player/IsRecruited.html new file mode 100644 index 00000000..a0b9ddab --- /dev/null +++ b/Player/IsRecruited.html @@ -0,0 +1,165 @@ + + + + + + + + + Player:IsRecruited - Eluna + + + + + + + + + + + +
+ Eluna Logo +
+ +

Player Methods

+ + + +
+
+ + + +
+

+ Method + Player:IsRecruited + + + [-] + [+] + + +

+ + +
+

Returns whether or not the Player has been recruited

+ + +

+ Synopsis +

+

+ isRecruited = Player:IsRecruited() +

+ +

+ Arguments +

+

+ None. +

+ +

+ Returns +

+

+

+
boolean isRecruited
+
See method description.
+
+

+
+ +
+ + + +
+ + + + + + + + +
Generated on
+
© 2010 - 2024 Eluna Lua Engine
+ + \ No newline at end of file diff --git a/Player/IsUsingLfg.html b/Player/IsUsingLfg.html index 68313bf6..1c1c7c1d 100644 --- a/Player/IsUsingLfg.html +++ b/Player/IsUsingLfg.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Returns whether or not the Player is currently queued in LFG

Synopsis

- Player:IsUsingLfg() + isUsingLFG = Player:IsUsingLfg()

Arguments

- Unknown. + None.

Returns

- Unknown. +

+
boolean isUsingLFG
+
See method description.
+

diff --git a/Player/KillGOCredit.html b/Player/KillGOCredit.html index 4c0a58ce..5e21a542 100644 --- a/Player/KillGOCredit.html +++ b/Player/KillGOCredit.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Grants kill credit for a specific [Craeture] or GameObject.

Synopsis

- Player:KillGOCredit() + Player:KillGOCredit( entryId )

Arguments

- Unknown. +

+
number entryId
+

The ID of the Creature or GameObject to award credit for..

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

+

Returns

- Unknown. + Nothing.

diff --git a/Player/KilledPlayerCredit.html b/Player/KilledPlayerCredit.html index 7bfd6a34..d9abf1f4 100644 --- a/Player/KilledPlayerCredit.html +++ b/Player/KilledPlayerCredit.html @@ -87,8 +87,7 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Grants a player kill credit.

@@ -102,14 +101,14 @@

Arguments

- Unknown. + None.

Returns

- Unknown. + Nothing.

diff --git a/Player/RemoveActiveQuest.html b/Player/RemoveActiveQuest.html index c61a5f00..ff036448 100644 --- a/Player/RemoveActiveQuest.html +++ b/Player/RemoveActiveQuest.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Removes an active quest from the Player.

Synopsis

- Player:RemoveActiveQuest() + Player:RemoveActiveQuest( questId )

Arguments

- Unknown. +

+
number questId
+

The ID of the quest to remove..

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

+

Returns

- Unknown. + Nothing.

diff --git a/Player/RemovePet.html b/Player/RemovePet.html index 1d993cf2..6126095c 100644 --- a/Player/RemovePet.html +++ b/Player/RemovePet.html @@ -87,29 +87,83 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Removes the Player's active pet.

+
+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Save modeIDComment
PET_SAVE_AS_DELETED-1Not saved
PET_SAVE_AS_CURRENT0In current slot (with the player)
PET_SAVE_FIRST_STABLE_SLOT1
PET_SAVE_SECOND_STABLE_SLOT2
PET_SAVE_THIRD_STABLE_SLOT3
PET_SAVE_LAST_STABLE_SLOT4
+

+

Synopsis

- Player:RemovePet() + Player:RemovePet( saveMode ) +

+

+ Player:RemovePet( saveMode, returnReagent )

Arguments

- Unknown. +

+
number saveMode (-1)
+

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

+
+
+
boolean returnReagent (false)
+
See method description.
+

Returns

- Unknown. + Nothing.

diff --git a/Player/RemoveRewardedQuest.html b/Player/RemoveRewardedQuest.html index 82af7cb6..965eb861 100644 --- a/Player/RemoveRewardedQuest.html +++ b/Player/RemoveRewardedQuest.html @@ -87,29 +87,31 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Removes a quest from the rewarded quests for the Player.

Synopsis

- Player:RemoveRewardedQuest() + Player:RemoveRewardedQuest( questId )

Arguments

- Unknown. +

+
number questId
+

The ID of the quest to remove..

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

+

Returns

- Unknown. + Nothing.

diff --git a/Player/SetGender.html b/Player/SetGender.html index 64cc3306..638c8cc3 100644 --- a/Player/SetGender.html +++ b/Player/SetGender.html @@ -88,10 +88,28 @@

Sets the Players gender to gender specified

-
    -
  • GENDER_MALE = 0
    • -
  • GENDER_FEMALE = 1
    • -
+
+

+ + + + + + + + + + + + + + + + + +
GenderID
GENDER_MALE0
GENDER_FEMALE1
+

+

diff --git a/Player/SetMovement.html b/Player/SetMovement.html index b869e39c..aab3e8e0 100644 --- a/Player/SetMovement.html +++ b/Player/SetMovement.html @@ -87,29 +87,61 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Sets the Players movement to the provided movement type

+
+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
movementTypeID
MOVE_ROOT1
MOVE_UNROOT2
MOVE_WATER_WALK3
MOVE_LAND_WALK4
+

+

Synopsis

- Player:SetMovement() + Player:SetMovement( movementType )

Arguments

- Unknown. +

+
number movementType
+

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

+

Returns

- Unknown. + Nothing.

diff --git a/Player/SummonPet.html b/Player/SummonPet.html index 7abc0ec6..e480fdbe 100644 --- a/Player/SummonPet.html +++ b/Player/SummonPet.html @@ -87,29 +87,77 @@

-

This method is undocumented. Use at your own risk.

-

For temporary documentation, please check the LuaFunctions source file.

+

Summons a pet for the Player.

+
+

+ + + + + + + + + + + + + + + + + +
Summon TypeID
SUMMON_PET0
HUNTER_PET1
+

+

Synopsis

- Player:SummonPet() + Player:SummonPet( entryId, x, y, z, o, petType, despawnTime )

Arguments

- Unknown. +

+
number entryId
+

The ID of the pet to summon..

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

+
+
+
number x
+

Valid numbers: all decimal numbers.

+
+
+
number y
+

Valid numbers: all decimal numbers.

+
+
+
number z
+

Valid numbers: all decimal numbers.

+
+
+
number o
+

Valid numbers: all decimal numbers.

+
+
+
number petType
+

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

+
+
+
number despawnTime
+

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

+

Returns

- Unknown. + Nothing.

diff --git a/Player/index.html b/Player/index.html index 3101011c..b9775989 100644 --- a/Player/index.html +++ b/Player/index.html @@ -96,11 +96,11 @@

Methods

- + AddLifetimeKills -

+

Adds or detracts from the Players current lifetime kill count

@@ -114,11 +114,11 @@

Methods

- + AddTalent -

+

Adds a talent to the Player for the specified spec and learning status.

@@ -159,11 +159,11 @@

Methods

- + BindToInstance -

+

Binds the Player to their current instance.

@@ -744,11 +744,11 @@

Methods

- + GetNearbyGameObject -

+

Returns the closest GameObject to the Player.

@@ -843,11 +843,11 @@

Methods

- + GetRecruiterId -

+

Returns the Players recruit-a-friend recruiter account ID

@@ -888,20 +888,20 @@

Methods

- + GetSelectedPlayer -

+

Returns the Players selected Player or nil.

- + GetSelectedUnit -

+

Returns the Players selected Unit.

@@ -1140,11 +1140,11 @@

Methods

- + HasPendingBind -

+

Returns whether or not the Player has any pending dungeon bind

@@ -1176,11 +1176,20 @@

Methods

- + HasReceivedQuestReward -

+

Returns whether or not the Player has received the reward for a specific Quest ID

+ + + + + + HasRecruited + + +

Returns whether or not the Player recruited the other Player

@@ -1257,11 +1266,11 @@

Methods

- + InRandomLfgDungeon -

+

Returns whether or not the Player is currently in a random LFG dungeon

@@ -1284,11 +1293,11 @@

Methods

- + IsARecruiter -

+

Returns whether or not the Player is a recruiter

@@ -1347,20 +1356,20 @@

Methods

- + IsGMChat -

+

Returns whether or not the Player has the GM chat flag active

- + IsGMVisible -

+

Returns whether or not the Player has GM invisibility active

@@ -1401,11 +1410,11 @@

Methods

- + IsImmuneToEnvironmentalDamage -

+

Returns whether or not the Player is currently immune to environmental damage

@@ -1473,20 +1482,29 @@

Methods

- + IsNeverVisible -

+

Returns whether or not the Player is never visible for other Units

- + IsOutdoorPvPActive -

+

Returns whether or not the Player is currently flagged for outdoors PvP

+ + + + + + IsRecruited + + +

Returns whether or not the Player has been recruited

@@ -1509,11 +1527,11 @@

Methods

- + IsUsingLfg -

+

Returns whether or not the Player is currently queued in LFG

@@ -1536,11 +1554,11 @@

Methods

- + KillGOCredit -

+

Grants kill credit for a specific [Craeture] or GameObject.

@@ -1563,11 +1581,11 @@

Methods

- + KilledPlayerCredit -

+

Grants a player kill credit.

@@ -1644,11 +1662,11 @@

Methods

- + RemoveActiveQuest -

+

Removes an active quest from the Player.

@@ -1698,11 +1716,11 @@

Methods

- + RemovePet -

+

Removes the Player's active pet.

@@ -1716,11 +1734,11 @@

Methods

- + RemoveRewardedQuest -

+

Removes a quest from the rewarded quests for the Player.

@@ -2175,11 +2193,11 @@

Methods

- + SetMovement -

+

Sets the Players movement to the provided movement type

@@ -2274,11 +2292,11 @@

Methods

- + SummonPet -

+

Summons a pet for the Player.

diff --git a/Player/sidebar.js b/Player/sidebar.js index 3b0f6cd4..2dceab15 100644 --- a/Player/sidebar.js +++ b/Player/sidebar.js @@ -122,6 +122,7 @@ document.write(` HasQuestForGO HasQuestForItem HasReceivedQuestReward + HasRecruited HasSkill HasSpell HasSpellCooldown @@ -156,6 +157,7 @@ document.write(` IsMoving IsNeverVisible IsOutdoorPvPActive + IsRecruited IsRested IsTaxiCheater IsUsingLfg diff --git a/date.js b/date.js index 12aacb5c..266812b3 100644 --- a/date.js +++ b/date.js @@ -1 +1 @@ -document.write("03/11/2024"); \ No newline at end of file +document.write("14/11/2024"); \ No newline at end of file diff --git a/search-index.js b/search-index.js index 9a779e37..ed80b596 100644 --- a/search-index.js +++ b/search-index.js @@ -483,14 +483,14 @@ searchIndex["Aura"] = { [0, "", "Player", "Inherits all methods from: Object, WorldObject, Unit"], [3, "AddComboPoints", "", "Adds combo points to the Player"], [3, "AddItem", "", "Adds the given amount of the specified item entry to the player."], - [3, "AddLifetimeKills", "", ""], + [3, "AddLifetimeKills", "", "Adds or detracts from the Players current lifetime kill count"], [3, "AddQuest", "", "Tries to add the given quest entry for the Player."], - [3, "AddTalent", "", ""], + [3, "AddTalent", "", "Adds a talent to the Player for the specified spec and learning status."], [3, "AdvanceAllSkills", "", "Advances all of the Players skills to the amount specified"], [3, "AdvanceSkill", "", "Advances a Players specific skill to the amount specified"], [3, "AdvanceSkillsToMax", "", "Advances all of the Players weapon skills to the maximum amount available"], [3, "AreaExploredOrEventHappens", "", "Completes the Quest if a Quest area is explored, or completes the Quest"], - [3, "BindToInstance", "", ""], + [3, "BindToInstance", "", "Binds the Player to their current instance."], [3, "CanBlock", "", "Returns 'true' if the Player can block incomming attacks, 'false' otherwise."], [3, "CanCompleteQuest", "", "Returns 'true' if the Player satisfies all requirements to complete the quest entry."], [3, "CanCompleteRepeatableQuest", "", "Returns 'true' if the Player satisfies all requirements to complete the repeatable quest entry."], @@ -555,7 +555,7 @@ searchIndex["Aura"] = { [3, "GetMailItem", "", "Returns a mailed Item by guid."], [3, "GetManaBonusFromIntellect", "", "Returns mana bonus from amount of intellect"], [3, "GetMaxSkillValue", "", "Returns max value of specified skill"], - [3, "GetNearbyGameObject", "", ""], + [3, "GetNearbyGameObject", "", "Returns the closest GameObject to the Player."], [3, "GetNextRandomRaidMember", "", "Returns a random Raid Member Player object within radius specified of Player"], [3, "GetOriginalGroup", "", "Returns Players original Group object"], [3, "GetOriginalSubGroup", "", "Returns Players original sub group"], @@ -566,13 +566,13 @@ searchIndex["Aura"] = { [3, "GetQuestLevel", "", "Returns the quest level of the Players Quest specified by object"], [3, "GetQuestRewardStatus", "", "Returns 'true' if the Players Quest specified by entry ID has been rewarded, 'false' otherwise."], [3, "GetQuestStatus", "", "Returns the status of the Players Quest specified by entry ID"], - [3, "GetRecruiterId", "", ""], + [3, "GetRecruiterId", "", "Returns the Players recruit-a-friend recruiter account ID"], [3, "GetReputation", "", "Returns the amount of reputation the Player has with the faction specified"], [3, "GetReputationRank", "", "Returns the Players reputation rank of faction specified"], [3, "GetReqKillOrCastCurrentCount", "", "Returns Quest required Creature or GameObject count"], [3, "GetRestBonus", "", "Returns the Players current resting bonus"], - [3, "GetSelectedPlayer", "", ""], - [3, "GetSelectedUnit", "", ""], + [3, "GetSelectedPlayer", "", "Returns the Players selected Player or nil."], + [3, "GetSelectedUnit", "", "Returns the Players selected Unit."], [3, "GetSelection", "", "Returns the Players currently selected Unit object"], [3, "GetShieldBlockValue", "", "Returns the Players current shield block value"], [3, "GetSkillPermBonusValue", "", "Returns skill permanent bonus value"], @@ -599,11 +599,12 @@ searchIndex["Aura"] = { [3, "HasAchieved", "", "Returns 'true' if the Player has completed the specified achievement, 'false' otherwise."], [3, "HasAtLoginFlag", "", "Returns true if Player has specified login flag"], [3, "HasItem", "", "Returns 'true' if the Player has the given amount of item entry specified, 'false' otherwise."], - [3, "HasPendingBind", "", ""], + [3, "HasPendingBind", "", "Returns whether or not the Player has any pending dungeon bind"], [3, "HasQuest", "", "Returns 'true' if the Player has an active Quest by specific ID, 'false' otherwise."], [3, "HasQuestForGO", "", "Returns true if Player has Quest for GameObject"], [3, "HasQuestForItem", "", "Returns 'true' if the Player has a quest for the item entry specified, 'false' otherwise."], - [3, "HasReceivedQuestReward", "", ""], + [3, "HasReceivedQuestReward", "", "Returns whether or not the Player has received the reward for a specific Quest ID"], + [3, "HasRecruited", "", "Returns whether or not the Player recruited the other Player"], [3, "HasSkill", "", "Returns 'true' if the Player has a skill by specific ID, 'false' otherwise."], [3, "HasSpell", "", "Returns 'true' if the Player has a Spell by specific ID, 'false' otherwise."], [3, "HasSpellCooldown", "", "Returns 'true' if the Spell specified by ID is currently on cooldown for the Player, 'false' otherwise."], @@ -612,23 +613,23 @@ searchIndex["Aura"] = { [3, "InArena", "", "Returns 'true' if the Player is currently in an arena, 'false' otherwise."], [3, "InBattleground", "", "Returns 'true' if the Player is currently in a BattleGround, 'false' otherwise."], [3, "InBattlegroundQueue", "", "Returns 'true' if the Player is currently in a BattleGround queue, 'false' otherwise."], - [3, "InRandomLfgDungeon", "", ""], + [3, "InRandomLfgDungeon", "", "Returns whether or not the Player is currently in a random LFG dungeon"], [3, "IncompleteQuest", "", "Sets the given quest entry incomplete for the Player."], [3, "IsAFK", "", "Returns 'true' if the Player is 'Away From Keyboard' flagged, 'false' otherwise."], - [3, "IsARecruiter", "", ""], + [3, "IsARecruiter", "", "Returns whether or not the Player is a recruiter"], [3, "IsAcceptingWhispers", "", "Returns 'true' if the Player is accepting whispers, 'false' otherwise."], [3, "IsAlliance", "", "Returns 'true' if the Player is a part of the Alliance faction, 'false' otherwise."], [3, "IsDND", "", "Returns 'true' if the Player is 'Do Not Disturb' flagged, 'false' otherwise."], [3, "IsFalling", "", "Returns 'true' if the Player is currently falling, 'false' otherwise."], [3, "IsFlying", "", "Returns 'true' if the Player is currently flying, 'false' otherwise."], [3, "IsGM", "", "Returns 'true' if the Player is a Game Master, 'false' otherwise."], - [3, "IsGMChat", "", ""], - [3, "IsGMVisible", "", ""], + [3, "IsGMChat", "", "Returns whether or not the Player has the GM chat flag active"], + [3, "IsGMVisible", "", "Returns whether or not the Player has GM invisibility active"], [3, "IsGroupVisibleFor", "", ""], [3, "IsHonorOrXPTarget", "", "Returns 'true' if the Player is eligible for Honor or XP gain by Unit specified, 'false' otherwise."], [3, "IsHorde", "", "Returns 'true' if the Player is a part of the Horde faction, 'false' otherwise."], [3, "IsImmuneToDamage", "", "Returns 'true' if the Player is immune to everything."], - [3, "IsImmuneToEnvironmentalDamage", "", ""], + [3, "IsImmuneToEnvironmentalDamage", "", "Returns whether or not the Player is currently immune to environmental damage"], [3, "IsInArenaTeam", "", "Returns 'true' if the Player is in an arena team specified by type, 'false' otherwise."], [3, "IsInGroup", "", "Returns 'true' if the Player is in a Group, 'false' otherwise."], [3, "IsInGuild", "", "Returns 'true' if the Player is in a Guild, 'false' otherwise."], @@ -636,17 +637,18 @@ searchIndex["Aura"] = { [3, "IsInSameRaidWith", "", "Returns 'true' if the Player is currently in the same raid as another Player by object, 'false' otherwise."], [3, "IsInWater", "", "Returns 'true' if the Player is currently in water, 'false' otherwise."], [3, "IsMoving", "", "Returns 'true' if the Player is currently moving, 'false' otherwise."], - [3, "IsNeverVisible", "", ""], - [3, "IsOutdoorPvPActive", "", ""], + [3, "IsNeverVisible", "", "Returns whether or not the Player is never visible for other Units"], + [3, "IsOutdoorPvPActive", "", "Returns whether or not the Player is currently flagged for outdoors PvP"], + [3, "IsRecruited", "", "Returns whether or not the Player has been recruited"], [3, "IsRested", "", "Returns 'true' if the Player is currently rested, 'false' otherwise."], [3, "IsTaxiCheater", "", "Returns 'true' if the Player has taxi cheat activated, 'false' otherwise."], - [3, "IsUsingLfg", "", ""], + [3, "IsUsingLfg", "", "Returns whether or not the Player is currently queued in LFG"], [3, "IsVisibleForPlayer", "", "Returns 'true' if the Player can see anoter Player specified by object, 'false' otherwise."], [3, "KickPlayer", "", "Kicks the Player from the server"], - [3, "KillGOCredit", "", ""], + [3, "KillGOCredit", "", "Grants kill credit for a specific [Craeture] or GameObject."], [3, "KillPlayer", "", "Kills the Player"], [3, "KilledMonsterCredit", "", "Gives Quest monster killed credit"], - [3, "KilledPlayerCredit", "", ""], + [3, "KilledPlayerCredit", "", "Grants a player kill credit."], [3, "LearnSpell", "", "Teaches the Player the Spell specified by entry ID"], [3, "LearnTalent", "", "Learn the Player the talent specified by talent_id and talentRank"], [3, "LeaveBattleground", "", "Forces the Player to leave a BattleGround"], @@ -655,15 +657,15 @@ searchIndex["Aura"] = { [3, "ModifyHonorPoints", "", "Adds or detracts from the Players current Honor Points"], [3, "ModifyMoney", "", "Adds or subtracts from the Players money in copper"], [3, "Mute", "", "Mutes the Player for the amount of seconds specified"], - [3, "RemoveActiveQuest", "", ""], + [3, "RemoveActiveQuest", "", "Removes an active quest from the Player."], [3, "RemoveArenaSpellCooldowns", "", "Remove cooldowns on spells that have less than 10 minutes of cooldown from the Player, similarly to when you enter an arena."], [3, "RemoveFromBattlegroundRaid", "", "Forcefully removes the Player from a BattleGround raid group"], [3, "RemoveFromGroup", "", "Forces the Player to leave a Group"], [3, "RemoveItem", "", "Removes the given amount of the specified Item from the player."], [3, "RemoveLifetimeKills", "", "Removes specified amount of lifetime kills"], - [3, "RemovePet", "", ""], + [3, "RemovePet", "", "Removes the Player's active pet."], [3, "RemoveQuest", "", "Removes the given quest entry from the Player."], - [3, "RemoveRewardedQuest", "", ""], + [3, "RemoveRewardedQuest", "", "Removes a quest from the rewarded quests for the Player."], [3, "RemoveSpell", "", "Removes the Spell from the Player"], [3, "RemovedInsignia", "", "Loots Player's bones for insignia"], [3, "ResetAchievements", "", "Reset the Players completed achievements"], @@ -714,7 +716,7 @@ searchIndex["Aura"] = { [3, "SetHonorPoints", "", "Sets the Players Honor Points to the amount specified"], [3, "SetKnownTitle", "", "Adds the specified title to the Players list of known titles"], [3, "SetLifetimeKills", "", "Sets the Players amount of Lifetime Honorable Kills to the value specified"], - [3, "SetMovement", "", ""], + [3, "SetMovement", "", "Sets the Players movement to the provided movement type"], [3, "SetPlayerLock", "", "Locks the player controls and disallows all movement and casting."], [3, "SetPvPDeath", "", "Toggles PvP Death"], [3, "SetQuestStatus", "", "Sets Quest state"], @@ -725,7 +727,7 @@ searchIndex["Aura"] = { [3, "SetTaxiCheat", "", "Toggles whether the Player has taxi cheat enabled or not"], [3, "SpawnBones", "", "Converts Player's corpse to bones"], [3, "StartTaxi", "", "Attempts to start the taxi/flying to the given pathID"], - [3, "SummonPet", "", ""], + [3, "SummonPet", "", "Summons a pet for the Player."], [3, "SummonPlayer", "", "Sends a summon request to the player from the given summoner"], [3, "TalkedToCreature", "", "Gives Quest monster talked to credit"], [3, "Teleport", "", "Teleports a Player to the location specified"],