Files
wow_Meta/C_RecruitAFriend.lua

78 lines
2.2 KiB
Lua

---@meta
--- C_RecruitAFriend is a namespace for functions related to the Recruit-a-Friend system.
---
--- @class C_RecruitAFriend
C_RecruitAFriend = {
--- @param guid string
--- @return boolean result
--- Returns whether you can RaF summon a particular unit.
CanSummonFriend = function(guid) end,
--- @param activityID number
--- @param acceptanceID number
--- @return boolean success
--- Claims the activity reward.
ClaimActivityReward = function(activityID, acceptanceID) end,
--- @param rafVersion number
--- @return boolean success
--- Claims the next reward.
ClaimNextReward = function(rafVersion) end,
--- @return boolean success
--- Generates a recruitment link.
GenerateRecruitmentLink = function() end,
--- @return table info
--- Gets the RAF info.
GetRAFInfo = function() end,
--- @return table systemInfo
--- Gets the RAF system info.
GetRAFSystemInfo = function() end,
--- @param activityID number
--- @param acceptanceID number
--- @return string requirementsText
--- Gets the recruitment activity requirements text.
GetRecruitActivityRequirementsText = function(activityID, acceptanceID) end,
--- @return boolean active
--- @return string faction
--- Gets the recruitment info.
GetRecruitInfo = function() end,
--- @return number startTimeSeconds
--- @return number durationSeconds
--- @return boolean enableCooldownTimer
--- Returns the cooldown info of the RaF Summon Friend ability.
GetSummonFriendCooldown = function() end,
--- @return boolean enabled
--- Checks if the system is enabled.
IsEnabled = function() end,
--- @param guid string
--- @return boolean result
--- Checks if a player is linked to the Recruit-a-Friend system.
IsRecruitAFriendLinked = function(guid) end,
--- @return boolean enabled
--- Checks if recruiting is enabled.
IsRecruitingEnabled = function() end,
--- @param wowAccountGUID string
--- @return boolean success
--- Removes a RAF recruit.
RemoveRAFRecruit = function(wowAccountGUID) end,
--- @return boolean success
--- Requests updated recruitment info.
RequestUpdatedRecruitmentInfo = function() end,
--- @param target string
--- @param name string
--- Summons a player using the RaF system.
SummonFriend = function(target, name) end,
}