runelite-api: Add missing documentation

This commit is contained in:
Matthew Steglinski
2018-05-25 13:16:12 -04:00
committed by Adam
parent d2871d925c
commit 243d7ddbfa
155 changed files with 4190 additions and 322 deletions

View File

@@ -24,23 +24,75 @@
*/
package net.runelite.api;
/**
* Represents a message in the chatbox.
*/
public interface MessageNode
{
/**
* Gets the type of message.
*
* @return the message type
*/
ChatMessageType getType();
/**
* Gets the name of the player that sent the message.
*
* @return the player name
*/
String getName();
/**
* Sets the name of the player that sent the message.
*
* @param name the new player name
*/
void setName(String name);
/**
* Gets the sender of the message (ie. clan name).
*
* @return the message sender
*/
String getSender();
/**
* Sets the sender of the message.
*
* @param sender the new message sender
*/
void setSender(String sender);
/**
* Gets the message contents.
*
* @return the message contents
*/
String getValue();
/**
* Sets the message contents.
*
* @param value the new message contents
*/
void setValue(String value);
/**
* Gets the overriden message format.
*
* @return the message format
*/
String getRuneLiteFormatMessage();
/**
* Sets the overriden message format.
* <p>
* If this value is not null, the message contents as returned by
* {@link #getValue()} will be replaced with the format set here
* when a message is processed.
*
* @param runeLiteFormatMessage the new message format
*/
void setRuneLiteFormatMessage(String runeLiteFormatMessage);
}