summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump
diff options
context:
space:
mode:
Diffstat (limited to 'Server/Plugins/APIDump')
-rw-r--r--Server/Plugins/APIDump/APIDesc.lua118
-rw-r--r--Server/Plugins/APIDump/main_APIDump.lua4
2 files changed, 58 insertions, 64 deletions
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 =
{
diff --git a/Server/Plugins/APIDump/main_APIDump.lua b/Server/Plugins/APIDump/main_APIDump.lua
index 61dd1e66c..b1277ca0b 100644
--- a/Server/Plugins/APIDump/main_APIDump.lua
+++ b/Server/Plugins/APIDump/main_APIDump.lua
@@ -36,7 +36,7 @@ local function LoadAPIFiles(a_Folder, a_DstTable)
if (a_DstTable[k]) then
-- The class is documented in two files, warn and store into a file (so that CIs can mark build as failure):
LOGWARNING(string.format(
- "APIDump warning: class %s is documented at two places, the documentation in file %s will overwrite the previously loaded one!",
+ "Warning: class %s is documented at two places, the documentation in file %s will overwrite the previously loaded one!",
k, FileName
))
local f = io.open("DuplicateDocs.txt", "a")
@@ -2115,7 +2115,7 @@ function Initialize(Plugin)
g_Plugin = Plugin;
g_PluginFolder = Plugin:GetLocalFolder();
- LOG("Initialising " .. Plugin:GetName() .. " v." .. Plugin:GetVersion())
+ LOG("Initialising v." .. Plugin:GetVersion())
-- Bind a console command to dump the API:
cPluginManager:BindConsoleCommand("api", HandleCmdApi, "Dumps the Lua API docs into the API/ subfolder")