WoW:API SummonFriend: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (New page: {{wowapi}} __NOTOC__ <!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> <!-- List return values and arguments as well as function name, foll...)
 
m (Move page script moved page API SummonFriend to API SummonFriend without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
 
Summons a player using the RaF system.
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  SummonFriend("unit")
  SummonFriend("unit")


== Arguments ==
== Arguments ==
<!-- List each argument, together with its type -->
;unit : String ([[UnitId]]) - player you wish to summon to you.
:("unit")
 
:;unit : [[UnitId]] or a name you want to summon to you.
 
 
== Returns ==
<!-- List each return value, together with its type -->
 
Nothing
 
 
== Example ==
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
local t = "Zuotheshaman";
if CanSummonFriend(t) then
  SendChatMessage("I am summoning you!","WHISPER",nil,t)
  SummonFriend(t)
end
 
 
<big>'''Result'''</big>
<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->


If you can summon the target, you whisper and summon him/her to you. Check out [[API_CanSummonFriend|CanSummonFriend]]() for details about that function.
== See also ==
* {{api|CanSummonFriend}}
* {{api| GetSummonFriendCooldown}}

Latest revision as of 04:47, 15 August 2023

← WoW API < SummonFriend

Summons a player using the RaF system. 

SummonFriend("unit")

Arguments[edit]

unit
String (UnitId) - player you wish to summon to you.

See also[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_SummonFriend&oldid=19916"