RPG Maker Forums

* To add mail to the list:                                                   

  * ZMail.add_mail(key, message, condition(s), name, attachments, sender)

   * 'key' The way you access the mail.

   * 'message' The message content.

   * 'condition(s)' The test run for the mail. This should be an array of

   * string. Editable. 

   * 'name' The displayed name of the mail. Editable. Default: Null_Name. 

   * 'attachments' is an array of strings that will give the player items.

   * Items need to look like: "001|5". This will give the player 5 of item 1.

   * Leading zeros are optional. "1|5" works the same.

   * 'sender' is a string representing who sent the mail.

 *

 * To change the conditions of a piece of mail:

  * ZMail.edit_cond(key, condition, check)

   * 'key' The key for the piece of mail. 'condition' The conditions that

   * determine readability. This should be an array of strings

   * 'check' is a true or false value that will determine if you want to 

   * check the conditions immediately.

 * 

 * To change the display name of a piece of mail:

  * ZMail.rename(key, name)

   * 'key' The key for the piece of mail. 'name' is the displayed name.

 * 

 * To add more to a piece of mail:

  * ZMail.add_to_mail(key, space, mail)

   * 'key' The key for the piece of mail. 'space' True or false value. If 

   * true, a space will be inserted between the end of the previous entry

   * and the beginning of the addition. 'mail' is the additional text.

 * 

 * To see the contents of the entire mail file:

  * ZMail.dump_mail_file

   * Will print out the contents of the mail file to the console. This is 

   * not visible without using a console.

 * 

 * To wipe the mail file and create a new one:

  * ZMail.init(true)

   * Call the init method with true as its parameter. This will force-create

   * a new mail file. There is no chance of recovery after using this.

 * 

 * To let the player read the mail:

  * SceneManager.call(Scene_ZMail)

   * The above script call will run the ZMail scene.

 * 

 * To find out if a piece of mail is readable:

  * ZMail.is_readable(key)

   * This will return true or false, true for readable and false for not.

 *

 

 * To change the attachments later in the game"

  * ZMail.edit_attachments(key, attachments)

   * 'key' is the key associated with the mail.

   * 'attachments' is an array of strings using the same format as add_mail.

 

 * To get a list of the attachments on a piece of mail:

  * ZMail.get_attachments(key)

   * 'key' is the key associated with the mail.

   

 * To clear the attachments off of a piece of mail:

  * ZMail.wipe_attachments(key)

   * 'key' is the key associated with the mail.

   

 * To get the sender name of a piece of mail:

  * ZMail.get_sender_name(key)

   * 'key' is the key associated with the piece of mail.

  

 * To change the sender's name of a piece of mail:

  * ZMail.edit_sender(key, name)

   * 'key' is the key associated with the piece of mail.

   * 'name' is the new name to be given.

  

 

 * To use Control Characters in your mail:

  * The available Control Characters are:

  

   * \\V[#] where '#' is a number. This will display the value of

   * the variable in the brackets.

  

   * \\P[#] where '#' is a number. This will display the display

   * name of the #th actor in your party.

 

   * \\N[#] where '#' is a number. This will display the display

   * name of the #th actor in the database. Do not use leading 0's.

  

  

   * To use these, make sure you put two backslashes before the letter.

   * If you do not, the character will NOT be converted. This is an issue

   * with the Ace engine.

Click to expand...