C_RecruitAFriend

namespaceavailable in: camelot

Status in wowlua

16 functions: 0 implemented, 5 recorded, 11 guessed. 5 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`CanSummonFriend`	Returns whether you can RaF summon a particular unit. `(guid: string): (boolean?, RecruitAFriendFailure?)`	guessed
`ClaimActivityReward`	Claims the reward of a Recruit-A-Friend activity. Returns whether the claim was sent. · by wowlua `(activityID: number, acceptanceID: RecruitAcceptanceID): boolean`	guessed
`ClaimNextReward`	Claims the next available Recruit-A-Friend reward. Returns whether the claim was sent. · by wowlua `(rafVersion: RecruitAFriendRewardsVersion?): boolean`	guessed
`GenerateRecruitmentLink`	Requests a new Recruit-A-Friend recruitment link. Returns whether the request was sent. · by wowlua `(): boolean`	guessed
`GetRAFInfo`	Returns the player's Recruit-A-Friend information, such as recruits and rewards. · by wowlua `(): RafInfo`	recorded
`GetRAFSystemInfo`	Returns general information about the Recruit-A-Friend system. · by wowlua `(): RafSystemInfo`	recorded
`GetRecruitActivityRequirementsText`	Returns the requirement lines of a Recruit-A-Friend activity. · by wowlua `(activityID: number, acceptanceID: RecruitAcceptanceID): string[]`	guessed
`GetRecruitInfo`	Returns information about the player's own Recruit-A-Friend recruitment. · by wowlua `(): (boolean, number)`	guessed
`GetSummonFriendCooldown`	Returns the cooldown info of the RaF Summon Friend ability. `(): (number, number, boolean)`	guessed
`IsRecruitAFriendLinked`	Whether the given player is linked to the player through Recruit-A-Friend. · by wowlua `(guid: string): boolean`	guessed
`IsRecruitingEnabled`	Whether the player can recruit friends through Recruit-A-Friend. · by wowlua `(): boolean`	recorded
`IsSystemEnabled`	Whether the Recruit-A-Friend system is enabled. · by wowlua `(): boolean`	recorded
`IsSystemSupported`	Whether the Recruit-A-Friend system is supported on this client. · by wowlua `(): boolean`	recorded
`RemoveRAFRecruit`	Removes a recruit from the player's Recruit-A-Friend list. Returns whether the request was sent. · by wowlua `(wowAccountGUID: string): boolean`	guessed
`RequestUpdatedRecruitmentInfo`	Requests up-to-date Recruit-A-Friend information from the server. Returns whether the request was sent. · by wowlua `(): boolean`	guessed
`SummonFriend`	Summons a player using the RaF system. `(target: string, name: string)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`RAF_INFO_UPDATED`	`info: RafInfo`	not implemented
`RAF_RECRUITING_ENABLED_STATUS`	`enabled: boolean`	not implemented
`RAF_REWARD_CLAIM_FAILED`	`no payload`	not implemented
`RAF_SYSTEM_ENABLED_STATUS`	`enabled: boolean`	not implemented
`RAF_SYSTEM_INFO_UPDATED`	`systemInfo: RafSystemInfo`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("RAF_INFO_UPDATED").

Structures

RafAppearanceInfo · appearanceID
RafAppearanceSetInfo · setID, setName, appearanceIDs
RafIllusionInfo · spellItemEnchantmentID
RafInfo · versions, recruitmentInfo?, recruits, claimInProgress
RafMonthCount · lifetimeMonths, spentMonths, availableMonths
RafMountInfo · spellID, mountID
RafPetInfo · creatureID, speciesID, displayID, speciesName, description
RafRecruit · bnetAccountID, wowAccountGUID, battleTag, monthsRemaining, subStatus, acceptanceID, versionRecruited, activities
RafRecruitActivity · activityID, rewardQuestID, state
RafRecruitmentinfo · recruitmentCode, recruitmentURL, expireTime, remainingTimeSeconds, totalUses, remainingUses, sourceRealm, sourceFaction
RafReward · rewardID, rafVersion, itemID, rewardType, petInfo?, mountInfo?, appearanceInfo?, titleInfo?, appearanceSetInfo?, illusionInfo?, canClaim, claimed, canAfford, repeatable, repeatableClaimCount, monthsRequired, monthCost, availableInMonths, iconID
RafSystemInfo · maxRecruits, maxRecruitMonths, maxRecruitmentUses, daysInCycle
RafTitleInfo · titleMaskID
RafVersionInfo · rafVersion, monthCount, rewards, nextReward?, numAffordableRewards, numRecruits

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (RecruitAFriend system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.