173.25.92.203: /* UMM_TakeMai */

2010-12-23T19:16:27Z

‎UMM_TakeMai

173.25.92.203: Created page with 'Rock5's Mail Addons provide you with a way to send specific items, using a number of different qualifying factors, as well as empty the mailbox. == Functions == === UMM_SendByN…'

2010-12-23T19:11:52Z

Created page with 'Rock5's Mail Addons provide you with a way to send specific items, using a number of different qualifying factors, as well as empty the mailbox. == Functions == === UMM_SendByN…'

New page

Rock5's Mail Addons provide you with a way to send specific items, using a number of different qualifying factors, as well as empty the mailbox.

== Functions ==

=== UMM_SendByNameOrId===

Use this function to send all items of specific names or ids.

==== Arguments ====
'''Recipient''': The person who you intend to send the mail message to.

'''ItemTable''': Accepts a table <code>{"Golden Egg","Beetle Leg"}</code> of items to send to the '''Recipient'''.

==== Example ====
The following example sends ''Player2'' all "Golden Egg"s and "Beetle Leg"s.

<code>UMM_SendByNameOrId("player2", {"Golden Egg","Beetle Leg"})</code>

==== Returns ====
Unknown

----

=== UMM_SendByStatNumber ===

Use this to send items with a given number of stats.
==== Arguments ====
'''Recipient''': The person who you intend to send the mail message to.

'''StatNo''': ''(optional) [Default: 3]'' This is the number of stats an item must have to be sent to '''Recipient'''.

==== Example ====
The following example sends ''Player2'' all items with 3 or more stats.

<code>UMM_SendByStatNumber("Player2")</code>

The following example sends ''Player3'' all items with 4 or more stats.

<code>UMM_SendByStatNumber("Player2", 4)</code>

==== Returns ====
Unknown

----

=== UMM_SendByQuality ===

Use this function to send items of a particular quality or better.

==== Arguments ====
'''Recipient''': The person who you intend to send the mail message to.

'''Quality''': This argument is used to select what quality of items to send to the '''Recipient'''.

==== Example ====
The following example sends ''Player2'' all blue gear or better.

<code>UMM_SendByQuality("Player2", 2)</code>

==== Returns ====
Unknown

----

=== UMM_SendMoney ===

Use this function to send an amount of gold.

==== Arguments ====
'''Recipient''': The person who you intend to send the mail message to.

'''Amount''': A number of gold to '''Recipient''' or "all" to send all of the characters money.

==== Example ====
The following example sends ''Player2'' 500 gold.

<code>UMM.SendMoney("Player2", 500)</code>

The following example sends ''Player3'' all gold.

<code>UMM.SendMoney("Player3", "all")</code>

==== Returns ====
Unknown

----

=== UMM_SendAdvanced ===

Use this function as a general purpose sending function. All included terms must match.

<code>UMM_SendByNameOrId (Recipient, ItemTable)</code><br>
Use this function to send all items of specific names or ids.
==== Arguments ====
'''Recipient''': The person who you intend to send the mail message to.

'''NameOrId''': Accepts a table <code>{"Golden Egg","Beetle Leg"}</code> of items to send to the '''Recipient'''.

'''Quality''': This argument is used to select what quality of items to send to the '''Recipient'''.

'''ReqLevel''': The level required to wear or use the item. [UNVERIFIED]

'''Worth''': The item's value in gold, to a vendor. [UNVERIFIED]

'''ObjType''': UNKOWN [UNVERIFIED]

==== Example ====
The following example sends ''Player2'' all items level 54 or higher of blue or better quality.

<code>UMM_SendAdvanced("Player2",nil , 2, 54)</code>

==== Returns ====
Unknown

----

=== UMM_TakeMai===

This function removes all mail from an open mailbox.

==== Arguments ====

''None.''

==== Example ====
The following example takes all the mail from the mailbox.

<code>UMM_TakeMail()</code>

==== Returns ====
Unknown

== Installation Instructions ==
Place [http://www.solarstrike.net/phpBB3/download/file.php?id=860 Part 1] (Modified Ultimate MailMod) in your ''Runes of Magic/Interface/Addons'' folder.

Place [http://www.solarstrike.net/phpBB3/download/file.php?id=962 Part 2] (addon_Rock5s_Mail_Functions.lua) in your ''MicroMacro/scripts/rom/userfunctions'' folder.

@@ Line 115: / Line 115: @@
 ----
-=== UMM_TakeMai===
+=== UMM_TakeMail===
 This function removes all mail from an open mailbox.

Rock5's Mail Mods - Revision history

173.25.92.203: /* UMM_TakeMai */

173.25.92.203: Created page with 'Rock5's Mail Addons provide you with a way to send specific items, using a number of different qualifying factors, as well as empty the mailbox. == Functions == === UMM_SendByN…'