WoW:API GetGuildBankMoneyTransaction: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Creation)
 
(clarify nil user return)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
gets a specific money transaction from the guild bank
gets a specific money transaction from the guild bank
 
<!-- PTR 0.3.0.7561 Blizzard_GuildBankUI.lua, line 555 -->
  type, user, copper, silver, gold, days, hours = GetGuildBankMoneyTransaction(index);
  type, name, amount, years, months, days, hours = GetGuildBankMoneyTransaction(index)


== Parameters ==
== Parameters ==
:;index : Integer - The index of the transaction to select.
:;index : Integer - The index of the transaction to select.
=== Returns ===
=== Returns ===
:;type : String - The Type of transaction (Deposit | Withdrawal | Repair).
:;type : String - The Type of transaction ("deposit" | "withdrawal" | "repair").
:;user : String - The User that performed a Transaction.
:;user : String - The User that performed a Transaction. A nil return indicates that this data is cached or possibly invalid! In the Blizzard UI nil users are said to be "Unknown"
:;copper : Integer - The Copper value of the Transaction.
:;amount: Integer - The Copper value of the Transaction.
:;silver : Integer -  The Silver value of the Transaction.
:;years: Integer -  The number of years since this transaction took place.
:;gold : Integer -  The Gold value of the Transaction.
:;months: Integer -  The number of months since this transaction took place.
:;unknown : Integer - unknown at this time.
:;days: Integer - The number of days since this transaction took place.
:;hours : Integer -  Hours Since the Transaction took place.
:;hours: Integer -  Hours Since the Transaction took place.


----
----
=== Details ===
=== Details ===
Displays details about a specific Money transaction in the Guild Bank.
Displays details about a specific Money transaction in the Guild Bank.
WARNING: If QueryGuildBankLog(MAX_GUILDBANK_TABS+1) is not called and/or there is no player proximity to the guild bank this will return invalid (cached, lagged, or possibly random) data. When called incorrectly "repair" type transactions have been observed when the Blizzard UI does not show any repair transactions in that guild bank.

Revision as of 23:06, 15 November 2007

WoW API < GetGuildBankMoneyTransaction

gets a specific money transaction from the guild bank

type, name, amount, years, months, days, hours = GetGuildBankMoneyTransaction(index)

Parameters

index
Integer - The index of the transaction to select.

Returns

type
String - The Type of transaction ("deposit" | "withdrawal" | "repair").
user
String - The User that performed a Transaction. A nil return indicates that this data is cached or possibly invalid! In the Blizzard UI nil users are said to be "Unknown"
amount
Integer - The Copper value of the Transaction.
years
Integer - The number of years since this transaction took place.
months
Integer - The number of months since this transaction took place.
days
Integer - The number of days since this transaction took place.
hours
Integer - Hours Since the Transaction took place.

Details

Displays details about a specific Money transaction in the Guild Bank.

WARNING: If QueryGuildBankLog(MAX_GUILDBANK_TABS+1) is not called and/or there is no player proximity to the guild bank this will return invalid (cached, lagged, or possibly random) data. When called incorrectly "repair" type transactions have been observed when the Blizzard UI does not show any repair transactions in that guild bank.