Add 'override' mod @ Git commit cd24d1c:

https://github.com/AntumMT/mod-override/tree/cd24d1c
master
AntumDeluge 2017-08-03 22:06:44 -07:00
parent e57d6b7d6f
commit 49f62719c0
15 changed files with 1106 additions and 0 deletions

View File

@ -13,6 +13,7 @@ The game includes the mods from the default [minetest_game](https://github.com/m
* admin/
* [clean][] ([WTFPL][lic.wtfpl]) -- version: Unknown *2013-06-08* ([patched][patch.clean])
* [invisible][] ([LGPL][lic.lgpl2.1] / [CC BY-SA][lic.ccbysa3.0])
* [override][] ([MIT][lic.mit]) -- version: [0.1 (cd24d1c Git)][ver.override] *2017-08-02*
* [privilegeareas][] ([WTFPL][lic.privilegeareas] / [CC0][lic.cc0]) -- version: [aebaa00 Git][ver.privilegeareas] *2016-05-18*
* [privs][] ([CC0][lic.cc0])
* [spectator_mode][] ([WTFPL][lic.spectator_mode]) -- version: [7d68bec Git][ver.spectator_mode] *2017-03-30*
@ -283,6 +284,7 @@ The game includes the mods from the default [minetest_game](https://github.com/m
[mysheetmetal]: https://forum.minetest.net/viewtopic.php?t=11702
[mywoodslopes]: https://forum.minetest.net/viewtopic.php?t=11433
[nether]: https://forum.minetest.net/viewtopic.php?t=5790
[override]: https://forum.minetest.net/viewtopic.php?t=18229
[painting]: https://github.com/minetest-mods/painting
[peaceful_npc]: https://forum.minetest.net/viewtopic.php?t=4167
[pipeworks]: https://forum.minetest.net/viewtopic.php?t=2155
@ -500,6 +502,7 @@ The game includes the mods from the default [minetest_game](https://github.com/m
[ver.mysheetmetal]: https://github.com/minetest-mods/mysheetmetal/tree/7c5ab71
[ver.mywoodslopes]: https://github.com/minetest-mods/mywoodslopes/tree/3a1b531
[ver.nether]: https://github.com/PilzAdam/nether/tree/bc2ccfb
[ver.override]: https://github.com/AntumMT/mod-override/tree/cd24d1c
[ver.peaceful_npc]: https://github.com/jojoa1997/peaceful_npc/tree/2b3a7a5
[ver.pipeworks]: https://github.com/minetest-mods/pipeworks/tree/2eff6e3
[ver.playeranim]: https://github.com/minetest-mods/playeranim/tree/59bcd38

View File

@ -0,0 +1,21 @@
MIT License
Copyright © 2017 Jordan Irwin (AntumDeluge)
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -0,0 +1,28 @@
## Override Mod for [Minetest][]
---
### **Description:**
A mod to simplify overriding craft items. Overriding other types of objects may be supported in the future.
---
### **Licensing:**
- [MIT](LICENSE.txt)
---
### **Requirements:**
- Depends: none
---
### **Documentation:**
- [API Documentation](https://antummt.github.io/mod-override/)
[Minetest]: http://www.minetest.net/

View File

@ -0,0 +1,69 @@
--[[ LICENSE HEADER
MIT Licensing
Copyright © 2017 Jordan Irwin
See: LICENSE.txt
--]]
--- Override Mod API
--
-- @script api.lua
--- Unregisters craft items & adds them as aliases.
--
-- Unregisters items & set names as aliases for another existing item.
--
-- @function override.replaceItems
-- @param items List of item names to be overridden (can be string for single item override).
-- @param target Item name of aliases' target.
function override.replaceItems(items, target)
if type(items) == 'string' then
override.logDebug('Overriding item "' .. items .. '" with "' .. target .. '"')
core.unregister_item(items)
core.register_alias(items, target)
else
for i, it in ipairs(items) do
override.logDebug('Overriding item "' .. it .. '" with "' .. target .. '"')
core.unregister_item(it)
core.register_alias(it, target)
end
end
end
--- Unregisters craft items & registers names as aliases for new item.
--
-- Registers a new craft item & adds overridden item names as aliases.
--
-- @function override.overrideItems
-- @tparam string name Name of new item.
-- @tparam table def Item definition.
-- @see override.overrideItems.def
function override.overrideItems(name, def)
local overrides = def.overrides
def.overrides = nil
core.register_craftitem(name, def)
override.replaceItems(overrides, name)
end
--- Item definition table for *override.overrideItems*
--
-- @table override.overrideItems.def
-- @tfield table overrides Old items to be overridden (can be *string* for single item override).
-- @tfield string description Inventory tooltip.
-- @tfield table groups The groups of the craftitem.
-- @tfield imagestring inventory_image Texture displayed in inventory.
-- @tfield imagestring wield_image Texture displayed when wielded.
-- @tfield pos wield_scale Scale of *wield_image*.
-- @tfield int stack_max Maximum amount of items per stack (default: 99).
-- @tfield bool liquids_pointable Whether the player can point at liquids while wielding the item or not (default: false).
-- @field metadata
-- @tfield callback on_place Called on *rightclick*.
-- @tfield callback on_drop Called when dropping the item.
-- @tfield callback on_use Called on *leftclick*.
-- @see override.overrideItems

View File

View File

@ -0,0 +1,73 @@
title = 'Overrides Mod for Minetest'
project = 'overrides'
format = 'markdown'
not_luadoc = true
--wrap = true
boilerplate = true
local function tagoutput(value)
return '<i>' .. value .. '</i>'
end
new_type('setting', 'Settings')
new_type('chatcmd', 'Chat Commands', false, 'chatparam')
custom_tags = {
{'default',
format = tagoutput,
},
{'type2',
title = 'Type',
format = tagoutput,
},
{'dfield',
title = 'Definition Fields',
},
{'chatparam',
title = 'Parameters',
},
{'option',
title = 'Options',
--[[
format = function(item, handler)
print(type(handler))
print(type(item))
print(item)
return '<b><i>' .. name .. '</i></b>'
end,
]]
},
{'settype',
title = 'Type',
format = function(item)
return '<i>' .. item .. '</i>'
end,
}
}
alias('tchatparam', 'chatparam')
local function chatcmd_handler(item)
local output = item.name
for i, p in ipairs(item.tags.chatparam) do
output = output .. ' ' .. p
end
return output
end
function custom_display_name_handler(item, default_handler)
if item.type == 'chatcmd' then
return chatcmd_handler(item)
end
--[[
if not is_list(item) then
print('Not list')
else
print('Is list')
end
]]
return default_handler(item)
end
file = {'api.lua', 'logging.api',}

View File

@ -0,0 +1,14 @@
#!/bin/bash
DOCS="$(dirname $(readlink -f $0))"
ROOT="$(dirname ${DOCS})"
CONFIG="${DOCS}/config.ld"
OUT="${DOCS}"
cd "${ROOT}"
# Clean old files
rm -rf "${OUT}/index.html" "${OUT}/modules" "${OUT}/scripts"
# Create new files
ldoc -c "${CONFIG}" -d "${OUT}" "${ROOT}"

View File

@ -0,0 +1,69 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Overrides Mod for Minetest</title>
<link rel="stylesheet" href="ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>overrides</h1>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="scripts/api.lua.html">api.lua</a></li>
<li><a href="scripts/init.lua.html">init.lua</a></li>
<li><a href="scripts/logging.lua.html">logging.lua</a></li>
</ul>
</div>
<div id="content">
<h2>Scripts</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="scripts/api.lua.html">api.lua</a></td>
<td class="summary">Override Mod API</td>
</tr>
<tr>
<td class="name" nowrap><a href="scripts/init.lua.html">init.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="scripts/logging.lua.html">logging.lua</a></td>
<td class="summary">Logging functions.</td>
</tr>
</table>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2017-08-02 23:27:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@ -0,0 +1,307 @@
/* BEGIN RESET
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://developer.yahoo.com/yui/license.html
version: 2.8.2r1
*/
html {
color: #000;
background: #FFF;
}
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
margin: 0;
padding: 0;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
fieldset,img {
border: 0;
}
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
font-style: inherit;
font-weight: inherit;
}
del,ins {
text-decoration: none;
}
li {
list-style: disc;
margin-left: 20px;
}
caption,th {
text-align: left;
}
h1,h2,h3,h4,h5,h6 {
font-size: 100%;
font-weight: bold;
}
q:before,q:after {
content: '';
}
abbr,acronym {
border: 0;
font-variant: normal;
}
sup {
vertical-align: baseline;
}
sub {
vertical-align: baseline;
}
legend {
color: #000;
}
input,button,textarea,select,optgroup,option {
font-family: inherit;
font-size: inherit;
font-style: inherit;
font-weight: inherit;
}
input,button,textarea,select {*font-size:100%;
}
/* END RESET */
body {
margin-left: 1em;
margin-right: 1em;
font-family: arial, helvetica, geneva, sans-serif;
background-color: #ffffff; margin: 0px;
}
code, tt { font-family: monospace; font-size: 1.1em; }
span.parameter { font-family:monospace; }
span.parameter:after { content:":"; }
span.types:before { content:"("; }
span.types:after { content:")"; }
.type { font-weight: bold; font-style:italic }
body, p, td, th { font-size: .95em; line-height: 1.2em;}
p, ul { margin: 10px 0 0 0px;}
strong { font-weight: bold;}
em { font-style: italic;}
h1 {
font-size: 1.5em;
margin: 0 0 20px 0;
}
h2, h3, h4 { margin: 15px 0 10px 0; }
h2 { font-size: 1.25em; }
h3 { font-size: 1.15em; }
h4 { font-size: 1.06em; }
a:link { font-weight: bold; color: #004080; text-decoration: none; }
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
a:link:hover { text-decoration: underline; }
hr {
color:#cccccc;
background: #00007f;
height: 1px;
}
blockquote { margin-left: 3em; }
ul { list-style-type: disc; }
p.name {
font-family: "Andale Mono", monospace;
padding-top: 1em;
}
pre.example {
background-color: rgb(245, 245, 245);
border: 1px solid silver;
padding: 10px;
margin: 10px 0 10px 0;
font-family: "Andale Mono", monospace;
font-size: .85em;
}
pre {
background-color: rgb(245, 245, 245);
border: 1px solid silver;
padding: 10px;
margin: 10px 0 10px 0;
overflow: auto;
font-family: "Andale Mono", monospace;
}
table.index { border: 1px #00007f; }
table.index td { text-align: left; vertical-align: top; }
#container {
margin-left: 1em;
margin-right: 1em;
background-color: #f0f0f0;
}
#product {
text-align: center;
border-bottom: 1px solid #cccccc;
background-color: #ffffff;
}
#product big {
font-size: 2em;
}
#main {
background-color: #f0f0f0;
border-left: 2px solid #cccccc;
}
#navigation {
float: left;
width: 14em;
vertical-align: top;
background-color: #f0f0f0;
overflow: visible;
}
#navigation h2 {
background-color:#e7e7e7;
font-size:1.1em;
color:#000000;
text-align: left;
padding:0.2em;
border-top:1px solid #dddddd;
border-bottom:1px solid #dddddd;
}
#navigation ul
{
font-size:1em;
list-style-type: none;
margin: 1px 1px 10px 1px;
}
#navigation li {
text-indent: -1em;
display: block;
margin: 3px 0px 0px 22px;
}
#navigation li li a {
margin: 0px 3px 0px -1em;
}
#content {
margin-left: 14em;
padding: 1em;
width: 700px;
border-left: 2px solid #cccccc;
border-right: 2px solid #cccccc;
background-color: #ffffff;
}
#about {
clear: both;
padding: 5px;
border-top: 2px solid #cccccc;
background-color: #ffffff;
}
@media print {
body {
font: 12pt "Times New Roman", "TimeNR", Times, serif;
}
a { font-weight: bold; color: #004080; text-decoration: underline; }
#main {
background-color: #ffffff;
border-left: 0px;
}
#container {
margin-left: 2%;
margin-right: 2%;
background-color: #ffffff;
}
#content {
padding: 1em;
background-color: #ffffff;
}
#navigation {
display: none;
}
pre.example {
font-family: "Andale Mono", monospace;
font-size: 10pt;
page-break-inside: avoid;
}
}
table.module_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.module_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.module_list td.summary { width: 100%; }
table.function_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.function_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.function_list td.summary { width: 100%; }
ul.nowrap {
overflow:auto;
white-space:nowrap;
}
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
dl.table h3, dl.function h3 {font-size: .95em;}
/* stop sublists from having initial vertical space */
ul ul { margin-top: 0px; }
ol ul { margin-top: 0px; }
ol ol { margin-top: 0px; }
ul ol { margin-top: 0px; }
/* make the target distinct; helps when we're navigating to a function */
a:target + * {
background-color: #FF9;
}
/* styles for prettification of source */
pre .comment { color: #558817; }
pre .constant { color: #a8660d; }
pre .escape { color: #844631; }
pre .keyword { color: #aa5050; font-weight: bold; }
pre .library { color: #0e7c6b; }
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
pre .string { color: #8080ff; }
pre .number { color: #f8660d; }
pre .operator { color: #2239a8; font-weight: bold; }
pre .preprocessor, pre .prepro { color: #a33243; }
pre .global { color: #800080; }
pre .prompt { color: #558817; }
pre .url { color: #272fc2; text-decoration: underline; }

View File

@ -0,0 +1,239 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Overrides Mod for Minetest</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>overrides</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Tables">Tables</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><strong>api.lua</strong></li>
<li><a href="../scripts/init.lua.html">init.lua</a></li>
<li><a href="../scripts/logging.lua.html">logging.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Script <code>api.lua</code></h1>
<p>Override Mod API</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#override.replaceItems">override.replaceItems (items, target)</a></td>
<td class="summary">Unregisters craft items &amp; adds them as aliases.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#override.overrideItems">override.overrideItems (name, def)</a></td>
<td class="summary">Unregisters craft items &amp; registers names as aliases for new item.</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#override.overrideItems.def">override.overrideItems.def</a></td>
<td class="summary">Item definition table for <em>override.overrideItems</em></td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "override.replaceItems"></a>
<strong>override.replaceItems (items, target)</strong>
</dt>
<dd>
Unregisters craft items &amp; adds them as aliases.</p>
<p> Unregisters items &amp; set names as aliases for another existing item.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">items</span>
List of item names to be overridden (can be string for single item override).
</li>
<li><span class="parameter">target</span>
Item name of aliases' target.
</li>
</ul>
</dd>
<dt>
<a name = "override.overrideItems"></a>
<strong>override.overrideItems (name, def)</strong>
</dt>
<dd>
Unregisters craft items &amp; registers names as aliases for new item.</p>
<p> Registers a new craft item &amp; adds overridden item names as aliases.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
Name of new item.
</li>
<li><span class="parameter">def</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
Item definition.
</li>
</ul>
<h3>See also:</h3>
<ul>
<a href="../scripts/api.lua.html#override.overrideItems.def">override.overrideItems.def</a>
</ul>
</dd>
</dl>
<h2><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "override.overrideItems.def"></a>
<strong>override.overrideItems.def</strong>
</dt>
<dd>
Item definition table for <em>override.overrideItems</em>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Fields:</h3>
<ul>
<li><span class="parameter">overrides</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
Old items to be overridden (can be <em>string</em> for single item override).
</li>
<li><span class="parameter">description</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
Inventory tooltip.
</li>
<li><span class="parameter">groups</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
The groups of the craftitem.
</li>
<li><span class="parameter">inventory_image</span>
<span class="types"><span class="type">imagestring</span></span>
Texture displayed in inventory.
</li>
<li><span class="parameter">wield_image</span>
<span class="types"><span class="type">imagestring</span></span>
Texture displayed when wielded.
</li>
<li><span class="parameter">wield_scale</span>
<span class="types"><span class="type">pos</span></span>
Scale of <em>wield_image</em>.
</li>
<li><span class="parameter">stack_max</span>
<span class="types"><span class="type">int</span></span>
Maximum amount of items per stack (default: 99).
</li>
<li><span class="parameter">liquids_pointable</span>
<span class="types"><span class="type">bool</span></span>
Whether the player can point at liquids while wielding the item or not (default: false).
</li>
<li><span class="parameter">metadata</span>
</li>
<li><span class="parameter">on_place</span>
<span class="types"><span class="type">callback</span></span>
Called on <em>rightclick</em>.
</li>
<li><span class="parameter">on_drop</span>
<span class="types"><span class="type">callback</span></span>
Called when dropping the item.
</li>
<li><span class="parameter">on_use</span>
<span class="types"><span class="type">callback</span></span>
Called on <em>leftclick</em>.
</li>
</ul>
<h3>See also:</h3>
<ul>
<a href="../scripts/api.lua.html#override.overrideItems">override.overrideItems</a>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2017-08-02 23:27:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@ -0,0 +1,66 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Overrides Mod for Minetest</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>overrides</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="../scripts/api.lua.html">api.lua</a></li>
<li><strong>init.lua</strong></li>
<li><a href="../scripts/logging.lua.html">logging.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Script <code>init.lua</code></h1>
<p></p>
<p></p>
<br/>
<br/>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2017-08-02 23:27:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@ -0,0 +1,143 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Overrides Mod for Minetest</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>overrides</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="../scripts/api.lua.html">api.lua</a></li>
<li><a href="../scripts/init.lua.html">init.lua</a></li>
<li><strong>logging.lua</strong></li>
</ul>
</div>
<div id="content">
<h1>Script <code>logging.lua</code></h1>
<p>Logging functions.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#override.log">override.log (level, msg)</a></td>
<td class="summary">Custom logging function.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#override.logDebug">override.logDebug (msg)</a></td>
<td class="summary">Custom debug logging function.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "override.log"></a>
<strong>override.log (level, msg)</strong>
</dt>
<dd>
Custom logging function.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">level</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
Level at which to output message.
</li>
<li><span class="parameter">msg</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
Message to log.
</li>
</ul>
</dd>
<dt>
<a name = "override.logDebug"></a>
<strong>override.logDebug (msg)</strong>
</dt>
<dd>
Custom debug logging function.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">msg</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
Message to log.
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2017-08-02 23:27:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@ -0,0 +1,27 @@
--[[ LICENSE HEADER
MIT Licensing
Copyright © 2017 Jordan Irwin
See: LICENSE.txt
--]]
--- @script init.lua
override = {}
override.modname = core.get_current_modname()
override.modpath = core.get_modpath(override.modname)
override.debug = core.settings:get_bool('enable_debug_mods') or false
local scripts = {
'logging',
'api',
}
for i, s in ipairs(scripts) do
dofile(override.modpath .. '/' .. s .. '.lua')
end

View File

@ -0,0 +1,44 @@
--[[ LICENSE HEADER
MIT Licensing
Copyright © 2017 Jordan Irwin
See: LICENSE.txt
--]]
--- Logging functions.
--
-- @script logging.lua
--- Custom logging function.
--
-- @function override.log
-- @tparam string level Level at which to output message.
-- @tparam string msg Message to log.
function override.log(level, msg)
local prefix = '[' .. override.modname .. '] '
if level == 'debug' then
if override.debug then
core.log(prefix .. 'DEBUG: ' .. msg)
end
else
if msg == nil then
core.log(prefix .. level)
else
core.log(level, prefix .. msg)
end
end
end
--- Custom debug logging function.
--
-- @function override.logDebug
-- @tparam string msg Message to log.
function override.logDebug(msg)
override.log('debug', msg)
end

View File

@ -0,0 +1,3 @@
name = override
version = 0.1
author = Jordan Irwin (AntumDeluge)