Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:48Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Auction}}
Asks the server to put an item from one of the player's backpacks up for auction.

<pre>
CreateAuction(slot, backpackType, price, restriction)
</pre>

== Arguments ==
;slot : <code>number</code> – Slot of the item inside the backpack, starting at 1.
;backpackType : <code>number</code> – Which backpack the item is in, as an <code>EA_Window_Backpack.TYPE_*</code> value: 2 (<code>TYPE_INVENTORY</code>), 3 (<code>TYPE_CURRENCY</code>) or 4 (<code>TYPE_CRAFTING</code>).
;price : <code>number</code> – Buy-out price in brass.
;restriction : <code>number</code> – Who may buy the item. The stock UI passes the index selected in its restriction combo box.

== Returns ==
Nothing.

== Details ==
* <code>backpackType</code> must be 2, 3 or 4. Any other value (including 1, the quest backpack) raises the error below and nothing is sent.
* The client converts <code>slot</code> and <code>backpackType</code> into an absolute inventory slot before sending. <code>slot</code> is truncated to its low byte (0–255) first.
* The client does not check the price, the deposit or that the slot holds an item. The stock UI does its own checks (enough money for the deposit, a price of at least 1) before calling.
* The function needs at least four arguments and only reads the last four.

== Errors ==
* <code>Error in function call 'CreateAuction': Invalid backpack type.</code>
* The generic ''Invalid Parameters'' message when an argument is not a number.

== Example ==
From <code>default/ea_auctionhousewindow/source/auctionwindowsellcontrols.lua</code>:
<pre>
local restrictionChoice = ComboBoxGetSelectedMenuItem( SELL_CONTROLS_NAME.."RestrictionComboBox" )

CreateAuction( AuctionWindowSellControls.itemInventorySlot.slot, AuctionWindowSellControls.itemInventorySlot.backpack, buyOutPrice, restrictionChoice )
</pre>

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

API:CreateAuction - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)