summaryrefslogtreecommitdiff
path: root/include/modules.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/modules.h')
-rw-r--r--include/modules.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/include/modules.h b/include/modules.h
index 28c3f525e..8f95e4e86 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -276,6 +276,16 @@ class Server : public classbase
/** Sends text from a user to another user.
* This method writes a line of text to a user, with a user's nick/ident
* /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
+ * If you specify NULL as the source, then the data will originate from the
+ * local server, e.g. instead of:
+ *
+ * :user!ident@host TEXT
+ *
+ * The format will become:
+ *
+ * :localserver TEXT
+ *
+ * Which is useful for numerics and server notices to single users, etc.
*/
virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
/** Sends text from a user to a channel (mulicast).