WoW:API CanSummonFriend: Difference between revisions

Revision as of 14:36, 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

Returns whether you can RaF summon a particular unit.

summonable = CanSummonFriend("unit")

The snippet below checks whether you can summon the target, and, if so, whispers and summons her to you.

local t = "target"; 
if CanSummonFriend(t) then 
  SendChatMessage("I am summoning you!","WHISPER",nil,t) 
  SummonFriend(t) 
end

@@ Line 1: / Line 1: @@
-{{stub/API}}
 {{wowapi}} __NOTOC__
+Returns whether you can RaF summon a particular unit.
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+  summonable = CanSummonFriend("unit")
-  CanSummonFriend("unit")
 == Arguments ==
-<!-- List each argument, together with its type -->
+;unit : String ([[UnitId]]) - player to check whether you can summon.
-:("unit")
-:;unit : [[UnitId]] or a name, returns true if you can summon the target or nil if not
 == Returns ==
-<!-- List each return value, together with its type -->
+;summonable : Flag - 1 if you can summon the unit using RaF, nil otherwise.
-Nothing
 == Example ==
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
+The snippet below checks whether you can summon the target, and, if so, whispers and summons her to you.
-  local t = "Zuotheshaman";
+  local t = "target";
   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 SummonFriend|SummonFriend]]() for details about that function.