Interface MessageNode

  • All Superinterfaces:
    Node

    public interface MessageNode
    extends Node
    Represents a message in the chatbox.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getId()
      Get the id for this message node
      java.lang.String getName()
      Gets the name of the player that sent the message.
      java.lang.String getRuneLiteFormatMessage()
      Gets the overriden message format.
      java.lang.String getSender()
      Gets the sender of the message.
      int getTimestamp()
      Get the timestamp for the message, in seconds from the unix epoch.
      ChatMessageType getType()
      Gets the type of message.
      java.lang.String getValue()
      Gets the message contents.
      void setName​(java.lang.String name)
      Sets the name of the player that sent the message.
      void setRuneLiteFormatMessage​(java.lang.String runeLiteFormatMessage)
      Sets the overriden message format.
      void setSender​(java.lang.String sender)
      Sets the sender of the message.
      void setTimestamp​(int timestamp)
      Set the timestamp of the message
      void setValue​(java.lang.String value)
      Sets the message contents.
    • Method Detail

      • getId

        int getId()
        Get the id for this message node
        Returns:
      • getType

        ChatMessageType getType()
        Gets the type of message.
        Returns:
        the message type
      • getName

        java.lang.String getName()
        Gets the name of the player that sent the message.
        Returns:
        the player name
      • setName

        void setName​(java.lang.String name)
        Sets the name of the player that sent the message.
        Parameters:
        name - the new player name
      • getSender

        java.lang.String getSender()
        Gets the sender of the message. (ie. friends chat name)
        Returns:
        the message sender
      • setSender

        void setSender​(java.lang.String sender)
        Sets the sender of the message.
        Parameters:
        sender - the new message sender
      • getValue

        java.lang.String getValue()
        Gets the message contents.
        Returns:
        the message contents
      • setValue

        void setValue​(java.lang.String value)
        Sets the message contents.
        Parameters:
        value - the new message contents
      • getRuneLiteFormatMessage

        java.lang.String getRuneLiteFormatMessage()
        Gets the overriden message format.
        Returns:
        the message format
      • setRuneLiteFormatMessage

        void setRuneLiteFormatMessage​(java.lang.String runeLiteFormatMessage)
        Sets the overriden message format.

        If this value is not null, the message contents as returned by getValue() will be replaced with the format set here when a message is processed.

        Parameters:
        runeLiteFormatMessage - the new message format
      • getTimestamp

        int getTimestamp()
        Get the timestamp for the message, in seconds from the unix epoch.
        Returns:
      • setTimestamp

        void setTimestamp​(int timestamp)
        Set the timestamp of the message
        Parameters:
        timestamp -