From d992f38268fd64725f9fc49f176b054c672d5ee5 Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Sat, 8 May 2021 21:18:58 -0700 Subject: [PATCH] Generate HTML documentation with LDoc --- docs/api.html | 488 ++++++++++++++++++++++++++++++++++++++++++++++++++ docs/ldoc.css | 303 +++++++++++++++++++++++++++++++ 2 files changed, 791 insertions(+) create mode 100644 docs/api.html create mode 100644 docs/ldoc.css diff --git a/docs/api.html b/docs/api.html new file mode 100644 index 0000000..80c4b0e --- /dev/null +++ b/docs/api.html @@ -0,0 +1,488 @@ + + + + + Sneeker mod for Minetest + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module settings.lua

+

Settings for sneeker mod.

+

+ +

+ + +

Settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
sneeker.lifespanHow long (in seconds) sneeker remains in world after spawn.
sneeker.boom_gainLoudness of explosion.
sneeker.spawn_require_player_nearbyDetermines whether or not a player must be close for spawn to occur.
sneeker.spawn_player_radiusDistance in nodes a player must be for spawn to occur.
sneeker.despawn_player_farIf enabled, mobs not near any players will despawn.
sneeker.despawn_player_radiusDistance determining if a player is near enough to prevent despawn.
sneeker.spawn_chanceSets possibility for spawn.
sneeker.spawn_intervalSets frequency of spawn chance.
sneeker.spawn_minlightSets the minimum light that a node must have for spawn to occur.
sneeker.spawn_maxlightSets the maximum light that a node can have for spawn to occur.
sneeker.spawn_minheightSets the lowest position at which sneeker can spawn.
sneeker.spawn_maxheightSets the highest position at which sneeker can spawn.
sneeker.spawn_mapblock_limitLimits the number of entities that can spawn per mapblock (16x16x16).
+ +
+
+ + +

Settings

+ +
+
+ + sneeker.lifespan +
+
+ How long (in seconds) sneeker remains in world after spawn. + + + + + +

Type:

+
    + int +
+

Default:

+
    + 900 (15 minutes) +
+ + + + + + + +
+
+ + sneeker.boom_gain +
+
+ Loudness of explosion. + + + + + +

Type:

+
    + float +
+

Default:

+
    + 1.5 +
+ + + + + + + +
+
+ + sneeker.spawn_require_player_nearby +
+
+ Determines whether or not a player must be close for spawn to occur. + + + + + +

Type:

+
    + bool +
+

Default:

+
    + true +
+ + + + + + + +
+
+ + sneeker.spawn_player_radius +
+
+ Distance in nodes a player must be for spawn to occur.

+ +

Only used if sneeker.spawn_require_player_nearby enabled. + + + + + +

Type:

+
    + int +
+

Default:

+
    + 100 +
+ + + + + + + +
+
+ + sneeker.despawn_player_far +
+
+ If enabled, mobs not near any players will despawn. + + + + + +

Type:

+
    + bool +
+

Default:

+
    + true +
+ + + + + + + +
+
+ + sneeker.despawn_player_radius +
+
+ Distance determining if a player is near enough to prevent despawn.

+ +

Only used if sneeker.despawn_player_far enabled. + + + + + +

Type:

+
    + int +
+

Default:

+
    + 500 +
+ + + + + + + +
+
+ + sneeker.spawn_chance +
+
+ Sets possibility for spawn.

+ +

Inverted value (e.g. 10000 = 1/10000). + + + + + +

Type:

+
    + int +
+

Default:

+
    + 10000 +
+ + + + + + + +
+
+ + sneeker.spawn_interval +
+
+ Sets frequency of spawn chance. + + + + + +

Type:

+
    + int +
+

Default:

+
    + 240 (4 minutes) +
+ + + + + + + +
+
+ + sneeker.spawn_minlight +
+
+ Sets the minimum light that a node must have for spawn to occur.

+ +

Value can be set between 0 (no light) & 15 (max light). + + + + + +

Type:

+
    + int +
+

Default:

+
    + 0 +
+ + + + + + + +
+
+ + sneeker.spawn_maxlight +
+
+ Sets the maximum light that a node can have for spawn to occur.

+ +

Value can be set between 0 (no light) & 15 (max light). + + + + + +

Type:

+
    + int +
+

Default:

+
    + 4 +
+ + + + + + + +
+
+ + sneeker.spawn_minheight +
+
+ Sets the lowest position at which sneeker can spawn. + + + + + +

Type:

+
    + int +
+

Default:

+
    + -31000 +
+ + + + + + + +
+
+ + sneeker.spawn_maxheight +
+
+ Sets the highest position at which sneeker can spawn. + + + + + +

Type:

+
    + int +
+

Default:

+
    + 31000 +
+ + + + + + + +
+
+ + sneeker.spawn_mapblock_limit +
+
+ Limits the number of entities that can spawn per mapblock (16x16x16). + + + + + +

Type:

+
    + int +
+

Default:

+
    + 1 +
+ + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6-antum-2 +Last updated 2021-05-08 21:15:42 +
+
+ + diff --git a/docs/ldoc.css b/docs/ldoc.css new file mode 100644 index 0000000..415843e --- /dev/null +++ b/docs/ldoc.css @@ -0,0 +1,303 @@ +/* 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 { + 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: 20px 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 { + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + +pre.example { + font-size: .85em; +} + +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 .user-keyword { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } +