https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ASendGuildVaultCommandAPI:SendGuildVaultCommand - Revision history2026-10-19T21:42:34ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:SendGuildVaultCommand&diff=30697&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:48:40Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Guild}}<br />
Sends a guild vault command to the server: move an item, deposit or withdraw money, lock or unlock a slot, close the vault, or buy a vault expansion.<br />
<br />
<pre><br />
SendGuildVaultCommand(command, arg1, arg2, arg3, arg4, flag)<br />
</pre><br />
<br />
== Arguments ==<br />
;command : <code>number</code> – A <code>SystemData.GuildVaultCommands</code> value: <code>MOVE_ITEM</code> (1), <code>GIVE_COIN</code> (2), <code>TAKE_COIN</code> (3), <code>SLOT_LOCK</code> (4), <code>SLOT_UNLOCK</code> (5), <code>CLOSE</code> (6), <code>PURCHASE_EXPANSION</code> (7).<br />
;arg1, arg2, arg3, arg4 : <code>number</code> – Command arguments, see the table below. Unused ones must still be numbers (the stock UI passes 0).<br />
;flag : <code>boolean</code> – Only used by <code>MOVE_ITEM</code>, see below.<br />
<br />
{| class="wikitable"<br />
! Command !! arg1 !! arg2 !! arg3 !! arg4<br />
|-<br />
| <code>MOVE_ITEM</code> || source || source slot || destination || destination slot<br />
|-<br />
| <code>GIVE_COIN</code>, <code>TAKE_COIN</code> || amount of money (in brass) || – || – || –<br />
|-<br />
| <code>SLOT_LOCK</code>, <code>SLOT_UNLOCK</code> || vault number || slot || – || –<br />
|-<br />
| <code>CLOSE</code> || – || – || – || –<br />
|-<br />
| <code>PURCHASE_EXPANSION</code> || vault number || expansion cost || – || –<br />
|}<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* Every command also sends the guild NPC id that the client reads from the Lua variable <code>InteractionWindowGuildCreateForm.GuildNPC_ID</code>.<br />
* Slots are passed 1-based, as the stock UI uses them; the client converts them before sending. For <code>PURCHASE_EXPANSION</code> the second value is sent unchanged.<br />
* <code>MOVE_ITEM</code> sources and destinations 1–5 are vault numbers. Other values refer to the player's backpacks: the stock UI passes 0 for the main backpack, or the backpack type plus <code>GuildVaultWindow.MAX_VAULTS</code> (5). The client turns these into inventory slot numbers.<br />
* For <code>MOVE_ITEM</code> into a vault (destination 1–5), <code>flag = true</code> sends the destination slot without the 1-based conversion. For other destinations <code>flag</code> is ignored.<br />
* Any other <code>command</code> value sends nothing.<br />
* If there is no player object, or the Lua state is not available, nothing is sent.<br />
* The function needs at least six arguments and only reads the last six. <code>flag</code> must be a real boolean.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.<br />
<br />
== Example ==<br />
From <code>default/ea_guildvaultwindow/source/guildvaultwindow.lua</code>:<br />
<pre><br />
function GuildVaultWindow.OnClose() -- Registered Event Trigger (User closed the window)<br />
SendGuildVaultCommand(SystemData.GuildVaultCommands.CLOSE, 0, 0, 0, 0, false)<br />
GuildVaultWindow.Hide()<br />
end<br />
</pre><br />
<br />
Depositing money and locking a slot, from the same file:<br />
<pre><br />
SendGuildVaultCommand(SystemData.GuildVaultCommands.GIVE_COIN, money, 0, 0, 0, false)<br />
...<br />
SendGuildVaultCommand(SystemData.GuildVaultCommands.SLOT_LOCK, GuildVaultWindow.SelectedVault, buttonIndex, 0, 0, false)<br />
</pre><br />
<br />
== See also ==<br />
* [[API:SendMailboxCommand|SendMailboxCommand]]<br />
* [[API:SendGuildAllianceCommand|SendGuildAllianceCommand]]</div>Maintenance script