flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Added standardised way to Log with plugin name (#5227)

Browse Source 
* added logging functions to each plugin

* added documentation

* modified the global LOG macro

* updated the way of string composition

* removed cloumn

* removed capital v
This commit is contained in:
12xx12 2021-05-29 18:28:57 +02:00 committed by GitHub
parent c7febf86e9
commit e5fc65264b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Server/Plugins/APIDump/Writing-a-Cuberite-plugin.html
View File

@ -42,12 +42,12 @@ function Initialize(Plugin)
-- Command Bindings -- Command Bindings
LOG("Initialised " .. Plugin:GetName() .. " v." .. Plugin:GetVersion()) LOG("Initialised version " .. Plugin:GetVersion())
return true return true
end end
function OnDisable() function OnDisable()
LOG(PLUGIN:GetName() .. " is shutting down...") LOG("Shutting down...")
end end
</pre> </pre>
<p> <p>
@ -56,7 +56,7 @@ end
<li><b>function Initialize</b> is called on plugin startup. It is the place where the plugin is set up.</li> <li><b>function Initialize</b> is called on plugin startup. It is the place where the plugin is set up.</li>
<li><b>Plugin:SetName</b> sets the name of the plugin.</li> <li><b>Plugin:SetName</b> sets the name of the plugin.</li>
<li><b>Plugin:SetVersion</b> sets the revision number of the plugin. This must be an integer.</li> <li><b>Plugin:SetVersion</b> sets the revision number of the plugin. This must be an integer.</li>
<li><b>LOG</b> logs to console a message, in this case, it prints that the plugin was initialised.</li> <li><b>LOG</b> logs to console a message, in this case, it prints that the plugin was initialised. This will add a prefix with the name of your plugin.</li>
<li>The <b>PLUGIN</b> variable just stores this plugin's object, so GetName() can be called in OnDisable (as no Plugin parameter is passed there, contrary to Initialize). <li>The <b>PLUGIN</b> variable just stores this plugin's object, so GetName() can be called in OnDisable (as no Plugin parameter is passed there, contrary to Initialize).
This global variable is only needed if you want to know the plugin details (name, etc.) when shutting down.</li> This global variable is only needed if you want to know the plugin details (name, etc.) when shutting down.</li>
<li><b>function OnDisable</b> is called when the plugin is disabled, commonly when the server is shutting down. Perform cleanup and logging here.</li> <li><b>function OnDisable</b> is called when the plugin is disabled, commonly when the server is shutting down. Perform cleanup and logging here.</li>

2
src/Bindings/ManualBindings.cpp
View File

@ -362,7 +362,7 @@ static void LogFromLuaStack(lua_State * tolua_S, eLogLevel a_LogLevel)
size_t len = 0; size_t len = 0;
const char * str = lua_tolstring(tolua_S, 1, &len); const char * str = lua_tolstring(tolua_S, 1, &len);
Logger::LogSimple(std::string_view(str, len), a_LogLevel); Logger::LogSimple(fmt::format("[{}] {}", cManualBindings::GetLuaPlugin(tolua_S)->GetName(), std::string_view(str, len)), a_LogLevel);
} }