WoW:API GetAuctionItemTimeLeft: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Another small error)
(upgraded deprecated template)
Line 1: Line 1:
{{wowapi}}
Retrieves the time left for a item in the Auction House.
Retrieves the time left for a item in the Auction House.


Line 35: Line 36:


: Retrieves the time left for an item in the current list of auction items.
: Retrieves the time left for an item in the current list of auction items.
----
{{Template:WoW API}}

Revision as of 18:11, 6 January 2007

WoW API < GetAuctionItemTimeLeft

Retrieves the time left for a item in the Auction House.

timeleft = GetAuctionTimeLeft("type", index);

Arguments
(String type, Number index)
type
One of the following:
"list"
An item up for auction, the "Browse" tab in the dialog.
"bidder"
An item the player has bid on, the "Bids" tab in the dialog.
"owner"
An item the player has up for auction, the "Auctions" tab in the dialog.
index
The index of the item in the list to retrieve info from (normally 1-50, inclusive)

Returns
timeleft
a number between 1 and 4
1
short time (less then 30 min.)
2
medium time (30 min. till 2 hours)
3
long time (2 till 8 hours)
4
very long time (more then 8 hours)

Example
timeleft = GetAuctionTimeLeft("owner", offset + i);
Result

Returns the time that the item will stay in the auction house. Affects nothing other than the return values.


Description
Retrieves the time left for an item in the current list of auction items.