WoW:API UnitReaction: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API UnitReaction to API UnitReaction without leaving a redirect)
 
(10 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<center>'''UnitReaction''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>
{{wowapi}} __NOTOC__
 
Determine the reaction of the specified unit to the other specified unit.
  reaction = UnitReaction("unit", "otherUnit");
  reaction = UnitReaction("unit", "otherUnit");


Determine the reaction of the specified unit to the other specified unit.
==Parameters==
 
===Arguments===
----
;''Arguments''
 
:("unit", "otherUnit")
:;unit : String - The [[API TYPE UnitId|UnitId]] of the unit whose reaction is to be determined.
:;unit : String - The [[API TYPE UnitId|UnitId]] of the unit whose reaction is to be determined.
:;otherUnit : String - The [[API TYPE UnitId|UnitId]] of the unit towards whom the reaction is to be measured.
:;otherUnit : String - The [[API TYPE UnitId|UnitId]] of the unit towards whom the reaction is to be measured.
===Returns===
:;reaction : Number - the level of the reaction of unit towards otherUnit - this is a number between 1 and 7. If the reaction is unknown then nil is returned.
::# Exceptionally hostile
::# Very Hostile
::# Hostile
::# Neutral
::# Friendly
::# Very Friendly
::# Exceptionally friendly
::# Exalted


----
==Notes==
;''Returns''
* If the second unit is neither you nor your pet, and/or the first unit is a player, player's pet, or factionless NPC, the output will always be 2 for enemy, 4 for neutral or 5 for friendly.
 
* If the first unit is an NPC whose faction you have a reputation with, reaction to you and your pet is based on that reputation (1 Hated, 2 Hostile, 3 Unfriendly, 4 Neutral, 5 Friendly, 6 Honored, 7 Revered, 8 Exalted).
:reaction
* When you're Horde, the reaction of Alliance NPCs to you and your pet is 1<!-- Tested with Silver Covenant NPCs in Dalaran. -->. The same is true of Horde NPCs if you're Alliance.
:;reaction : Number - the level of the reaction of unit towards otherUnit - this is a number between 1 and 7. If the reaction is unknown then 0 or nil (<small>I dont know which -- [[User:Flickering|Flickering]]</small>) is returned.
* This doesn't change when a mob becomes aggressive towards a player. I ad to use the negative result of [[API UnitIsFriend]].
 
* Does not work across continents (or zones?)! If you query UnitReaction for a raid (or party)-member across continents, it will return nil. I think it only returns correct values for units that are in 'inspect-range'.
:: 1 - Exceptionally hostile
* In Blizzard Code, UnitReaction is only used between the player and a Non Player Controlled target.
:: 2 - Very Hostile
:: 3 - Hostile
:: 4 - Neutral
:: 5 - Friendly
:: 6 - Very Friendly
:: 7 - Exceptionally friendly
 
----
;''Details''
 
: I'm not entirely sure what the actual levels of friendliness and hostility translate to. I'm 5 to myself!
:: I assume the levels are Faction-related (1 Hated, 2 Hostile, 3 Unfriendly, 4 Neutral, 5 Friendly, 6 Honored, 7 Revered, Exalted (still 7?)) --[[User:Shane3012|Shane3012]] 02:42, 25 Oct 2005 (EDT)
 
: This doesn't change when a mob becomes aggressive towards a player. I had to use the negative result of [[API UnitIsFriend]]. --[[User:Shane3012|Shane3012]] 02:42, 25 Oct 2005 (EDT)
 
: Does not work across continents (or zones?)! If you query UnitReaction for a raid (or party)-member across continents, it won't return the correct value (I guess it returns nil, but I have yet to confirm that). I think it only returns correct values for units that are in 'inspect-range'.
 
----
{{Template:WoW API}}
[[Category:API Unit Functions|UnitReaction]]

Latest revision as of 04:47, 15 August 2023

← WoW API < UnitReaction

Determine the reaction of the specified unit to the other specified unit. 

reaction = UnitReaction("unit", "otherUnit");

Parameters[edit]

Arguments[edit]

unit
String - The UnitId of the unit whose reaction is to be determined.
otherUnit
String - The UnitId of the unit towards whom the reaction is to be measured.

Returns[edit]

reaction
Number - the level of the reaction of unit towards otherUnit - this is a number between 1 and 7. If the reaction is unknown then nil is returned.
  1. Exceptionally hostile
  2. Very Hostile
  3. Hostile
  4. Neutral
  5. Friendly
  6. Very Friendly
  7. Exceptionally friendly
  8. Exalted

Notes[edit]

  • If the second unit is neither you nor your pet, and/or the first unit is a player, player's pet, or factionless NPC, the output will always be 2 for enemy, 4 for neutral or 5 for friendly.
  • If the first unit is an NPC whose faction you have a reputation with, reaction to you and your pet is based on that reputation (1 Hated, 2 Hostile, 3 Unfriendly, 4 Neutral, 5 Friendly, 6 Honored, 7 Revered, 8 Exalted).
  • When you're Horde, the reaction of Alliance NPCs to you and your pet is 1. The same is true of Horde NPCs if you're Alliance.
  • This doesn't change when a mob becomes aggressive towards a player. I ad to use the negative result of API UnitIsFriend.
  • Does not work across continents (or zones?)! If you query UnitReaction for a raid (or party)-member across continents, it will return nil. I think it only returns correct values for units that are in 'inspect-range'.
  • In Blizzard Code, UnitReaction is only used between the player and a Non Player Controlled target.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_UnitReaction&oldid=20104"