WoW:API IsReferAFriendLinked: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Created page with '{{wowapi}} __NOTOC__ <!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> Determines whether the given unit is linked to the player v…')
 
m (Move page script moved page API IsReferAFriendLinked to API IsReferAFriendLinked without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Determines whether the given unit is linked to the player via the Recruit-A-Friend feature.
Determines whether the given unit is linked to the player via the Recruit-A-Friend feature.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  isLinked = IsReferAFriendLinked("unit")
  isLinked = IsReferAFriendLinked("unit")


== Arguments ==
== Arguments ==
;unit : String - The [[API TYPE UnitId|UnitId]] to examine.
;unit : String ([[UnitId]]) - Unit to query information about.


== Returns ==
== Returns ==
;isLinked : Flag : 1 if the unit is linked, nill otherwise.
;isLinked : Flag : 1 if the unit is RAF-linked to the player, nil otherwise.
 


== Example ==
== Example ==

Latest revision as of 04:46, 15 August 2023

WoW API < IsReferAFriendLinked

Determines whether the given unit is linked to the player via the Recruit-A-Friend feature.

isLinked = IsReferAFriendLinked("unit")

Arguments[edit]

unit
String (UnitId) - Unit to query information about.

Returns[edit]

isLinked
Flag : 1 if the unit is RAF-linked to the player, nil otherwise.

Example[edit]

function HasRecruitAFriendBonus()
    local numPartyMembers = GetNumPartyMembers();
    if numPartyMembers > 0 then
        local memberID = 1;
        while memberID <= numPartyMembers do
            if GetPartyMember(memberID) == 1 then
                local member = "party" .. memberID;
                if UnitIsVisible(member) and IsReferAFriendLinked(member) then
                    return true;
                end
            end
            memberID = memberID + 1;
        end
    end
    return false;
end