Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:53Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Auction}}
Asks the server to buy an auction listing.

<pre>
BuyAuction(auctionIdHigh, auctionIdLow, revision, price)
</pre>

== Arguments ==
;auctionIdHigh : <code>number</code> – High part of the auction id (<code>auctionIDHigherNum</code> in the stock search results).
;auctionIdLow : <code>number</code> – Low part of the auction id (<code>auctionIDLowerNum</code>).
;revision : <code>number</code> – Revision number of the listing (<code>revision</code>).
;price : <code>number</code> – Price offered, in brass. The stock UI passes the listing's <code>buyOutPrice</code>.

== Returns ==
Nothing.

== Details ==
* Sends a bid request to the server. It is the same request that [[API:CancelAuction|CancelAuction]] sends, with the cancel marker cleared and the price filled in.
* The client does not check the player's money. The stock UI compares <code>Player.GetMoney()</code> with the price first.
* The function needs at least four arguments and only reads the last four.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument is not a number.

== Example ==
From <code>default/ea_auctionhousewindow/source/auctionwindow.lua</code>:
<pre>
if( Player.GetMoney() < auctionData.buyOutPrice )
then
...
return
end

BuyAuction( auctionData.auctionIDHigherNum, auctionData.auctionIDLowerNum, auctionData.revision, auctionData.buyOutPrice )
</pre>

== See also ==
* [[API:CancelAuction|CancelAuction]]
* [[API:CreateAuction|CreateAuction]]
* [[API:SendAuctionSearch|SendAuctionSearch]]

API:BuyAuction - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)