WoW:API CanGrantLevel: 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 --> One line summary description of function. <!-- List return values an...)
 
m (Move page script moved page API CanGrantLevel to API CanGrantLevel without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
 
Returns whether you can grant levels to a particular player.
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
  status = CanGrantLevel("unit")
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  status = CanGrantLevel()
 


== Arguments ==
== Arguments ==
<!-- List each argument, together with its type -->
;unit : String ([[UnitId]]) - unit to check level grant eligibility of.
No arguments
 


== Returns ==
== Returns ==
<!-- List each return value, together with its type -->
;status : Flag - true if you can grant levels to the unit; nil otherwise (unit is not RAF-linked to you, does not meet level requirements, or you are out of levels to grant).
 
:;arg1 : nil if false, true if you have levels to grant
 


== Example ==
== Example ==
The snippet below prints whether you can grant levels to your target right now.
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
  local status = CanGrantLevel()
  local status = CanGrantLevel("target")
  if status then
  if status then
   ChatFrame1:AddMessage("I can grant "..status.." levels to my friend!")
   print("I can grant levels to my friend!")
  else
  else
   ChatFrame1:AddMessage("I am out of free levels for now.")
   print("I am out of free levels for now.")
  end
  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. -->
Outputs in the chat frame either if you can or if you can't grant levels right now.

Latest revision as of 04:45, 15 August 2023

← WoW API < CanGrantLevel

Returns whether you can grant levels to a particular player. 

status = CanGrantLevel("unit")

Arguments[edit]

unit
String (UnitId) - unit to check level grant eligibility of.

Returns[edit]

status
Flag - true if you can grant levels to the unit; nil otherwise (unit is not RAF-linked to you, does not meet level requirements, or you are out of levels to grant).

Example[edit]

The snippet below prints whether you can grant levels to your target right now. 

local status = CanGrantLevel("target")
if status then
 print("I can grant levels to my friend!")
else
 print("I am out of free levels for now.")
end
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_CanGrantLevel&oldid=18615"