WoW API: GetGuildBankWithdrawGoldLimit

From AddOn Studio
Revision as of 04:45, 15 August 2023 by Move page script (talk | contribs) (Move page script moved page API GetGuildBankWithdrawGoldLimit to API GetGuildBankWithdrawGoldLimit without leaving a redirect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

WoW API < GetGuildBankWithdrawGoldLimit

dailyGoldWithdrawlLimit = GetGuildBankWithdrawGoldLimit()

Parameters[edit]

Arguments none

Returns

dailyGoldWithdrawlLimit
Number - amount (in GOLD) the currently selected Guild Rank can withdraw per day


Details[edit]

In order for this to work properly, you need to have a rank set in the guildControl

Example of checking the daily limit for the currently logged on character...

-- create somewhere to store the result and default it
local dailyGoldWithdrawlLimit = 0
-- need to get the guildRankIndex for the currently logged on player
guildName, _, guildRankIndex = GetGuildInfo("player")
-- guildName is nil if the character isn't in a guild
if (guildName ~= nil) then
-- This character is in a guild, so set the current rank so the limit will work
GuildControlSetRank(guildRankIndex)
dailyGoldWithdrawlLimit = GetGuildBankWithdrawGoldLimit()
end
NOTE: this return value is in GOLD unlike many other currency returns in WOW where they give you copper pieces...