WoW:API CanGrantLevel: Difference between revisions

Latest revision as of 04:45, 15 August 2023

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

→ WoW API

← WoW API < CanGrantLevel

Returns whether you can grant levels to a particular player.

status = CanGrantLevel("unit")

Arguments

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

Returns

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

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

@@ Line 1: / Line 1: @@
 {{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 ==
-<!-- List each argument, together with its type -->
+;unit : String ([[UnitId]]) - unit to check level grant eligibility of.
-No arguments
 == 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 ==
+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 -->
-  local status = CanGrantLevel()
+  local status = CanGrantLevel("target")
   if status then
-   ChatFrame1:AddMessage("I can grant "..status.." levels to my friend!")
+   print("I can grant levels to my friend!")
   else
-   ChatFrame1:AddMessage("I am out of free levels for now.")
+   print("I am out of free levels for now.")
   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.