From 1ef018c93bbfe8d86cb895b57151b27a080abccb Mon Sep 17 00:00:00 2001 From: Charlie Kobayashi Date: Tue, 30 Jan 2018 10:38:03 -0500 Subject: [PATCH] COMMANDS.md: Reflect modlog changes (#4322) --- chat-plugins/COMMANDS.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/chat-plugins/COMMANDS.md b/chat-plugins/COMMANDS.md index b2faee4fef..03fb3f3a93 100644 --- a/chat-plugins/COMMANDS.md +++ b/chat-plugins/COMMANDS.md @@ -110,12 +110,13 @@ Commands have access to the following functions: * Log a message to the room's log without sending it to anyone. This is like `this.add`, except no one will see it. -`this.addModCommand(message)` -* Like this.add, but also logs the message to the moderator log which can - be seen with `/modlog`. +`this.addModAction(message)` +* Like this.add, except it logs the message as being sent as the user who used the command. + This does not log anything into the modlog -`this.logModCommand(message)` -* Like `this.addModCommand`, except users in the room won't see it. +`this.modlog(action, user, note, options)` +* Adds a log line into the room's modlog, similar to `this.globalModlog`. + The arguments `user` (the targeted user), `note` (details), and `options` (no ip, no alts) are optional. `this.can(permission)` `this.can(permission, targetUser)`