steffo/lihzahrd
steffo/lihzahrd
1
Fork 0
mirror of https://github.com/Steffo99/lihzahrd.git synced 2024-11-21 07:34:23 +00:00
Code Activity

Update docs

Browse source
This commit is contained in:
Steffo 2019-08-09 02:35:30 +02:00
parent 41f1a70105
commit 67e3627a68
107 changed files with 20051 additions and 1097 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
docs/.nojekyll Normal file
View file

BIN
docs/doctrees/environment.pickle Normal file
View file

Binary file not shown.

BIN
docs/doctrees/header.doctree Normal file
View file

Binary file not shown.

BIN
docs/doctrees/index.doctree Normal file
View file

Binary file not shown.

BIN
docs/doctrees/world.doctree Normal file
View file

Binary file not shown.

4
docs/html/.buildinfo Normal file
View file

@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e14f604a529d860828ac84af1e937285
tags: 645f666f9bcd5a90fca523b33c5a78b7

11
docs/html/_sources/header.rst.txt Normal file
View file

@ -0,0 +1,11 @@
lihzahrd.header
====================================
.. toctree::
:maxdepth: 2
.. automodule:: lihzahrd.header
:members:
:private-members:
:undoc-members:

15
docs/html/_sources/index.rst.txt Normal file
View file

@ -0,0 +1,15 @@
lihzahrd
====================================
.. toctree::
:maxdepth: 2
world
header
Some useful links
------------------------------------
* `Lihzahrd on GitHub <https://github.com/Steffo99/lihzahrd>`_
* :ref:`genindex`

11
docs/html/_sources/world.rst.txt Normal file
View file

@ -0,0 +1,11 @@
lihzahrd.World
====================================
.. toctree::
:maxdepth: 2
.. autoclass:: lihzahrd.World
:members:
:private-members:
:undoc-members:

763
docs/html/_static/basic.css Normal file
View file

@ -0,0 +1,763 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}
a.brackets:after,
span.brackets > a:after {
content: "]";
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
th > p:first-child,
td > p:first-child {
margin-top: 0px;
}
th > p:last-child,
td > p:last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption {
padding: 0.3em;
}
div.figure p.caption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist td {
vertical-align: top;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
li > p:first-child {
margin-top: 0px;
}
li > p:last-child {
margin-bottom: 0px;
}
dl.footnote > dt,
dl.citation > dt {
float: left;
}
dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
dl.field-list {
display: flex;
flex-wrap: wrap;
}
dl.field-list > dt {
flex-basis: 20%;
font-weight: bold;
word-break: break-word;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
flex-basis: 70%;
padding-left: 1em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > p:first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0.5em;
content: ":";
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
div.code-block-caption {
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
div.code-block-caption + div > div.highlight > pre {
margin-top: 0;
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
padding: 1em 1em 0;
}
div.literal-block-wrapper div.highlight {
margin: 0;
}
code.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
code.descclassname {
background-color: transparent;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: relative;
left: 0px;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

1
docs/html/_static/css/badge_only.css Normal file
View file

@ -0,0 +1 @@
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}

6
docs/html/_static/css/theme.css Normal file
View file

File diff suppressed because one or more lines are too long

314
docs/html/_static/doctools.js Normal file
View file

@ -0,0 +1,314 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
};
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};
/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];
return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined')
return string;
return (typeof translated === 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated === 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
if (!body.length) {
body = $('body');
}
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.appendTo($('#searchbox'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) === 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this === '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
},
initOnKeyListeners: function() {
$(document).keyup(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
}
}
});
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

10
docs/html/_static/documentation_options.js Normal file
View file

@ -0,0 +1,10 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false
};

BIN
docs/html/_static/file.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 286 B

BIN
docs/html/_static/fonts/Inconsolata-Bold.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Inconsolata-Regular.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Inconsolata.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato-Bold.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato-Regular.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bold.eot Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bold.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bold.woff Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bold.woff2 Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bolditalic.eot Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bolditalic.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bolditalic.woff Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-bolditalic.woff2 Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-italic.eot Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-italic.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-italic.woff Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-italic.woff2 Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-regular.eot Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-regular.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-regular.woff Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/Lato/lato-regular.woff2 Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab-Bold.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab-Regular.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/fontawesome-webfont.eot Normal file
View file

Binary file not shown.

2671
docs/html/_static/fonts/fontawesome-webfont.svg Normal file
View file

File diff suppressed because it is too large Load diff
Side by side

After

Width:  |  Height:  |  Size: 434 KiB

BIN
docs/html/_static/fonts/fontawesome-webfont.ttf Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/fontawesome-webfont.woff Normal file
View file

Binary file not shown.

BIN
docs/html/_static/fonts/fontawesome-webfont.woff2 Normal file
View file

Binary file not shown.

10253
docs/html/_static/jquery-3.2.1.js vendored Normal file
View file

File diff suppressed because it is too large Load diff

4
docs/html/_static/jquery.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

4
docs/html/_static/js/modernizr.min.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

3
docs/html/_static/js/theme.js Normal file
View file

@ -0,0 +1,3 @@
/* sphinx_rtd_theme version 0.4.3 | MIT license */
/* Built 20190212 16:02 */
require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(e){var i=this;void 0===e&&(e=!0),i.isRunning||(i.isRunning=!0,jQuery(function(n){i.init(n),i.reset(),i.win.on("hashchange",i.reset),e&&i.win.on("scroll",function(){i.linkScroll||i.winScroll||(i.winScroll=!0,requestAnimationFrame(function(){i.onScroll()}))}),i.win.on("resize",function(){i.winResize||(i.winResize=!0,requestAnimationFrame(function(){i.onResize()}))}),i.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(i){i(document);var t=this;this.navBar=i("div.wy-side-scroll:first"),this.win=i(window),i(document).on("click","[data-toggle='wy-nav-top']",function(){i("[data-toggle='wy-nav-shift']").toggleClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var n=i(this);i("[data-toggle='wy-nav-shift']").removeClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift"),t.toggleCurrent(n),t.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){i("[data-toggle='rst-versions']").toggleClass("shift-up")}),i("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),i("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),i("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i('<span class="toctree-expand"></span>'),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0<i.length&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"),i[0].scrollIntoView())}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e<n.length&&!window.requestAnimationFrame;++e)window.requestAnimationFrame=window[n[e]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[n[e]+"CancelAnimationFrame"]||window[n[e]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(n,e){var i=(new Date).getTime(),t=Math.max(0,16-(i-r)),o=window.setTimeout(function(){n(i+t)},t);return r=i+t,o}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);

297
docs/html/_static/language_data.js Normal file
View file

@ -0,0 +1,297 @@
/*
* language_data.js
* ~~~~~~~~~~~~~~~~
*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end;
for (i = 0; i < singles.length; i++) {
result[singles[i]] = true;
}
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) {
start = ranges[i][0];
end = ranges[i][1];
for (j = start; j <= end; j++) {
result[j] = true;
}
}
return result;
})();
function splitQuery(query) {
var result = [];
var start = -1;
for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) {
result.push(query.slice(start, i));
start = -1;
}
} else if (start === -1) {
start = i;
}
}
if (start !== -1) {
result.push(query.slice(start));
}
return result;
}

BIN
docs/html/_static/minus.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 90 B

BIN
docs/html/_static/plus.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 90 B

69
docs/html/_static/pygments.css Normal file
View file

@ -0,0 +1,69 @@
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #408080; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .m { color: #666666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #7D9029 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .no { color: #880000 } /* Name.Constant */
.highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nl { color: #A0A000 } /* Name.Label */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
.highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */

506
docs/html/_static/searchtools.js Normal file
View file

@ -0,0 +1,506 @@
/*
* searchtools.js
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
if (!Scorer) {
/**
* Simple result scoring code.
*/
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [filename, title, anchor, descr, score]
// and returns the new score.
/*
score: function(result) {
return result[4];
},
*/
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5}, // used to be unimportantResults
// Used when the priority is not in the mapping.
objPrioDefault: 0,
// query found in title
title: 15,
partialTitle: 7,
// query found in terms
term: 5,
partialTerm: 2
};
}
if (!splitQuery) {
function splitQuery(query) {
return query.split(/\s+/);
}
}
/**
* Search Module
*/
var Search = {
_index : null,
_queued_query : null,
_pulse_status : -1,
htmlToText : function(htmlString) {
var htmlElement = document.createElement('span');
htmlElement.innerHTML = htmlString;
$(htmlElement).find('.headerlink').remove();
docContent = $(htmlElement).find('[role=main]')[0];
return docContent.textContent || docContent.innerText;
},
init : function() {
var params = $.getQueryParameters();
if (params.q) {
var query = params.q[0];
$('input[name="q"]')[0].value = query;
this.performSearch(query);
}
},
loadIndex : function(url) {
$.ajax({type: "GET", url: url, data: null,
dataType: "script", cache: true,
complete: function(jqxhr, textstatus) {
if (textstatus != "success") {
document.getElementById("searchindexloader").src = url;
}
}});
},
setIndex : function(index) {
var q;
this._index = index;
if ((q = this._queued_query) !== null) {
this._queued_query = null;
Search.query(q);
}
},
hasIndex : function() {
return this._index !== null;
},
deferQuery : function(query) {
this._queued_query = query;
},
stopPulse : function() {
this._pulse_status = 0;
},
startPulse : function() {
if (this._pulse_status >= 0)
return;
function pulse() {
var i;
Search._pulse_status = (Search._pulse_status + 1) % 4;
var dotString = '';
for (i = 0; i < Search._pulse_status; i++)
dotString += '.';
Search.dots.text(dotString);
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
}
pulse();
},
/**
* perform a search for something (or wait until index is loaded)
*/
performSearch : function(query) {
// create the required interface elements
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.deferQuery(query);
},
/**
* execute search (requires search index to be loaded)
*/
query : function(query) {
var i;
// stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = splitQuery(query);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
objectterms.push(tmp[i].toLowerCase());
}
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
tmp[i] === "") {
// skip this "word"
continue;
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
// prevent stemmer from cutting word smaller than two chars
if(word.length < 3 && tmp[i].length >= 3) {
word = tmp[i];
}
var toAppend;
// select the correct list
if (word[0] == '-') {
toAppend = excluded;
word = word.substr(1);
}
else {
toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$u.contains(toAppend, word))
toAppend.push(word);
}
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
// console.debug('SEARCH: searching for:');
// console.info('required: ', searchterms);
// console.info('excluded: ', excluded);
// prepare search
var terms = this._index.terms;
var titleterms = this._index.titleterms;
// array of [filename, title, anchor, descr, score]
var results = [];
$('#search-progress').empty();
// lookup as object
for (i = 0; i < objectterms.length; i++) {
var others = [].concat(objectterms.slice(0, i),
objectterms.slice(i+1, objectterms.length));
results = results.concat(this.performObjectSearch(objectterms[i], others));
}
// lookup as search terms in fulltext
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
for (i = 0; i < results.length; i++)
results[i][4] = Scorer.score(results[i]);
}
// now sort the results by score (in opposite order of appearance, since the
// display function below uses pop() to retrieve items) and then
// alphabetically
results.sort(function(a, b) {
var left = a[4];
var right = b[4];
if (left > right) {
return 1;
} else if (left < right) {
return -1;
} else {
// same score: sort alphabetically
left = a[1].toLowerCase();
right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
}
});
// for debugging
//Search.lastresults = results.slice(); // a copy
//console.info('search results:', Search.lastresults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
} else {
// normal html builders
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
}
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '' && data !== undefined) {
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
}
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}});
} else {
// no source available, just display title
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
},
/**
* search for object names
*/
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
var docnames = this._index.docnames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
var i;
var results = [];
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) {
var score = 0;
var parts = fullnameLower.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullnameLower == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch;
}
var match = objects[prefix][name];
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
if (otherterms.length > 0) {
var haystack = (prefix + ' ' + name + ' ' +
objname + ' ' + title).toLowerCase();
var allfound = true;
for (i = 0; i < otherterms.length; i++) {
if (haystack.indexOf(otherterms[i]) == -1) {
allfound = false;
break;
}
}
if (!allfound) {
continue;
}
}
var descr = objname + _(', in ') + title;
var anchor = match[3];
if (anchor === '')
anchor = fullname;
else if (anchor == '-')
anchor = objnames[match[1]][1] + '-' + fullname;
// add custom score for some objects according to scorer
if (Scorer.objPrio.hasOwnProperty(match[2])) {
score += Scorer.objPrio[match[2]];
} else {
score += Scorer.objPrioDefault;
}
results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
}
}
}
return results;
},
/**
* search for full-text terms in the index
*/
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
var docnames = this._index.docnames;
var filenames = this._index.filenames;
var titles = this._index.titles;
var i, j, file;
var fileMap = {};
var scoreMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
var files = [];
var _o = [
{files: terms[word], score: Scorer.term},
{files: titleterms[word], score: Scorer.title}
];
// add support for partial matches
if (word.length > 2) {
for (var w in terms) {
if (w.match(word) && !terms[word]) {
_o.push({files: terms[w], score: Scorer.partialTerm})
}
}
for (var w in titleterms) {
if (w.match(word) && !titleterms[word]) {
_o.push({files: titleterms[w], score: Scorer.partialTitle})
}
}
}
// no match but word was a required one
if ($u.every(_o, function(o){return o.files === undefined;})) {
break;
}
// found search word in contents
$u.each(_o, function(o) {
var _files = o.files;
if (_files === undefined)
return
if (_files.length === undefined)
_files = [_files];
files = files.concat(_files);
// set score for the word in each file to Scorer.term
for (j = 0; j < _files.length; j++) {
file = _files[j];
if (!(file in scoreMap))
scoreMap[file] = {}
scoreMap[file][word] = o.score;
}
});
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
if (file in fileMap)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (file in fileMap) {
var valid = true;
// check if all requirements are matched
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
searchterms.filter(function(term){return term.length > 2}).length
if (
fileMap[file].length != searchterms.length &&
fileMap[file].length != filteredTermCount
) continue;
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
titleterms[excluded[i]] == file ||
$u.contains(terms[excluded[i]] || [], file) ||
$u.contains(titleterms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it to the result list
if (valid) {
// select one (max) score for the file.
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
}
}
return results;
},
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
return rv;
}
};
$(document).ready(function() {
Search.init();
});

999
docs/html/_static/underscore-1.3.1.js Normal file
View file

@ -0,0 +1,999 @@
// Underscore.js 1.3.1
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
// Underscore is freely distributable under the MIT license.
// Portions of Underscore are inspired or borrowed from Prototype,
// Oliver Steele's Functional, and John Resig's Micro-Templating.
// For all details and documentation:
// http://documentcloud.github.com/underscore
(function() {
// Baseline setup
// --------------
// Establish the root object, `window` in the browser, or `global` on the server.
var root = this;
// Save the previous value of the `_` variable.
var previousUnderscore = root._;
// Establish the object that gets returned to break out of a loop iteration.
var breaker = {};
// Save bytes in the minified (but not gzipped) version:
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
// Create quick reference variables for speed access to core prototypes.
var slice = ArrayProto.slice,
unshift = ArrayProto.unshift,
toString = ObjProto.toString,
hasOwnProperty = ObjProto.hasOwnProperty;
// All **ECMAScript 5** native function implementations that we hope to use
// are declared here.
var
nativeForEach = ArrayProto.forEach,
nativeMap = ArrayProto.map,
nativeReduce = ArrayProto.reduce,
nativeReduceRight = ArrayProto.reduceRight,
nativeFilter = ArrayProto.filter,
nativeEvery = ArrayProto.every,
nativeSome = ArrayProto.some,
nativeIndexOf = ArrayProto.indexOf,
nativeLastIndexOf = ArrayProto.lastIndexOf,
nativeIsArray = Array.isArray,
nativeKeys = Object.keys,
nativeBind = FuncProto.bind;
// Create a safe reference to the Underscore object for use below.
var _ = function(obj) { return new wrapper(obj); };
// Export the Underscore object for **Node.js**, with
// backwards-compatibility for the old `require()` API. If we're in
// the browser, add `_` as a global object via a string identifier,
// for Closure Compiler "advanced" mode.
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
exports = module.exports = _;
}
exports._ = _;
} else {
root['_'] = _;
}
// Current version.
_.VERSION = '1.3.1';
// Collection Functions
// --------------------
// The cornerstone, an `each` implementation, aka `forEach`.
// Handles objects with the built-in `forEach`, arrays, and raw objects.
// Delegates to **ECMAScript 5**'s native `forEach` if available.
var each = _.each = _.forEach = function(obj, iterator, context) {
if (obj == null) return;
if (nativeForEach && obj.forEach === nativeForEach) {
obj.forEach(iterator, context);
} else if (obj.length === +obj.length) {
for (var i = 0, l = obj.length; i < l; i++) {
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
}
} else {
for (var key in obj) {
if (_.has(obj, key)) {
if (iterator.call(context, obj[key], key, obj) === breaker) return;
}
}
}
};
// Return the results of applying the iterator to each element.
// Delegates to **ECMAScript 5**'s native `map` if available.
_.map = _.collect = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
each(obj, function(value, index, list) {
results[results.length] = iterator.call(context, value, index, list);
});
if (obj.length === +obj.length) results.length = obj.length;
return results;
};
// **Reduce** builds up a single result from a list of values, aka `inject`,
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
var initial = arguments.length > 2;
if (obj == null) obj = [];
if (nativeReduce && obj.reduce === nativeReduce) {
if (context) iterator = _.bind(iterator, context);
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
}
each(obj, function(value, index, list) {
if (!initial) {
memo = value;
initial = true;
} else {
memo = iterator.call(context, memo, value, index, list);
}
});
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
return memo;
};
// The right-associative version of reduce, also known as `foldr`.
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
var initial = arguments.length > 2;
if (obj == null) obj = [];
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
if (context) iterator = _.bind(iterator, context);
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
}
var reversed = _.toArray(obj).reverse();
if (context && !initial) iterator = _.bind(iterator, context);
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
};
// Return the first value which passes a truth test. Aliased as `detect`.
_.find = _.detect = function(obj, iterator, context) {
var result;
any(obj, function(value, index, list) {
if (iterator.call(context, value, index, list)) {
result = value;
return true;
}
});
return result;
};
// Return all the elements that pass a truth test.
// Delegates to **ECMAScript 5**'s native `filter` if available.
// Aliased as `select`.
_.filter = _.select = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
each(obj, function(value, index, list) {
if (iterator.call(context, value, index, list)) results[results.length] = value;
});
return results;
};
// Return all the elements for which a truth test fails.
_.reject = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
each(obj, function(value, index, list) {
if (!iterator.call(context, value, index, list)) results[results.length] = value;
});
return results;
};
// Determine whether all of the elements match a truth test.
// Delegates to **ECMAScript 5**'s native `every` if available.
// Aliased as `all`.
_.every = _.all = function(obj, iterator, context) {
var result = true;
if (obj == null) return result;
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
each(obj, function(value, index, list) {
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
});
return result;
};
// Determine if at least one element in the object matches a truth test.
// Delegates to **ECMAScript 5**'s native `some` if available.
// Aliased as `any`.
var any = _.some = _.any = function(obj, iterator, context) {
iterator || (iterator = _.identity);
var result = false;
if (obj == null) return result;
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
each(obj, function(value, index, list) {
if (result || (result = iterator.call(context, value, index, list))) return breaker;
});
return !!result;
};
// Determine if a given value is included in the array or object using `===`.
// Aliased as `contains`.
_.include = _.contains = function(obj, target) {
var found = false;
if (obj == null) return found;
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
found = any(obj, function(value) {
return value === target;
});
return found;
};
// Invoke a method (with arguments) on every item in a collection.
_.invoke = function(obj, method) {
var args = slice.call(arguments, 2);
return _.map(obj, function(value) {
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
});
};
// Convenience version of a common use case of `map`: fetching a property.
_.pluck = function(obj, key) {
return _.map(obj, function(value){ return value[key]; });
};
// Return the maximum element or (element-based computation).
_.max = function(obj, iterator, context) {
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
if (!iterator && _.isEmpty(obj)) return -Infinity;
var result = {computed : -Infinity};
each(obj, function(value, index, list) {
var computed = iterator ? iterator.call(context, value, index, list) : value;
computed >= result.computed && (result = {value : value, computed : computed});
});
return result.value;
};
// Return the minimum element (or element-based computation).
_.min = function(obj, iterator, context) {
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
if (!iterator && _.isEmpty(obj)) return Infinity;
var result = {computed : Infinity};
each(obj, function(value, index, list) {
var computed = iterator ? iterator.call(context, value, index, list) : value;
computed < result.computed && (result = {value : value, computed : computed});
});
return result.value;
};
// Shuffle an array.
_.shuffle = function(obj) {
var shuffled = [], rand;
each(obj, function(value, index, list) {
if (index == 0) {
shuffled[0] = value;
} else {
rand = Math.floor(Math.random() * (index + 1));
shuffled[index] = shuffled[rand];
shuffled[rand] = value;
}
});
return shuffled;
};
// Sort the object's values by a criterion produced by an iterator.
_.sortBy = function(obj, iterator, context) {
return _.pluck(_.map(obj, function(value, index, list) {
return {
value : value,
criteria : iterator.call(context, value, index, list)
};
}).sort(function(left, right) {
var a = left.criteria, b = right.criteria;
return a < b ? -1 : a > b ? 1 : 0;
}), 'value');
};
// Groups the object's values by a criterion. Pass either a string attribute
// to group by, or a function that returns the criterion.
_.groupBy = function(obj, val) {
var result = {};
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
each(obj, function(value, index) {
var key = iterator(value, index);
(result[key] || (result[key] = [])).push(value);
});
return result;
};
// Use a comparator function to figure out at what index an object should
// be inserted so as to maintain order. Uses binary search.
_.sortedIndex = function(array, obj, iterator) {
iterator || (iterator = _.identity);
var low = 0, high = array.length;
while (low < high) {
var mid = (low + high) >> 1;
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
}
return low;
};
// Safely convert anything iterable into a real, live array.
_.toArray = function(iterable) {
if (!iterable) return [];
if (iterable.toArray) return iterable.toArray();
if (_.isArray(iterable)) return slice.call(iterable);
if (_.isArguments(iterable)) return slice.call(iterable);
return _.values(iterable);
};
// Return the number of elements in an object.
_.size = function(obj) {
return _.toArray(obj).length;
};
// Array Functions
// ---------------
// Get the first element of an array. Passing **n** will return the first N
// values in the array. Aliased as `head`. The **guard** check allows it to work
// with `_.map`.
_.first = _.head = function(array, n, guard) {
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
};
// Returns everything but the last entry of the array. Especcialy useful on
// the arguments object. Passing **n** will return all the values in
// the array, excluding the last N. The **guard** check allows it to work with
// `_.map`.
_.initial = function(array, n, guard) {
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
};
// Get the last element of an array. Passing **n** will return the last N
// values in the array. The **guard** check allows it to work with `_.map`.
_.last = function(array, n, guard) {
if ((n != null) && !guard) {
return slice.call(array, Math.max(array.length - n, 0));
} else {
return array[array.length - 1];
}
};
// Returns everything but the first entry of the array. Aliased as `tail`.
// Especially useful on the arguments object. Passing an **index** will return
// the rest of the values in the array from that index onward. The **guard**
// check allows it to work with `_.map`.
_.rest = _.tail = function(array, index, guard) {
return slice.call(array, (index == null) || guard ? 1 : index);
};
// Trim out all falsy values from an array.
_.compact = function(array) {
return _.filter(array, function(value){ return !!value; });
};
// Return a completely flattened version of an array.
_.flatten = function(array, shallow) {
return _.reduce(array, function(memo, value) {
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
memo[memo.length] = value;
return memo;
}, []);
};
// Return a version of the array that does not contain the specified value(s).
_.without = function(array) {
return _.difference(array, slice.call(arguments, 1));
};
// Produce a duplicate-free version of the array. If the array has already
// been sorted, you have the option of using a faster algorithm.
// Aliased as `unique`.
_.uniq = _.unique = function(array, isSorted, iterator) {
var initial = iterator ? _.map(array, iterator) : array;
var result = [];
_.reduce(initial, function(memo, el, i) {
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
memo[memo.length] = el;
result[result.length] = array[i];
}
return memo;
}, []);
return result;
};
// Produce an array that contains the union: each distinct element from all of
// the passed-in arrays.
_.union = function() {
return _.uniq(_.flatten(arguments, true));
};
// Produce an array that contains every item shared between all the
// passed-in arrays. (Aliased as "intersect" for back-compat.)
_.intersection = _.intersect = function(array) {
var rest = slice.call(arguments, 1);
return _.filter(_.uniq(array), function(item) {
return _.every(rest, function(other) {
return _.indexOf(other, item) >= 0;
});
});
};
// Take the difference between one array and a number of other arrays.
// Only the elements present in just the first array will remain.
_.difference = function(array) {
var rest = _.flatten(slice.call(arguments, 1));
return _.filter(array, function(value){ return !_.include(rest, value); });
};
// Zip together multiple lists into a single array -- elements that share
// an index go together.
_.zip = function() {
var args = slice.call(arguments);
var length = _.max(_.pluck(args, 'length'));
var results = new Array(length);
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
return results;
};
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
// we need this function. Return the position of the first occurrence of an
// item in an array, or -1 if the item is not included in the array.
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
// If the array is large and already in sort order, pass `true`
// for **isSorted** to use binary search.
_.indexOf = function(array, item, isSorted) {
if (array == null) return -1;
var i, l;
if (isSorted) {
i = _.sortedIndex(array, item);
return array[i] === item ? i : -1;
}
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
return -1;
};
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
_.lastIndexOf = function(array, item) {
if (array == null) return -1;
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
var i = array.length;
while (i--) if (i in array && array[i] === item) return i;
return -1;
};
// Generate an integer Array containing an arithmetic progression. A port of
// the native Python `range()` function. See
// [the Python documentation](http://docs.python.org/library/functions.html#range).
_.range = function(start, stop, step) {
if (arguments.length <= 1) {
stop = start || 0;
start = 0;
}
step = arguments[2] || 1;
var len = Math.max(Math.ceil((stop - start) / step), 0);
var idx = 0;
var range = new Array(len);
while(idx < len) {
range[idx++] = start;
start += step;
}
return range;
};
// Function (ahem) Functions
// ------------------
// Reusable constructor function for prototype setting.
var ctor = function(){};
// Create a function bound to a given object (assigning `this`, and arguments,
// optionally). Binding with arguments is also known as `curry`.
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
// We check for `func.bind` first, to fail fast when `func` is undefined.
_.bind = function bind(func, context) {
var bound, args;
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
if (!_.isFunction(func)) throw new TypeError;
args = slice.call(arguments, 2);
return bound = function() {
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
ctor.prototype = func.prototype;
var self = new ctor;
var result = func.apply(self, args.concat(slice.call(arguments)));
if (Object(result) === result) return result;
return self;
};
};
// Bind all of an object's methods to that object. Useful for ensuring that
// all callbacks defined on an object belong to it.
_.bindAll = function(obj) {
var funcs = slice.call(arguments, 1);
if (funcs.length == 0) funcs = _.functions(obj);
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
return obj;
};
// Memoize an expensive function by storing its results.
_.memoize = function(func, hasher) {
var memo = {};
hasher || (hasher = _.identity);
return function() {
var key = hasher.apply(this, arguments);
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
};
};
// Delays a function for the given number of milliseconds, and then calls
// it with the arguments supplied.
_.delay = function(func, wait) {
var args = slice.call(arguments, 2);
return setTimeout(function(){ return func.apply(func, args); }, wait);
};
// Defers a function, scheduling it to run after the current call stack has
// cleared.
_.defer = function(func) {
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
};
// Returns a function, that, when invoked, will only be triggered at most once
// during a given window of time.
_.throttle = function(func, wait) {
var context, args, timeout, throttling, more;
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
return function() {
context = this; args = arguments;
var later = function() {
timeout = null;
if (more) func.apply(context, args);
whenDone();
};
if (!timeout) timeout = setTimeout(later, wait);
if (throttling) {
more = true;
} else {
func.apply(context, args);
}
whenDone();
throttling = true;
};
};
// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds.
_.debounce = function(func, wait) {
var timeout;
return function() {
var context = this, args = arguments;
var later = function() {
timeout = null;
func.apply(context, args);
};
clearTimeout(timeout);
timeout = setTimeout(later, wait);
};
};
// Returns a function that will be executed at most one time, no matter how
// often you call it. Useful for lazy initialization.
_.once = function(func) {
var ran = false, memo;
return function() {
if (ran) return memo;
ran = true;
return memo = func.apply(this, arguments);
};
};
// Returns the first function passed as an argument to the second,
// allowing you to adjust arguments, run code before and after, and
// conditionally execute the original function.
_.wrap = function(func, wrapper) {
return function() {
var args = [func].concat(slice.call(arguments, 0));
return wrapper.apply(this, args);
};
};
// Returns a function that is the composition of a list of functions, each
// consuming the return value of the function that follows.
_.compose = function() {
var funcs = arguments;
return function() {
var args = arguments;
for (var i = funcs.length - 1; i >= 0; i--) {
args = [funcs[i].apply(this, args)];
}
return args[0];
};
};
// Returns a function that will only be executed after being called N times.
_.after = function(times, func) {
if (times <= 0) return func();
return function() {
if (--times < 1) { return func.apply(this, arguments); }
};
};
// Object Functions
// ----------------
// Retrieve the names of an object's properties.
// Delegates to **ECMAScript 5**'s native `Object.keys`
_.keys = nativeKeys || function(obj) {
if (obj !== Object(obj)) throw new TypeError('Invalid object');
var keys = [];
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
return keys;
};
// Retrieve the values of an object's properties.
_.values = function(obj) {
return _.map(obj, _.identity);
};
// Return a sorted list of the function names available on the object.
// Aliased as `methods`
_.functions = _.methods = function(obj) {
var names = [];
for (var key in obj) {
if (_.isFunction(obj[key])) names.push(key);
}
return names.sort();
};
// Extend a given object with all the properties in passed-in object(s).
_.extend = function(obj) {
each(slice.call(arguments, 1), function(source) {
for (var prop in source) {
obj[prop] = source[prop];
}
});
return obj;
};
// Fill in a given object with default properties.
_.defaults = function(obj) {
each(slice.call(arguments, 1), function(source) {
for (var prop in source) {
if (obj[prop] == null) obj[prop] = source[prop];
}
});
return obj;
};
// Create a (shallow-cloned) duplicate of an object.
_.clone = function(obj) {
if (!_.isObject(obj)) return obj;
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
};
// Invokes interceptor with the obj, and then returns obj.
// The primary purpose of this method is to "tap into" a method chain, in
// order to perform operations on intermediate results within the chain.
_.tap = function(obj, interceptor) {
interceptor(obj);
return obj;
};
// Internal recursive comparison function.
function eq(a, b, stack) {
// Identical objects are equal. `0 === -0`, but they aren't identical.
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
if (a === b) return a !== 0 || 1 / a == 1 / b;
// A strict comparison is necessary because `null == undefined`.
if (a == null || b == null) return a === b;
// Unwrap any wrapped objects.
if (a._chain) a = a._wrapped;
if (b._chain) b = b._wrapped;
// Invoke a custom `isEqual` method if one is provided.
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
// Compare `[[Class]]` names.
var className = toString.call(a);
if (className != toString.call(b)) return false;
switch (className) {
// Strings, numbers, dates, and booleans are compared by value.
case '[object String]':
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
// equivalent to `new String("5")`.
return a == String(b);
case '[object Number]':
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
// other numeric values.
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
case '[object Date]':
case '[object Boolean]':
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
// millisecond representations. Note that invalid dates with millisecond representations
// of `NaN` are not equivalent.
return +a == +b;
// RegExps are compared by their source patterns and flags.
case '[object RegExp]':
return a.source == b.source &&
a.global == b.global &&
a.multiline == b.multiline &&
a.ignoreCase == b.ignoreCase;
}
if (typeof a != 'object' || typeof b != 'object') return false;
// Assume equality for cyclic structures. The algorithm for detecting cyclic
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
var length = stack.length;
while (length--) {
// Linear search. Performance is inversely proportional to the number of
// unique nested structures.
if (stack[length] == a) return true;
}
// Add the first object to the stack of traversed objects.
stack.push(a);
var size = 0, result = true;
// Recursively compare objects and arrays.
if (className == '[object Array]') {
// Compare array lengths to determine if a deep comparison is necessary.
size = a.length;
result = size == b.length;
if (result) {
// Deep compare the contents, ignoring non-numeric properties.
while (size--) {
// Ensure commutative equality for sparse arrays.
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
}
}
} else {
// Objects with different constructors are not equivalent.
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
// Deep compare objects.
for (var key in a) {
if (_.has(a, key)) {
// Count the expected number of properties.
size++;
// Deep compare each member.
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
}
}
// Ensure that both objects contain the same number of properties.
if (result) {
for (key in b) {
if (_.has(b, key) && !(size--)) break;
}
result = !size;
}
}
// Remove the first object from the stack of traversed objects.
stack.pop();
return result;
}
// Perform a deep comparison to check if two objects are equal.
_.isEqual = function(a, b) {
return eq(a, b, []);
};
// Is a given array, string, or object empty?
// An "empty" object has no enumerable own-properties.
_.isEmpty = function(obj) {
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
for (var key in obj) if (_.has(obj, key)) return false;
return true;
};
// Is a given value a DOM element?
_.isElement = function(obj) {
return !!(obj && obj.nodeType == 1);
};
// Is a given value an array?
// Delegates to ECMA5's native Array.isArray
_.isArray = nativeIsArray || function(obj) {
return toString.call(obj) == '[object Array]';
};
// Is a given variable an object?
_.isObject = function(obj) {
return obj === Object(obj);
};
// Is a given variable an arguments object?
_.isArguments = function(obj) {
return toString.call(obj) == '[object Arguments]';
};
if (!_.isArguments(arguments)) {
_.isArguments = function(obj) {
return !!(obj && _.has(obj, 'callee'));
};
}
// Is a given value a function?
_.isFunction = function(obj) {
return toString.call(obj) == '[object Function]';
};
// Is a given value a string?
_.isString = function(obj) {
return toString.call(obj) == '[object String]';
};
// Is a given value a number?
_.isNumber = function(obj) {
return toString.call(obj) == '[object Number]';
};
// Is the given value `NaN`?
_.isNaN = function(obj) {
// `NaN` is the only value for which `===` is not reflexive.
return obj !== obj;
};
// Is a given value a boolean?
_.isBoolean = function(obj) {
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
};
// Is a given value a date?
_.isDate = function(obj) {
return toString.call(obj) == '[object Date]';
};
// Is the given value a regular expression?
_.isRegExp = function(obj) {
return toString.call(obj) == '[object RegExp]';
};
// Is a given value equal to null?
_.isNull = function(obj) {
return obj === null;
};
// Is a given variable undefined?
_.isUndefined = function(obj) {
return obj === void 0;
};
// Has own property?
_.has = function(obj, key) {
return hasOwnProperty.call(obj, key);
};
// Utility Functions
// -----------------
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
// previous owner. Returns a reference to the Underscore object.
_.noConflict = function() {
root._ = previousUnderscore;
return this;
};
// Keep the identity function around for default iterators.
_.identity = function(value) {
return value;
};
// Run a function **n** times.
_.times = function (n, iterator, context) {
for (var i = 0; i < n; i++) iterator.call(context, i);
};
// Escape a string for HTML interpolation.
_.escape = function(string) {
return (''+string).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#x27;').replace(/\//g,'&#x2F;');
};
// Add your own custom functions to the Underscore object, ensuring that
// they're correctly added to the OOP wrapper as well.
_.mixin = function(obj) {
each(_.functions(obj), function(name){
addToWrapper(name, _[name] = obj[name]);
});
};
// Generate a unique integer id (unique within the entire client session).
// Useful for temporary DOM ids.
var idCounter = 0;
_.uniqueId = function(prefix) {
var id = idCounter++;
return prefix ? prefix + id : id;
};
// By default, Underscore uses ERB-style template delimiters, change the
// following template settings to use alternative delimiters.
_.templateSettings = {
evaluate : /<%([\s\S]+?)%>/g,
interpolate : /<%=([\s\S]+?)%>/g,
escape : /<%-([\s\S]+?)%>/g
};
// When customizing `templateSettings`, if you don't want to define an
// interpolation, evaluation or escaping regex, we need one that is
// guaranteed not to match.
var noMatch = /.^/;
// Within an interpolation, evaluation, or escaping, remove HTML escaping
// that had been previously added.
var unescape = function(code) {
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
};
// JavaScript micro-templating, similar to John Resig's implementation.
// Underscore templating handles arbitrary delimiters, preserves whitespace,
// and correctly escapes quotes within interpolated code.
_.template = function(str, data) {
var c = _.templateSettings;
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
'with(obj||{}){__p.push(\'' +
str.replace(/\\/g, '\\\\')
.replace(/'/g, "\\'")
.replace(c.escape || noMatch, function(match, code) {
return "',_.escape(" + unescape(code) + "),'";
})
.replace(c.interpolate || noMatch, function(match, code) {
return "'," + unescape(code) + ",'";
})
.replace(c.evaluate || noMatch, function(match, code) {
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
})
.replace(/\r/g, '\\r')
.replace(/\n/g, '\\n')
.replace(/\t/g, '\\t')
+ "');}return __p.join('');";
var func = new Function('obj', '_', tmpl);
if (data) return func(data, _);
return function(data) {
return func.call(this, data, _);
};
};
// Add a "chain" function, which will delegate to the wrapper.
_.chain = function(obj) {
return _(obj).chain();
};
// The OOP Wrapper
// ---------------
// If Underscore is called as a function, it returns a wrapped object that
// can be used OO-style. This wrapper holds altered versions of all the
// underscore functions. Wrapped objects may be chained.
var wrapper = function(obj) { this._wrapped = obj; };
// Expose `wrapper.prototype` as `_.prototype`
_.prototype = wrapper.prototype;
// Helper function to continue chaining intermediate results.
var result = function(obj, chain) {
return chain ? _(obj).chain() : obj;
};
// A method to easily add functions to the OOP wrapper.
var addToWrapper = function(name, func) {
wrapper.prototype[name] = function() {
var args = slice.call(arguments);
unshift.call(args, this._wrapped);
return result(func.apply(_, args), this._chain);
};
};
// Add all of the Underscore functions to the wrapper object.
_.mixin(_);
// Add all mutator Array functions to the wrapper.
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
var method = ArrayProto[name];
wrapper.prototype[name] = function() {
var wrapped = this._wrapped;
method.apply(wrapped, arguments);
var length = wrapped.length;
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
return result(wrapped, this._chain);
};
});
// Add all accessor Array functions to the wrapper.
each(['concat', 'join', 'slice'], function(name) {
var method = ArrayProto[name];
wrapper.prototype[name] = function() {
return result(method.apply(this._wrapped, arguments), this._chain);
};
});
// Start chaining a wrapped Underscore object.
wrapper.prototype.chain = function() {
this._chain = true;
return this;
};
// Extracts the result from a wrapped and chained object.
wrapper.prototype.value = function() {
return this._wrapped;
};
}).call(this);

31
docs/html/_static/underscore.js Normal file
View file

@ -0,0 +1,31 @@
// Underscore.js 1.3.1
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
// Underscore is freely distributable under the MIT license.
// Portions of Underscore are inspired or borrowed from Prototype,
// Oliver Steele's Functional, and John Resig's Micro-Templating.
// For all details and documentation:
// http://documentcloud.github.com/underscore
(function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck=
function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/"/g,"&quot;").replace(/'/g,"&#x27;").replace(/\//g,"&#x2F;")};b.mixin=function(a){j(b.functions(a),
function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+
u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);

777
docs/html/genindex.html Normal file
View file

@ -0,0 +1,777 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; lihzahrd documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> lihzahrd
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">lihzahrd</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#_"><strong>_</strong></a>
| <a href="#A"><strong>A</strong></a>
| <a href="#B"><strong>B</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#F"><strong>F</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#J"><strong>J</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#O"><strong>O</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#U"><strong>U</strong></a>
| <a href="#V"><strong>V</strong></a>
| <a href="#W"><strong>W</strong></a>
| <a href="#Z"><strong>Z</strong></a>
</div>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Version._version_ids">_version_ids (lihzahrd.header.Version attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.HardmodeTier3Ore.ADAMANTITE">ADAMANTITE (lihzahrd.header.HardmodeTier3Ore attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.altars_smashed">altars_smashed (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AltarsSmashed">AltarsSmashed (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.AMANITIA_FUNGIFIN">AMANITIA_FUNGIFIN (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.ANGELFISH">ANGELFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuest">AnglerQuest (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish">AnglerQuestFish (class in lihzahrd.header)</a>
</li>
<li><a href="world.html#lihzahrd.World.anglers_quest">anglers_quest (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.BossesDefeated.any_mechnical_boss">any_mechnical_boss (lihzahrd.header.BossesDefeated attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.LunarEvents.are_active">are_active (lihzahrd.header.LunarEvents attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Backgrounds">Backgrounds (class in lihzahrd.header)</a>
</li>
<li><a href="world.html#lihzahrd.World.backgrounds">backgrounds (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.BATFISH">BATFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.bit">bit() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.Events.blood_moon">blood_moon (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.BLOODY_MANOWAR">BLOODY_MANOWAR (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.BONEFISH">BONEFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.bool">bool() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="world.html#lihzahrd.World.bosses_defeated">bosses_defeated (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.BossesDefeated">BossesDefeated (class in lihzahrd.header)</a>
</li>
<li><a href="world.html#lihzahrd.World.bounds">bounds (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.BUMBLEBEE_TUNA">BUMBLEBEE_TUNA (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.BUNNYFISH">BUNNYFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.CAPN_TUNABEARD">CAPN_TUNABEARD (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.CATFISH">CATFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.cavern_level">cavern_level (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.CLOUDFISH">CLOUDFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Clouds">Clouds (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.CLOWNFISH">CLOWNFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.HardmodeTier1Ore.COBALT">COBALT (lihzahrd.header.HardmodeTier1Ore attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuest.completed_by">completed_by (lihzahrd.header.AnglerQuest attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Party.cooldown">cooldown (lihzahrd.header.Party attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Coordinates">Coordinates (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.WorldEvilType.CORRUPTION">CORRUPTION (lihzahrd.header.WorldEvilType attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AltarsSmashed.count">count (lihzahrd.header.AltarsSmashed attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.create_from_file">create_from_file() (lihzahrd.World class method)</a>
</li>
<li><a href="world.html#lihzahrd.World.created_on">created_on (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.WorldEvilType.CRIMSON">CRIMSON (lihzahrd.header.WorldEvilType attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.crimson_hearts">crimson_hearts() (lihzahrd.World property)</a>
</li>
<li><a href="header.html#lihzahrd.header.Time.current">current (lihzahrd.header.Time attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuest.current_goal">current_goal (lihzahrd.header.AnglerQuest attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.CURSEDFISH">CURSEDFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.FileReader.datetime">datetime() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.DEMONIC_HELLFISH">DEMONIC_HELLFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.DERPFISH">DERPFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.DIRTFISH">DIRTFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.double">double() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="world.html#lihzahrd.World.dungeon_point">dungeon_point (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.DYNAMITE_FISH">DYNAMITE_FISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.EATER_OF_PLANKTON">EATER_OF_PLANKTON (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Events">Events (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="world.html#lihzahrd.World.events">events (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.ShadowOrbs.evil_boss_counter">evil_boss_counter (lihzahrd.header.ShadowOrbs attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.FALLEN_STARFISH">FALLEN_STARFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FourPartSplit.far_left">far_left() (lihzahrd.header.FourPartSplit property)</a>
</li>
<li><a href="header.html#lihzahrd.header.FourPartSplit.far_right">far_right() (lihzahrd.header.FourPartSplit property)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader">FileReader (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase.FIRST_QUARTER">FIRST_QUARTER (lihzahrd.header.MoonPhase attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.FISHOTRON">FISHOTRON (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.FISHRON">FISHRON (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FourPartSplit">FourPartSplit (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.InvasionType.FROST_LEGION">FROST_LEGION (lihzahrd.header.InvasionType attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase.FULL_MOON">FULL_MOON (lihzahrd.header.MoonPhase attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="world.html#lihzahrd.World.generator">generator (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.GeneratorInfo">GeneratorInfo (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.FourPartSplit.get_property_at_x">get_property_at_x() (lihzahrd.header.FourPartSplit method)</a>
</li>
<li><a href="header.html#lihzahrd.header.InvasionType.GOBLIN_INVASION">GOBLIN_INVASION (lihzahrd.header.InvasionType attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.GUIDE_VOODOO_FISH">GUIDE_VOODOO_FISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.HardmodeTier1Ore">HardmodeTier1Ore (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.HardmodeTier2Ore">HardmodeTier2Ore (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.HardmodeTier3Ore">HardmodeTier3Ore (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.HARPYFISH">HARPYFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.HUNGERFISH">HUNGERFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.ICHORFISH">ICHORFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.id">id (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.INFECTED_SCABBARDFISH">INFECTED_SCABBARDFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.int1">int1() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.int2">int2() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.int4">int4() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.int8">int8() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.Invasion">Invasion (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Events.invasion">invasion (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.InvasionType">InvasionType (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.Rain.is_active">is_active (lihzahrd.header.Rain attribute)</a>
<ul>
<li><a href="header.html#lihzahrd.header.Sandstorm.is_active">(lihzahrd.header.Sandstorm attribute)</a>
</li>
</ul></li>
<li><a href="header.html#lihzahrd.header.Party.is_active">is_active() (lihzahrd.header.Party property)</a>
</li>
<li><a href="header.html#lihzahrd.header.Time.is_daytime">is_daytime (lihzahrd.header.Time attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.is_expert">is_expert (lihzahrd.World attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.is_favorite">is_favorite (lihzahrd.World attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.is_hardmode">is_hardmode (lihzahrd.World attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="J">J</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.JEWELFISH">JEWELFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#module-lihzahrd.header">lihzahrd.header (module)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Events.lunar_events">lunar_events (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.LunarEvents">LunarEvents (class in lihzahrd.header)</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.InvasionType.MARTIAN_MADNESS">MARTIAN_MADNESS (lihzahrd.header.InvasionType attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.MIRAGE_FISH">MIRAGE_FISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Time.moon_phase">moon_phase (lihzahrd.header.Time attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase">MoonPhase (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.MoonStyle">MoonStyle (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.MUDFISH">MUDFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.MUTANT_FLINXFIN">MUTANT_FLINXFIN (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.HardmodeTier2Ore.MYTHRIL">MYTHRIL (lihzahrd.header.HardmodeTier2Ore attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="world.html#lihzahrd.World.name">name (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Version.name">name() (lihzahrd.header.Version property)</a>
</li>
<li><a href="header.html#lihzahrd.header.FourPartSplit.nearby_left">nearby_left() (lihzahrd.header.FourPartSplit property)</a>
</li>
<li><a href="header.html#lihzahrd.header.FourPartSplit.nearby_right">nearby_right() (lihzahrd.header.FourPartSplit property)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase.NEW_MOON">NEW_MOON (lihzahrd.header.MoonPhase attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.InvasionType.NONE">NONE (lihzahrd.header.InvasionType attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.HardmodeTier1Ore.NOT_DETERMINED">NOT_DETERMINED (lihzahrd.header.HardmodeTier1Ore attribute)</a>
<ul>
<li><a href="header.html#lihzahrd.header.HardmodeTier2Ore.NOT_DETERMINED">(lihzahrd.header.HardmodeTier2Ore attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.HardmodeTier3Ore.NOT_DETERMINED">(lihzahrd.header.HardmodeTier3Ore attribute)</a>
</li>
</ul></li>
<li><a href="header.html#lihzahrd.header.HardmodeTier3Ore.NOT_DETERMINED_TOO">NOT_DETERMINED_TOO (lihzahrd.header.HardmodeTier3Ore attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.OldOnesArmyTiers">OldOnesArmyTiers (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.MoonStyle.ORANGE">ORANGE (lihzahrd.header.MoonStyle attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.HardmodeTier2Ore.ORICHALCUM">ORICHALCUM (lihzahrd.header.HardmodeTier2Ore attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.HardmodeTier1Ore.PALLADIUM">PALLADIUM (lihzahrd.header.HardmodeTier1Ore attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Party">Party (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.Events.party">party (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Party.partying_npcs">partying_npcs (lihzahrd.header.Party attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.PENGFISH">PENGFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.LunarEvents.pillars_present">pillars_present (lihzahrd.header.LunarEvents attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.PillarsInfo">PillarsInfo (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.InvasionType.PIRATE_INVASION">PIRATE_INVASION (lihzahrd.header.InvasionType attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.PIXIEFISH">PIXIEFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FourPartSplit.properties">properties (lihzahrd.header.FourPartSplit attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Rain">Rain (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.Events.rain">rain (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Rect">Rect (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.FileReader.rect">rect() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="world.html#lihzahrd.World.revision">revision (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonStyle.RINGED_GREEN">RINGED_GREEN (lihzahrd.header.MoonStyle attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Sandstorm">Sandstorm (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.Events.sandstorm">sandstorm (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.saved_npcs">saved_npcs (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.SavedNPCs">SavedNPCs (class in lihzahrd.header)</a>
</li>
<li><a href="world.html#lihzahrd.World.savefile_type">savefile_type (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.GeneratorInfo.seed">seed (lihzahrd.header.GeneratorInfo attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FourPartSplit.separators">separators (lihzahrd.header.FourPartSplit attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.shadow_orbs">shadow_orbs (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.ShadowOrbs">ShadowOrbs (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.single">single() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="world.html#lihzahrd.World.size">size (lihzahrd.World attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Events.slime_rain">slime_rain (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.SLIMEFISH">SLIMEFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.ShadowOrbs.smashed_at_least_once">smashed_at_least_once (lihzahrd.header.ShadowOrbs attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Events.solar_eclipse">solar_eclipse (lihzahrd.header.Events attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.ShadowOrbs.spawn_meteorite">spawn_meteorite (lihzahrd.header.ShadowOrbs attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.spawn_point">spawn_point (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.SPIDERFISH">SPIDERFISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.string">string() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.Styles">Styles (class in lihzahrd.header)</a>
</li>
<li><a href="world.html#lihzahrd.World.styles">styles (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Time.sundial_cooldown">sundial_cooldown (lihzahrd.header.Time attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.THE_FISH_OF_CTHULHU">THE_FISH_OF_CTHULHU (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase.THIRD_QUARTER">THIRD_QUARTER (lihzahrd.header.MoonPhase attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Party.thrown_by_npcs">thrown_by_npcs (lihzahrd.header.Party attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Party.thrown_by_party_center">thrown_by_party_center (lihzahrd.header.Party attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Time">Time (class in lihzahrd.header)</a>
</li>
<li><a href="world.html#lihzahrd.World.time">time (lihzahrd.World attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Rain.time_left">time_left (lihzahrd.header.Rain attribute)</a>
<ul>
<li><a href="header.html#lihzahrd.header.Sandstorm.time_left">(lihzahrd.header.Sandstorm attribute)</a>
</li>
</ul></li>
<li><a href="header.html#lihzahrd.header.HardmodeTier3Ore.TITANIUM">TITANIUM (lihzahrd.header.HardmodeTier3Ore attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.TROPICAL_BARRACUDA">TROPICAL_BARRACUDA (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.TUNDRA_TROUT">TUNDRA_TROUT (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.Invasion.type">type (lihzahrd.header.Invasion attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.FileReader.uint1">uint1() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.uint2">uint2() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.uint4">uint4() (lihzahrd.header.FileReader method)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.uint8">uint8() (lihzahrd.header.FileReader method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="world.html#lihzahrd.World.underground_level">underground_level (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.UNICORN_FISH">UNICORN_FISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World.uuid">uuid (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.FileReader.uuid">uuid() (lihzahrd.header.FileReader method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.Version">Version (class in lihzahrd.header)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.GeneratorInfo.version">version (lihzahrd.header.GeneratorInfo attribute)</a>
<ul>
<li><a href="world.html#lihzahrd.World.version">(lihzahrd.World attribute)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.MoonPhase.WANING_CRESCENT">WANING_CRESCENT (lihzahrd.header.MoonPhase attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase.WANING_GIBBOUS">WANING_GIBBOUS (lihzahrd.header.MoonPhase attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase.WAXING_CRESCENT">WAXING_CRESCENT (lihzahrd.header.MoonPhase attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.MoonPhase.WAXING_GIBBOUS">WAXING_GIBBOUS (lihzahrd.header.MoonPhase attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.MoonStyle.WHITE">WHITE (lihzahrd.header.MoonStyle attribute)</a>
</li>
<li><a href="world.html#lihzahrd.World">World (class in lihzahrd)</a>
</li>
<li><a href="world.html#lihzahrd.World.world_evil">world_evil (lihzahrd.World attribute)</a>
</li>
<li><a href="header.html#lihzahrd.header.WorldEvilType">WorldEvilType (class in lihzahrd.header)</a>
</li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.WYVERNTAIL">WYVERNTAIL (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="Z">Z</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.ZOMBIE_FISH">ZOMBIE_FISH (lihzahrd.header.AnglerQuestFish attribute)</a>
</li>
</ul></td>
</tr></table>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

1053
docs/html/header.html Normal file
View file

File diff suppressed because it is too large Load diff

217
docs/html/index.html Normal file
View file

@ -0,0 +1,217 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>lihzahrd &mdash; lihzahrd documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.World" href="world.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> lihzahrd
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">lihzahrd</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> &raquo;</li>
<li>lihzahrd</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="lihzahrd">
<h1>lihzahrd<a class="headerlink" href="#lihzahrd" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a><ul class="simple">
</ul>
</li>
</ul>
</div>
<div class="section" id="some-useful-links">
<h2>Some useful links<a class="headerlink" href="#some-useful-links" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/Steffo99/lihzahrd">Lihzahrd on GitHub</a></p></li>
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="world.html" class="btn btn-neutral float-right" title="lihzahrd.World" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

BIN
docs/html/objects.inv Normal file
View file

Binary file not shown.

211
docs/html/py-modindex.html Normal file
View file

@ -0,0 +1,211 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Python Module Index &mdash; lihzahrd documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> lihzahrd
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">lihzahrd</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Python Module Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-l"><strong>l</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-l"><td></td><td>
<strong>l</strong></td><td></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<code class="xref">lihzahrd</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="header.html#module-lihzahrd.header"><code class="xref">lihzahrd.header</code></a></td><td>
<em></em></td></tr>
</table>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

207
docs/html/search.html Normal file
View file

@ -0,0 +1,207 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; lihzahrd documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> lihzahrd
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">lihzahrd</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Search</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<noscript>
<div id="fallback" class="admonition warning">
<p class="last">
Please activate JavaScript to enable the search
functionality.
</p>
</div>
</noscript>
<div id="search-results">
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script type="text/javascript" id="searchindexloader"></script>
</body>
</html>

1
docs/html/searchindex.js Normal file
View file

File diff suppressed because one or more lines are too long

386
docs/html/world.html Normal file
View file

@ -0,0 +1,386 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>lihzahrd.World &mdash; lihzahrd documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.header" href="header.html" />
<link rel="prev" title="lihzahrd" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> lihzahrd
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.World</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">lihzahrd</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>lihzahrd.World</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/world.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="lihzahrd-world">
<h1>lihzahrd.World<a class="headerlink" href="#lihzahrd-world" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="class">
<dt id="lihzahrd.World">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.</code><code class="sig-name descname">World</code><span class="sig-paren">(</span><em class="sig-param">version: lihzahrd.header.version.Version</em>, <em class="sig-param">savefile_type: int</em>, <em class="sig-param">revision: int</em>, <em class="sig-param">is_favorite: bool</em>, <em class="sig-param">name: str</em>, <em class="sig-param">generator: lihzahrd.header.generatorinfo.GeneratorInfo</em>, <em class="sig-param">uuid_: uuid.UUID</em>, <em class="sig-param">id_: int</em>, <em class="sig-param">bounds: lihzahrd.header.rect.Rect</em>, <em class="sig-param">size: lihzahrd.header.coordinates.Coordinates</em>, <em class="sig-param">is_expert: bool</em>, <em class="sig-param">created_on</em>, <em class="sig-param">styles: lihzahrd.header.styles.Styles</em>, <em class="sig-param">backgrounds: lihzahrd.header.backgrounds.Backgrounds</em>, <em class="sig-param">spawn_point: lihzahrd.header.coordinates.Coordinates</em>, <em class="sig-param">underground_level: float</em>, <em class="sig-param">cavern_level: float</em>, <em class="sig-param">time: lihzahrd.header.time.Time</em>, <em class="sig-param">events: lihzahrd.header.events.Events</em>, <em class="sig-param">dungeon_point: lihzahrd.header.coordinates.Coordinates</em>, <em class="sig-param">world_evil: lihzahrd.header.worldeviltype.WorldEvilType</em>, <em class="sig-param">saved_npcs: lihzahrd.header.savednpcs.SavedNPCs</em>, <em class="sig-param">altars_smashed: lihzahrd.header.altarssmashed.AltarsSmashed</em>, <em class="sig-param">is_hardmode: bool</em>, <em class="sig-param">shadow_orbs: lihzahrd.header.shadoworbs.ShadowOrbs</em>, <em class="sig-param">bosses_defeated: lihzahrd.header.bossesdefeated.BossesDefeated</em>, <em class="sig-param">anglers_quest: lihzahrd.header.anglerquest.AnglerQuest</em>, <em class="sig-param">clouds: lihzahrd.header.clouds.Clouds</em>, <em class="sig-param">cultist_delay: int</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World" title="Permalink to this definition"></a></dt>
<dd><p>The Python representation of a Terraria world.</p>
<dl class="attribute">
<dt id="lihzahrd.World.altars_smashed">
<code class="sig-name descname">altars_smashed</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.altars_smashed" title="Permalink to this definition"></a></dt>
<dd><p>Information related to the destruction of Demon Altars with a Pwnhammer.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.anglers_quest">
<code class="sig-name descname">anglers_quest</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.anglers_quest" title="Permalink to this definition"></a></dt>
<dd><p>Information about today’s Angler’s Quest.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.backgrounds">
<code class="sig-name descname">backgrounds</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.backgrounds" title="Permalink to this definition"></a></dt>
<dd><p>The backgrounds of the various biomes.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.bosses_defeated">
<code class="sig-name descname">bosses_defeated</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.bosses_defeated" title="Permalink to this definition"></a></dt>
<dd><p>Which bosses have been defeated in the world.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.bounds">
<code class="sig-name descname">bounds</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.bounds" title="Permalink to this definition"></a></dt>
<dd><p>The world size in pixels.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.cavern_level">
<code class="sig-name descname">cavern_level</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.cavern_level" title="Permalink to this definition"></a></dt>
<dd><p>The depth at which the cavern biome starts.</p>
</dd></dl>
<dl class="method">
<dt id="lihzahrd.World.create_from_file">
<em class="property">classmethod </em><code class="sig-name descname">create_from_file</code><span class="sig-paren">(</span><em class="sig-param">file</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World.create_from_file" title="Permalink to this definition"></a></dt>
<dd><p>Create a World object from a .wld file.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.created_on">
<code class="sig-name descname">created_on</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.created_on" title="Permalink to this definition"></a></dt>
<dd><p>The date and time this world was created in.</p>
</dd></dl>
<dl class="method">
<dt id="lihzahrd.World.crimson_hearts">
<em class="property">property </em><code class="sig-name descname">crimson_hearts</code><a class="headerlink" href="#lihzahrd.World.crimson_hearts" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.dungeon_point">
<code class="sig-name descname">dungeon_point</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.dungeon_point" title="Permalink to this definition"></a></dt>
<dd><p>The Old Man spawn point.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.events">
<code class="sig-name descname">events</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.events" title="Permalink to this definition"></a></dt>
<dd><p>Currently ongoing world events.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.generator">
<code class="sig-name descname">generator</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.generator" title="Permalink to this definition"></a></dt>
<dd><p>Information about the generation of this world.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.id">
<code class="sig-name descname">id</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.id" title="Permalink to this definition"></a></dt>
<dd><p>The world id. Used to name the minimap file.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.is_expert">
<code class="sig-name descname">is_expert</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.is_expert" title="Permalink to this definition"></a></dt>
<dd><p>If the world is in expert mode or not.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.is_favorite">
<code class="sig-name descname">is_favorite</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.is_favorite" title="Permalink to this definition"></a></dt>
<dd><p>If the world is marked as favorite or not.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.is_hardmode">
<code class="sig-name descname">is_hardmode</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.is_hardmode" title="Permalink to this definition"></a></dt>
<dd><p>Whether or not the world is in hardmode.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.name">
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.name" title="Permalink to this definition"></a></dt>
<dd><p>The name the world was given at creation. Doesn’t always match the filename.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.revision">
<code class="sig-name descname">revision</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.revision" title="Permalink to this definition"></a></dt>
<dd><p>The number of times this world was saved.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.saved_npcs">
<code class="sig-name descname">saved_npcs</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.saved_npcs" title="Permalink to this definition"></a></dt>
<dd><p>The NPCs that were rescued by the player.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.savefile_type">
<code class="sig-name descname">savefile_type</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.savefile_type" title="Permalink to this definition"></a></dt>
<dd><p>The format of the save file. Should be 2 for all versions following 1.2.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.shadow_orbs">
<code class="sig-name descname">shadow_orbs</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.shadow_orbs" title="Permalink to this definition"></a></dt>
<dd><p>Information related to the Shadow Orbs or Crimson Hearts in the world.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.size">
<code class="sig-name descname">size</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.size" title="Permalink to this definition"></a></dt>
<dd><p>The world size in tiles.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.spawn_point">
<code class="sig-name descname">spawn_point</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.spawn_point" title="Permalink to this definition"></a></dt>
<dd><p>The coordinates of the spawn point.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.styles">
<code class="sig-name descname">styles</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.styles" title="Permalink to this definition"></a></dt>
<dd><p>The styles of various world elements.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.time">
<code class="sig-name descname">time</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.time" title="Permalink to this definition"></a></dt>
<dd><p>Game time related information.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.underground_level">
<code class="sig-name descname">underground_level</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.underground_level" title="Permalink to this definition"></a></dt>
<dd><p>The depth at which the underground biome starts.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.uuid">
<code class="sig-name descname">uuid</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.uuid" title="Permalink to this definition"></a></dt>
<dd><p>The Universally Unique ID of this world.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.version">
<code class="sig-name descname">version</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.version" title="Permalink to this definition"></a></dt>
<dd><p>The game version when this savefile was last saved.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.World.world_evil">
<code class="sig-name descname">world_evil</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.world_evil" title="Permalink to this definition"></a></dt>
<dd><p>Whether the world has Corruption or Crimson.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="header.html" class="btn btn-neutral float-right" title="lihzahrd.header" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="lihzahrd" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

9
docs/index.html Normal file
View file

@ -0,0 +1,9 @@
<html>
<head>
<script>
window.onload = function() {
window.location.replace("html")
}
</script>
</head>
</html>

1
docs_source/conf.py
View file

@ -29,6 +29,7 @@ author = 'Stefano Pigozzi'
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.intersphinx"]
intersphinx_mapping = {"python": ("https://docs.python.org/3.7", None)}
napoleon_use_param = True
def skip(app, what, name: str, obj, would_skip, options):

11
docs_source/header.rst Normal file
View file

@ -0,0 +1,11 @@
lihzahrd.header
====================================
.. toctree::
:maxdepth: 2
.. automodule:: lihzahrd.header
:members:
:private-members:
:undoc-members:

7
docs_source/index.rst
View file

@ -4,11 +4,8 @@ lihzahrd
.. toctree::
:maxdepth: 2
.. automodule:: lihzahrd
:members:
:private-members:
:undoc-members:
world
header
Some useful links

11
docs_source/world.rst Normal file
View file

@ -0,0 +1,11 @@
lihzahrd.World
====================================
.. toctree::
:maxdepth: 2
.. autoclass:: lihzahrd.World
:members:
:private-members:
:undoc-members:

1095
lihzahrd/__init__.py
View file

File diff suppressed because it is too large Load diff

77
lihzahrd/header/__init__.py Normal file
View file

@ -0,0 +1,77 @@
from .altarssmashed import AltarsSmashed
from .anglerquest import AnglerQuest
from .anglerquestfish import AnglerQuestFish
from .backgrounds import Backgrounds
from .bossesdefeated import BossesDefeated
from .clouds import Clouds
from .coordinates import Coordinates
from .events import Events
from .filereader import FileReader
from .fourpartsplit import FourPartSplit
from .generatorinfo import GeneratorInfo
from .hardmodeore import HardmodeTier1Ore, HardmodeTier2Ore, HardmodeTier3Ore
from .invasion import Invasion
from .invasiontype import InvasionType
from .lunarevents import LunarEvents
from .moonphase import MoonPhase
from .moonstyle import MoonStyle
from .oldonesarmytiers import OldOnesArmyTiers
from .party import Party
from .pillarsinfo import PillarsInfo
from .rain import Rain
from .rect import Rect
from .sandstorm import Sandstorm
from .savednpcs import SavedNPCs
from .shadoworbs import ShadowOrbs
from .styles import Styles
from .time import Time
from .version import Version
from .worldeviltype import WorldEvilType
__all__ = [
"AltarsSmashed",
"AnglerQuest",
"AnglerQuestFish",
"Backgrounds",
"BossesDefeated",
"Clouds",
"Coordinates",
"Events",
"FileReader",
"FourPartSplit",
"GeneratorInfo",
"HardmodeTier1Ore",
"HardmodeTier2Ore",
"HardmodeTier3Ore",
"Invasion",
"InvasionType",
"LunarEvents",
"MoonPhase",
"MoonStyle",
"OldOnesArmyTiers",
"Party",
"PillarsInfo",
"Rain",
"Rect",
"Sandstorm",
"SavedNPCs",
"ShadowOrbs",
"Styles",
"Time",
"Version",
"WorldEvilType"
]

20
lihzahrd/header/altarssmashed.py Normal file
View file

@ -0,0 +1,20 @@
from .hardmodeore import HardmodeTier1Ore, HardmodeTier2Ore, HardmodeTier3Ore
class AltarsSmashed:
"""Information related to the first three hardmode ores."""
def __init__(self,
count: int,
ore_tier1: HardmodeTier1Ore,
ore_tier2: HardmodeTier2Ore,
ore_tier3: HardmodeTier3Ore):
self.count: int = count
"""The number of altars smashed."""
self.ore_tier1: HardmodeTier1Ore = ore_tier1
self.ore_tier2: HardmodeTier2Ore = ore_tier2
self.ore_tier3: HardmodeTier3Ore = ore_tier3
def __repr__(self):
return f"WorldAltars(count={self.count}, ore_tier1={self.ore_tier1}, ore_tier2={self.ore_tier2}," \
f" ore_tier3={self.ore_tier3})"

16
lihzahrd/header/anglerquest.py Normal file
View file

@ -0,0 +1,16 @@
import typing
from .anglerquestfish import AnglerQuestFish
class AnglerQuest:
"""Information about today's Angler's quest."""
def __init__(self, current_goal: AnglerQuestFish, completed_by: typing.List[str]):
self.current_goal: AnglerQuestFish = current_goal
"""The fish currently requested by the angler."""
self.completed_by: typing.List[str] = completed_by
"""A list of player names who completed the angler's quest today."""
def __repr__(self):
return f"WorldAnglersQuest(current_goal={self.current_goal}, completed_by={self.completed_by})"

46
lihzahrd/header/anglerquestfish.py Normal file
View file

@ -0,0 +1,46 @@
import enum
class AnglerQuestFish(enum.IntEnum):
BATFISH = 0
BUMBLEBEE_TUNA = 1
CATFISH = 2
CLOUDFISH = 3
CURSEDFISH = 4
DIRTFISH = 5
DYNAMITE_FISH = 6
EATER_OF_PLANKTON = 7
FALLEN_STARFISH = 8
THE_FISH_OF_CTHULHU = 9
FISHOTRON = 10
HARPYFISH = 11
HUNGERFISH = 12
ICHORFISH = 13
JEWELFISH = 14
MIRAGE_FISH = 15
MUTANT_FLINXFIN = 16
PENGFISH = 17
PIXIEFISH = 18
SPIDERFISH = 19
TUNDRA_TROUT = 20
UNICORN_FISH = 21
GUIDE_VOODOO_FISH = 22
WYVERNTAIL = 23
ZOMBIE_FISH = 24
AMANITIA_FUNGIFIN = 25
ANGELFISH = 26
BLOODY_MANOWAR = 27
BONEFISH = 28
BUNNYFISH = 29
CAPN_TUNABEARD = 30
CLOWNFISH = 31
DEMONIC_HELLFISH = 32
DERPFISH = 33
FISHRON = 34
INFECTED_SCABBARDFISH = 35
MUDFISH = 36
SLIMEFISH = 37
TROPICAL_BARRACUDA = 38
def __repr__(self):
return f"AnglerQuestFish('{self.name}')"

28
lihzahrd/header/backgrounds.py Normal file
View file

@ -0,0 +1,28 @@
class Backgrounds:
"""The backgrounds of various world biomes."""
def __init__(self,
bg_underground_snow: int,
bg_underground_jungle: int,
bg_hell: int,
bg_forest: int,
bg_corruption: int,
bg_jungle: int,
bg_snow: int,
bg_hallow: int,
bg_crimson: int,
bg_desert: int,
bg_ocean: int):
self.bg_underground_snow: int = bg_underground_snow
self.bg_underground_jungle: int = bg_underground_jungle
self.bg_hell: int = bg_hell
self.bg_forest: int = bg_forest
self.bg_corruption: int = bg_corruption
self.bg_jungle: int = bg_jungle
self.bg_snow: int = bg_snow
self.bg_hallow: int = bg_hallow
self.bg_crimson: int = bg_crimson
self.bg_desert: int = bg_desert
self.bg_ocean: int = bg_ocean
def __repr__(self):
return f"WorldBackgrounds({self.bg_underground_snow}, {self.bg_underground_jungle}, {self.bg_hell}, {self.bg_forest}, {self.bg_corruption}, {self.bg_jungle}, {self.bg_snow}, {self.bg_hallow}, {self.bg_crimson}, {self.bg_desert}, {self.bg_ocean})"

60
lihzahrd/header/bossesdefeated.py Normal file
View file

@ -0,0 +1,60 @@
from .pillarsinfo import PillarsInfo
from .oldonesarmytiers import OldOnesArmyTiers
class BossesDefeated:
def __init__(self,
eye_of_cthulhu: bool,
eater_of_worlds: bool,
skeletron: bool,
queen_bee: bool,
the_twins: bool,
the_destroyer: bool,
skeletron_prime: bool,
any_mechnical_boss: bool,
plantera: bool,
golem: bool,
king_slime: bool,
goblin_army: bool,
clown: bool,
frost_moon: bool,
pirates: bool,
duke_fishron: bool,
moon_lord: bool,
pumpking: bool,
mourning_wood: bool,
ice_queen: bool,
santa_nk1: bool,
everscream: bool,
lunar_pillars: PillarsInfo,
old_ones_army: OldOnesArmyTiers):
self.eye_of_cthulhu: bool = eye_of_cthulhu
self.eater_of_worlds: bool = eater_of_worlds
self.skeletron: bool = skeletron
self.queen_bee: bool = queen_bee
self.the_twins: bool = the_twins
self.the_destroyer: bool = the_destroyer
self.skeletron_prime: bool = skeletron_prime
self.any_mechnical_boss: bool = any_mechnical_boss
"""Appearently, there's a different flag for beating any mechanical boss and a specific mechanical boss."""
self.plantera: bool = plantera
self.golem: bool = golem
self.king_slime: bool = king_slime
self.goblin_army: bool = goblin_army
self.clown: bool = clown
self.frost_moon: bool = frost_moon
self.pirates: bool = pirates
self.duke_fishron: bool = duke_fishron
self.moon_lord: bool = moon_lord
self.pumpking: bool = pumpking
self.mourning_wood: bool = mourning_wood
self.ice_queen: bool = ice_queen
self.santa_nk1: bool = santa_nk1
self.everscream: bool = everscream
self.lunar_pillars: PillarsInfo = lunar_pillars
self.old_ones_army: OldOnesArmyTiers = old_ones_army
def __repr__(self):
return f"<WorldBossesDefeated>"

9
lihzahrd/header/clouds.py Normal file
View file

@ -0,0 +1,9 @@
class Clouds:
"""Information about... the clouds in the world?"""
def __init__(self, bg_cloud: int, cloud_number: int, wind_speed: float):
self.bg_cloud: int = bg_cloud
self.cloud_number: int = cloud_number
self.wind_speed: float = wind_speed
def __repr__(self):
return f"WorldClouds(bg_cloud={self.bg_cloud}, cloud_number={self.cloud_number}, wind_speed={self.wind_speed})"

11
lihzahrd/header/coordinates.py Normal file
View file

@ -0,0 +1,11 @@
class Coordinates:
"""A pair of coordinates."""
def __init__(self, x, y):
self.x = x
self.y = y
def __repr__(self):
return f"Coordinates({self.x}, {self.y})"
def __str__(self):
return f"{self.x}, {self.y}"

44
lihzahrd/header/events.py Normal file
View file

@ -0,0 +1,44 @@
from .invasion import Invasion
from .rain import Rain
from .party import Party
from .sandstorm import Sandstorm
from .lunarevents import LunarEvents
class Events:
"""Information about the ongoing world events."""
def __init__(self,
blood_moon: bool,
solar_eclipse: bool,
invasion: Invasion,
slime_rain: float,
rain: Rain,
party: Party,
sandstorm: Sandstorm,
lunar_events: LunarEvents):
self.blood_moon: bool = blood_moon
"""If the current moon is a Blood Moon."""
self.solar_eclipse: bool = solar_eclipse
"""If the current day is a Solar Eclipse."""
self.invasion: Invasion = invasion
"""Information about the currently ongoing invasion."""
self.slime_rain: float = slime_rain
"""How long the slime rain will go on for."""
self.rain: Rain = rain
"""Information about the currently ongoing rain."""
self.party: Party = party
"""Information about the currently ongoing party."""
self.sandstorm: Sandstorm = sandstorm
"""Information about the currently ongoing sandstorm."""
self.lunar_events: LunarEvents = lunar_events
"""Information about the currently ongoing Lunar Events."""
def __repr__(self):
return f"<WorldEvents>"

75
lihzahrd/header/filereader.py Normal file
View file

@ -0,0 +1,75 @@
import typing
import struct
import uuid
import datetime
from .rect import Rect
class FileReader:
def __init__(self, file):
self.file = file
def bool(self) -> bool:
return struct.unpack("?", self.file.read(1))[0]
def int1(self) -> int:
return struct.unpack("B", self.file.read(1))[0]
def uint1(self) -> int:
return struct.unpack("B", self.file.read(1))[0]
def int2(self) -> int:
return struct.unpack("h", self.file.read(2))[0]
def uint2(self) -> int:
return struct.unpack("H", self.file.read(2))[0]
def int4(self) -> int:
return struct.unpack("i", self.file.read(4))[0]
def uint4(self) -> int:
return struct.unpack("I", self.file.read(4))[0]
def int8(self) -> int:
return struct.unpack("q", self.file.read(8))[0]
def uint8(self) -> int:
return struct.unpack("Q", self.file.read(8))[0]
def single(self) -> float:
return struct.unpack("f", self.file.read(4))[0]
def double(self) -> float:
return struct.unpack("d", self.file.read(8))[0]
def bit(self) -> typing.Tuple[bool, bool, bool, bool, bool, bool, bool, bool]:
data = struct.unpack("B", self.file.read(1))[0]
return (bool(data & 0b1000_0000),
bool(data & 0b0100_0000),
bool(data & 0b0010_0000),
bool(data & 0b0001_0000),
bool(data & 0b0000_1000),
bool(data & 0b0000_0100),
bool(data & 0b0000_0010),
bool(data & 0b0000_0001))
def rect(self) -> Rect:
left, right, top, bottom = struct.unpack("iiii", self.file.read(16))
return Rect(left, right, top, bottom)
def string(self, size=None) -> str:
if size is None:
size = self.uint1()
return str(self.file.read(size), encoding="latin1")
def uuid(self) -> uuid.UUID:
# TODO: convert to uuid
# https://docs.microsoft.com/en-us/dotnet/api/system.guid.tobytearray?view=netframework-4.8
uuid_bytes = self.file.read(16)
return uuid_bytes
def datetime(self) -> datetime.datetime:
# TODO: convert to datetime
# https://docs.microsoft.com/it-it/dotnet/api/system.datetime.kind?view=netframework-4.8#System_DateTime_Kind
datetime_bytes = self.file.read(8)
return datetime_bytes

62
lihzahrd/header/fourpartsplit.py Normal file
View file

@ -0,0 +1,62 @@
import typing
class FourPartSplit:
"""A world property split in four parts, separated by three vertical lines at a certain x coordinate."""
def __init__(self, separators: typing.List[int], properties: typing.List):
self.separators: typing.List[int] = separators
"""The three x coordinates of the vertical separators, in increasing order."""
self.properties: typing.List = properties
"""The four properties, in order:
- The far left property, the one between the left world edge and the first separator.
- The nearby left property, between the first and the second separator.
- The nearby right property, between the second and the third separator.
- The far right property, between the third separator and the right world edge."""
def __repr__(self):
return f"FourPartSplit({repr(self.separators)}, {repr(self.properties)})"
def get_property_at_x(self, x: int):
if x < self.separators[0]:
return self.properties[0]
elif x < self.separators[1]:
return self.properties[1]
elif x < self.separators[2]:
return self.properties[2]
else:
return self.properties[3]
@property
def far_left(self):
return self.properties[0]
@far_left.setter
def far_left(self, value):
self.properties[0] = value
@property
def nearby_left(self):
return self.properties[1]
@nearby_left.setter
def nearby_left(self, value):
self.properties[1] = value
@property
def nearby_right(self):
return self.properties[2]
@nearby_right.setter
def nearby_right(self, value):
self.properties[2] = value
@property
def far_right(self):
return self.properties[2]
@far_right.setter
def far_right(self, value):
self.properties[2] = value

9
lihzahrd/header/generatorinfo.py Normal file
View file

@ -0,0 +1,9 @@
class GeneratorInfo:
"""Information about the world generator."""
def __init__(self, seed, version):
self.seed = seed
"""The seed this world was generated with."""
self.version = version
"""The version of the generator that created this world."""

29
lihzahrd/header/hardmodeore.py Normal file
View file

@ -0,0 +1,29 @@
import enum
class HardmodeTier1Ore(enum.IntEnum):
NOT_DETERMINED = -1
COBALT = 107
PALLADIUM = 221
def __repr__(self):
return f"HardmodeTier1Ore('{self.name}')"
class HardmodeTier2Ore(enum.IntEnum):
NOT_DETERMINED = -1
MYTHRIL = 108
ORICHALCUM = 222
def __repr__(self):
return f"HardmodeTier2Ore('{self.name}')"
class HardmodeTier3Ore(enum.IntEnum):
NOT_DETERMINED = -1
NOT_DETERMINED_TOO = 16785407 # ???
ADAMANTITE = 111
TITANIUM = 223
def __repr__(self):
return f"HardmodeTier3Ore('{self.name}')"

25
lihzahrd/header/invasion.py Normal file
View file

@ -0,0 +1,25 @@
from .invasiontype import InvasionType
class Invasion:
"""Invasions (goblin army, pirates, martian madness...) related information."""
def __init__(self, delay: int,
size: int,
type_: InvasionType,
position: float,
size_start: int):
self.delay: int = delay
self.size: int = size
self.type: InvasionType = type_
"""The type of the current invasion (goblin army / pirates / martian madness...).
If InvasionType.NONE, no invasion will be active in the world."""
self.position: float = position
self.size_start: int = size_start
def __repr__(self):
return f"WorldInvasion(delay={self.delay}, size={self.size}, type_={self.type}, position={self.position}," \
f" size_start={self.size_start})"

12
lihzahrd/header/invasiontype.py Normal file
View file

@ -0,0 +1,12 @@
import enum
class InvasionType(enum.IntEnum):
NONE = 0
GOBLIN_INVASION = 1
FROST_LEGION = 2
PIRATE_INVASION = 3
MARTIAN_MADNESS = 4
def __repr__(self):
return f"InvasionType('{self.name}')"

16
lihzahrd/header/lunarevents.py Normal file
View file

@ -0,0 +1,16 @@
from .pillarsinfo import PillarsInfo
class LunarEvents:
"""Lunar Events (Lunar Pillars) related information."""
def __init__(self,
are_active: bool,
pillars_present: PillarsInfo):
self.are_active: bool = are_active
"""If the Lunar Events are active or not."""
self.pillars_present: PillarsInfo = pillars_present
"""Which pillars are currently present in the world."""
def __repr__(self):
return f"WorldLunarEvents(are_active={self.are_active}, pillars_present={repr(self.pillars_present)})"

15
lihzahrd/header/moonphase.py Normal file
View file

@ -0,0 +1,15 @@
import enum
class MoonPhase(enum.IntEnum):
FULL_MOON = 0
WANING_GIBBOUS = 1
THIRD_QUARTER = 2
WANING_CRESCENT = 3
NEW_MOON = 4
WAXING_CRESCENT = 5
FIRST_QUARTER = 6
WAXING_GIBBOUS = 7
def __repr__(self):
return f"MoonPhases('{self.name}')"

11
lihzahrd/header/moonstyle.py Normal file
View file

@ -0,0 +1,11 @@
import enum
class MoonStyle(enum.IntEnum):
"""All possible moon styles."""
WHITE = 0
ORANGE = 1
RINGED_GREEN = 2
def __repr__(self):
return f"MoonStyle('{self.name}')"

8
lihzahrd/header/oldonesarmytiers.py Normal file
View file

@ -0,0 +1,8 @@
class OldOnesArmyTiers:
def __init__(self, tier1, tier2, tier3):
self.tier1: bool = tier1
self.tier2: bool = tier2
self.tier3: bool = tier3
def __repr__(self):
return f"OldOneArmyTiers({self.tier1}, {self.tier2}, {self.tier3})"

29
lihzahrd/header/party.py Normal file
View file

@ -0,0 +1,29 @@
import typing
class Party:
"""NPC Party related information."""
def __init__(self,
thrown_by_party_center: bool,
thrown_by_npcs: bool,
cooldown: int,
partying_npcs: typing.List[int]):
self.thrown_by_party_center: bool = thrown_by_party_center
"""If the party was started by right-clicking a Party Center."""
self.thrown_by_npcs: bool = thrown_by_npcs
"""If the item was spontaneously thrown by NPCs."""
self.cooldown: int = cooldown
"""How long a party cannot be started for."""
self.partying_npcs: typing.List[int] = partying_npcs
"""The list of NPC IDs that threw the party."""
def __repr__(self):
return f"WorldParty(thrown_by_party_center={self.thrown_by_party_center}," \
f" thrown_by_npcs={self.thrown_by_npcs}, cooldown={self.cooldown}, partying_npcs={self.partying_npcs})"
@property
def is_active(self):
return self.thrown_by_party_center or self.thrown_by_npcs

10
lihzahrd/header/pillarsinfo.py Normal file
View file

@ -0,0 +1,10 @@
class PillarsInfo:
"""A container for information associated with the Lunar Pillars."""
def __init__(self, solar, vortex, nebula, stardust):
self.solar = solar
self.vortex = vortex
self.nebula = nebula
self.stardust = stardust
def __repr__(self):
return f"PillarsInfo(solar={self.solar}, vortex={self.vortex}, nebula={self.nebula}, stardust={self.stardust})"

13
lihzahrd/header/rain.py Normal file
View file

@ -0,0 +1,13 @@
class Rain:
"""Rain related information."""
def __init__(self, is_active: bool, time_left: int, max_rain: float):
self.is_active: bool = is_active
"""If it is currently raining in the world."""
self.time_left: int = time_left
"""How long it will continue to rain for."""
self.max_rain: float = max_rain
def __repr__(self):
return f"WorldRain(is_active={self.is_active}, time_left={self.time_left}, max_rain={self.max_rain})"

9
lihzahrd/header/rect.py Normal file
View file

@ -0,0 +1,9 @@
class Rect:
def __init__(self, left, right, top, bottom):
self.left = left
self.right = right
self.top = top
self.bottom = bottom
def __repr__(self):
return f"Rect(left={self.left}, right={self.right}, top={self.top}, bottom={self.bottom})"

18
lihzahrd/header/sandstorm.py Normal file
View file

@ -0,0 +1,18 @@
class Sandstorm:
"""Sandstorm related information."""
def __init__(self,
is_active: bool,
time_left: int,
severity: float,
intended_severity: float):
self.is_active: bool = is_active
"""If a sandstorm is currently ongoing in the desert."""
self.time_left: int = time_left
"""How long the sandstorm will continue for."""
self.severity: float = severity
self.intended_severity: float = intended_severity
def __repr__(self):
return f"WorldSandstorm(is_active={self.is_active}, time_left={self.time_left}, severity={self.severity}, intended_severity={self.intended_severity})"

Some files were not shown because too many files have changed in this diff Show more