summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/sample/npc_rodex.txt39
-rw-r--r--doc/script_commands.txt23
2 files changed, 62 insertions, 0 deletions
diff --git a/doc/sample/npc_rodex.txt b/doc/sample/npc_rodex.txt
new file mode 100644
index 000000000..a808a1aa9
--- /dev/null
+++ b/doc/sample/npc_rodex.txt
@@ -0,0 +1,39 @@
+//===== Hercules Script =======================================
+//= Sample: RoDEX Send Mail
+//===== By: ==================================================
+//= KirieZ
+//===== Current Version: =====================================
+//= 20170322
+//===== Description: =========================================
+//= Demonstrates sending mails through RoDEX.
+//============================================================
+
+prontera,150,150,4 script Rodex Mail 1_M_01,{
+ // Sends a messsage to attached player from "Rodex Test", with title "Rodex Test1",
+ // with message "Hello World, How are You?", 1000 Zenies and 5 Red Potions attached
+ rodex_sendmail(
+ getcharid(CHAR_ID_CHAR), "Rodex Test", "Rodex Test1", "Hello World, How are You?",
+ 1000,
+ Red_Potion, 5
+ );
+
+ // Sends a messsage to attached player "Account Box" from "Rodex Test", with title "Rodex Test3",
+ // with message "Hello World, How are You?", 1000 Zenies and 5 Red Potions attached
+ rodex_sendmail_acc(
+ getcharid(CHAR_ID_CHAR), "Rodex Test", "Rodex Test3", "Hello World, How are You?",
+ 1000,
+ Red_Potion, 5
+ );
+
+ // Sends a messsage to attached player "Account Box" from "Rodex Test", with title "Rodex Test6",
+ // with message "Hello World, How are You?", 1000 Zenies, 5 Red Potions and
+ // 1 +10 Knife[3] with 3 Poring Cards (Broken)
+ rodex_sendmail2(
+ getcharid(CHAR_ID_CHAR), "Rodex Test", "Rodex Test6", "Hello World, How are You?",
+ 1000,
+ Red_Potion, 5, 0, 0, 0, 0, 0, 0,
+ Knife, 1, 10, 1, Poring_Card, Poring_Card, Poring_Card, 0
+ );
+
+ end;
+}
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 9148e023c..779cd271c 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -8909,6 +8909,29 @@ Directions are the same as NPC sprite facing directions: (DIR_ constants).
This will open a book item at the specified page.
---------------------------------------
+
+*rodex_sendmail(<char id>, "<sender name>", "<title>", "<body>"{, <zeny>{, <item1>, <amount1>{, <item2>, <amount2>{, <item3>, <amount3>{, <item4>, <amount4>{, <item5>, <amount5>}}}}}})
+*rodex_sendmail_acc(<account id>, "<sender name>", "<title>", "<body>"{, <zeny>{, <item1>, <amount1>{, <item2>, <amount2>{, <item3>, <amount3>{, <item4>, <amount4>{, <item5>, <amount5>}}}}}})
+
+This will send a mail using the RoDEX mail system, in newer clients the message will be marked as a NPC mail (that you can't reply).
+If items and zeny are specified, they will be added as attachments to the message.
+
+For examples of usage, see /doc/sample/npc_rodex.txt
+
+---------------------------------------
+
+*rodex_sendmail2(<char id>, "<sender name>", "<title>", "<body>"{, <zeny>{, <item1>, <amount1>, <refine1>, <attribute1>, <card0_1>, <card1_1>, <card2_1>, <card3_1>{,<item2>, <amount2>, <refine2>, <attribute2>, <card0_2>, <card1_2>, <card2_2>, <card3_2>{,<item3>, <amount3>, <refine3>, <attribute3>, <card0_3>, <card1_3>, <card2_3>, <card3_3>{,<item4>, <amount4>, <refine4>, <attribute4>, <card0_4>, <card1_4>, <card2_4>, <card3_4>{,<item5>, <amount5>, <refine5>, <attribute5>, <card0_5>, <card1_5>, <card2_5>, <card3_5>}}}}}})
+*rodex_sendmail_acc2(<account id>, "<sender name>", "<title>", "<body>"{, <zeny>{, <item1>, <amount1>, <refine1>, <attribute1>, <card0_1>, <card1_1>, <card2_1>, <card3_1>{,<item2>, <amount2>, <refine2>, <attribute2>, <card0_2>, <card1_2>, <card2_2>, <card3_2>{,<item3>, <amount3>, <refine3>, <attribute3>, <card0_3>, <card1_3>, <card2_3>, <card3_3>{,<item4>, <amount4>, <refine4>, <attribute4>, <card0_4>, <card1_4>, <card2_4>, <card3_4>{,<item5>, <amount5>, <refine5>, <attribute5>, <card0_5>, <card1_5>, <card2_5>, <card3_5>}}}}}})
+
+These are more flexible versions of rodex_sendmail and rodex_sendmail_acc.
+
+This will send a mail using the RoDEX mail system, in newer clients the message will be marked as a NPC mail (that you can't reply).
+If items and zeny are specified, they will be added as attachments to the message.
+Check getitem2 command for more information of the extra parameters.
+
+For examples of usage, see /doc/sample/npc_rodex.txt
+
+---------------------------------------
//=====================================
7 - Instance-Related Commands
//=====================================