View source for API:DonateToAltar

{{LuaApi|group=RvR}}
Asks the server to donate items to the altar the player is interacting with.

<pre>
DonateToAltar(donationType, amount)
</pre>

== Arguments ==
;donationType : <code>number</code> – Kind of donation. The stock UI passes <code>EA_Window_InteractionAltar.donationType</code>. Only the low 16 bits are sent.
;amount : <code>number</code> – Number of items to donate.

== Returns ==
Nothing.

== Details ==
* The request is sent as an interaction with the object the player last interacted with, together with both values. Nothing is sent if there is no such object or if the network connection is not ready.
* The client does not check <code>amount</code> against the backpack. The stock altar window does: if the player asks for more than they carry, it offers to donate everything instead.
* The function needs at least two arguments and only reads the last two.

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

== Example ==
From <code>default/ea_interactionwindow/source/interactionaltar.lua</code>:
<pre>
local amount = tonumber( TextEditBoxGetText( "EA_Window_InteractionAltarDonationEditBox" ) )
if ( amount > 0 ) then
    if ( amount <= EA_Window_InteractionAltar.numItemsInBackpack ) then
        DonateToAltar( EA_Window_InteractionAltar.donationType, amount )
    else
        ...
</pre>

== See also ==
* [[API:FireAltarAbility|FireAltarAbility]]