From cc9f7c06b39ce840d0dcde36e816cf025bd7ce81 Mon Sep 17 00:00:00 2001
From: x12xx12x <44411062+12xx12@users.noreply.github.com>
Date: Wed, 23 Jun 2021 00:09:06 +0200
Subject: Add optional prefix parameter to LOG functions (#5229)

Co-authored-by: Tiger Wang <ziwei.tiger@outlook.com>
---
 Server/Plugins/APIDump/APIDesc.lua | 118 ++++++++++++++++++-------------------
 1 file changed, 56 insertions(+), 62 deletions(-)

(limited to 'Server/Plugins/APIDump/APIDesc.lua')

diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua
index af6049fba..5d571c799 100644
--- a/Server/Plugins/APIDump/APIDesc.lua
+++ b/Server/Plugins/APIDump/APIDesc.lua
@@ -10931,14 +10931,26 @@ a_Player:OpenWindow(Window);
 				},
 				SendMessage =
 				{
-					Params =
 					{
+						Params =
 						{
-							Name = "Message",
-							Type = "string",
+							{
+								Name = "Message",
+								Type = "string",
+							},
 						},
+						Notes = "Sends the specified message to the player.",
+					},
+					{
+						Params =
+						{
+							{
+								Name = "Message",
+								Type = "cCompositeChat",
+							},
+						},
+						Notes = "Sends the {{cCompositeChat}} to the player, using a severity defined by the CompositeChat's MessageType.",
 					},
-					Notes = "Sends the specified message to the player.",
 				},
 				SendMessageRaw =
 				{
@@ -14590,8 +14602,13 @@ end
 								Name = "Message",
 								Type = "string",
 							},
+							{
+								Name = "SuppressPluginNamePrefix",
+								Type = "boolean",
+								IsOptional = true,
+							},
 						},
-						Notes = "Logs a text into the server console and logfile using 'normal' severity (gray text)",
+						Notes = "Logs a text into the server console and logfile using 'normal' severity (gray text).",
 					},
 					{
 						Params =
@@ -14600,101 +14617,78 @@ end
 								Name = "Message",
 								Type = "cCompositeChat",
 							},
+							{
+								Name = "SuppressPluginNamePrefix",
+								Type = "boolean",
+								IsOptional = true,
+							},
 						},
-						Notes = "Logs the {{cCompositeChat}}'s human-readable text into the server console. The severity is converted from the CompositeChat's MessageType.",
+						Notes = "Logs the {{cCompositeChat}}'s human-readable text into the server console, using a severity defined by the CompositeChat's MessageType.",
 					},
 				},
 				LOGERROR =
 				{
+					Params =
 					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "string",
-							},
+							Name = "Message",
+							Type = "string",
 						},
-						Notes = "Logs a text into the server console and logfile using 'error' severity (black text on red background)",
-					},
-					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "cCompositeChat",
-							},
+							Name = "SuppressPluginNamePrefix",
+							Type = "boolean",
+							IsOptional = true,
 						},
-						Notes = "Logs the {{cCompositeChat}}'s human-readable text into the server console and logfile using 'error' severity (black text on red background)",
 					},
+					Notes = "Logs a text into the server console and logfile using 'error' severity (black text on red background).",
 				},
 				LOGINFO =
 				{
+					Params =
 					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "string",
-							},
+							Name = "Message",
+							Type = "string",
 						},
-						Notes = "Logs a text into the server console and logfile using 'info' severity (yellow text)",
-					},
-					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "cCompositeChat",
-							},
+							Name = "SuppressPluginNamePrefix",
+							Type = "boolean",
+							IsOptional = true,
 						},
-						Notes = "Logs the {{cCompositeChat}}'s human-readable text into the server console and logfile using 'info' severity (yellow text)",
 					},
+					Notes = "Logs a text into the server console and logfile using 'info' severity (yellow text).",
 				},
 				LOGWARN =
 				{
+					Params =
 					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "string",
-							},
+							Name = "Message",
+							Type = "string",
 						},
-						Notes = "Logs a text into the server console and logfile using 'warning' severity (red text); OBSOLETE, use LOGWARNING() instead",
-					},
-					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "cCompositeChat",
-							},
+							Name = "SuppressPluginNamePrefix",
+							Type = "boolean",
+							IsOptional = true,
 						},
-						Notes = "Logs the {{cCompositeChat}}'s human-readable text into the server console and logfile using 'warning' severity (red text); OBSOLETE, use LOGWARNING() instead",
 					},
+					Notes = "Logs a text into the server console and logfile using 'warning' severity (red text); OBSOLETE, use LOGWARNING() instead.",
 				},
 				LOGWARNING =
 				{
+					Params =
 					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "string",
-							},
+							Name = "Message",
+							Type = "string",
 						},
-						Notes = "Logs a text into the server console and logfile using 'warning' severity (red text)",
-					},
-					{
-						Params =
 						{
-							{
-								Name = "Message",
-								Type = "cCompositeChat",
-							},
+							Name = "SuppressPluginNamePrefix",
+							Type = "boolean",
+							IsOptional = true,
 						},
-						Notes = "Logs the {{cCompositeChat}}'s human-readable text into the server console and logfile using 'warning' severity (red text)",
 					},
+					Notes = "Logs a text into the server console and logfile using 'warning' severity (red text).",
 				},
 				md5 =
 				{
-- 
cgit v1.2.3