Interface IPlayerMail


  • public interface IPlayerMail
    Represents a mail message sent to a player, containing pages of text, sender info, optional quest, and item attachments.
    • Method Detail

      • setPageText

        void setPageText​(String[] pages)
        Sets the page text content.
        Parameters:
        pages - an array of strings, one per page.
      • getPageText

        String[] getPageText()
        Returns:
        the page text as an array of strings.
      • getPageCount

        int getPageCount()
        Returns:
        the number of pages.
      • setSender

        void setSender​(String sender)
        Parameters:
        sender - the sender name.
      • getSender

        String getSender()
        Returns:
        the sender name.
      • setSubject

        void setSubject​(String subject)
        Parameters:
        subject - the mail subject line.
      • getSubject

        String getSubject()
        Returns:
        the mail subject line.
      • getTimePast

        long getTimePast()
        Returns:
        milliseconds since the mail was sent.
      • getTimeSent

        long getTimeSent()
        Returns:
        the timestamp when the mail was sent.
      • hasQuest

        boolean hasQuest()
        Returns:
        true if this mail has an associated quest.
      • getQuest

        IQuest getQuest()
        Returns:
        the quest attached to this mail, or null if none.
      • getItems

        IItemStack[] getItems()
        Returns:
        the item attachments.
      • setItems

        void setItems​(IItemStack[] items)
        Parameters:
        items - the item attachments.