WoW:API SummonFriend: Difference between revisions

Revision as of 14:38, 20 June 2010

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Summons a player using the RaF system.

SummonFriend("unit")

@@ Line 1: / Line 1: @@
-{{stub/API}}
 {{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")
 == 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}}