1
Fork 0
mirror of https://github.com/Steffo99/lihzahrd.git synced 2024-10-16 06:27:29 +00:00

Update docs for the final time

This commit is contained in:
Steffo 2020-06-10 19:50:23 +02:00
parent b7be04ba6a
commit c4e1937673
Signed by: steffo
GPG key ID: 896A80F55F7C97F0
66 changed files with 49766 additions and 11636 deletions

Binary file not shown.

Binary file not shown.

BIN
docs/doctrees/enums.doctree Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
docs/doctrees/items.doctree Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View file

@ -1,4 +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: 58c76448432ab7a46d14fc2944a74115
config: b7c40531115169d3a84cf4fcc3966200
tags: 645f666f9bcd5a90fca523b33c5a78b7

View file

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

View file

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

View file

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

View file

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

View file

@ -9,8 +9,12 @@ Type annotations are missing for some reason, maybe ``autodoc`` doesn't support
:maxdepth: 2
world
bestiary
chests
enums
header
items
journeypowers
npcs
pressureplates
signs

View file

@ -6,7 +6,7 @@ Usage guide
Prerequisites
------------------------------------
To use ``lihzahrd``, you need Python 3.7 or higher.
To use ``lihzahrd``, you need Python 3.6 or higher.
That's it! No other packages are required!
@ -15,7 +15,7 @@ Installing
You can download (or update) the package with ``pip`` by entering in your terminal: ::
python3.7 -m pip install --upgrade lihzahrd
python3.8 -m pip install --upgrade lihzahrd
Opening a world
------------------------------------

View file

@ -5,7 +5,6 @@ var DOCUMENTATION_OPTIONS = {
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

View file

@ -251,7 +251,6 @@ var Search = {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
var requestUrl = "";
var linkUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
// dirhtml builder
var dirname = item[0] + '/';
@ -261,15 +260,13 @@ var Search = {
dirname = '';
}
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
}
listItem.append($('<a/>').attr('href',
linkUrl +
requestUrl +
highlightstring + item[2]).html(item[1]));
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));

249
docs/html/bestiary.html Normal file
View file

@ -0,0 +1,249 @@
<!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.bestiary &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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script 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="stylesheet" href="_static/lihzahrd.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.chests" href="chests.html" />
<link rel="prev" 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="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"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.bestiary</a><ul class="simple">
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l2"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l2"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l2"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li>
<li class="toctree-l2"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
</ul>
</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><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.bestiary</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/bestiary.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-bestiary">
<h1>lihzahrd.bestiary<a class="headerlink" href="#lihzahrd-bestiary" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.bestiary"></span><dl class="class">
<dt id="lihzahrd.bestiary.Bestiary">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.bestiary.</code><code class="sig-name descname">Bestiary</code><span class="sig-paren">(</span><em class="sig-param">chats: List[lihzahrd.enums.entitytype.EntityType], kills: Dict[lihzahrd.enums.entitytype.EntityType, int], sightings: List[lihzahrd.enums.entitytype.EntityType]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.bestiary.Bestiary" title="Permalink to this definition"></a></dt>
<dd><p>A bestiary entry.</p>
<dl class="attribute">
<dt id="lihzahrd.bestiary.Bestiary.chats">
<code class="sig-name descname">chats</code><a class="headerlink" href="#lihzahrd.bestiary.Bestiary.chats" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.bestiary.Bestiary.kills">
<code class="sig-name descname">kills</code><a class="headerlink" href="#lihzahrd.bestiary.Bestiary.kills" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.bestiary.Bestiary.sightings">
<code class="sig-name descname">sightings</code><a class="headerlink" href="#lihzahrd.bestiary.Bestiary.sightings" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="chests.html" class="btn btn-neutral float-right" title="lihzahrd.chests" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="world.html" class="btn btn-neutral float-left" title="lihzahrd.World" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, 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>

View file

@ -36,8 +36,8 @@
<link rel="stylesheet" href="_static/lihzahrd.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.World" href="world.html" />
<link rel="next" title="lihzahrd.enums" href="enums.html" />
<link rel="prev" title="lihzahrd.bestiary" href="bestiary.html" />
</head>
<body class="wy-body-for-nav">
@ -85,10 +85,14 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.chests</a><ul class="simple">
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
@ -170,10 +174,25 @@
<h1>lihzahrd.chests<a class="headerlink" href="#lihzahrd-chests" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.chests"></span><dl class="py class">
<span class="target" id="module-lihzahrd.chests"></span><dl class="class">
<dt id="lihzahrd.chests.Chest">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.chests.</code><code class="sig-name descname">Chest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">position</span><span class="p">:</span> <span class="n">lihzahrd.fileutils.coordinates.Coordinates</span></em>, <em class="sig-param"><span class="n">name</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)">str</a></span></em>, <em class="sig-param"><span class="n">contents</span><span class="p">:</span> <span class="n">List<span class="p">[</span>lihzahrd.items.itemstack.ItemStack<span class="p">]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.chests.Chest" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.chests.</code><code class="sig-name descname">Chest</code><span class="sig-paren">(</span><em class="sig-param">position: lihzahrd.fileutils.coordinates.Coordinates, name: str, contents: List[lihzahrd.items.itemstack.ItemStack]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.chests.Chest" title="Permalink to this definition"></a></dt>
<dd><p>A chest with its contents.</p>
<dl class="attribute">
<dt id="lihzahrd.chests.Chest.contents">
<code class="sig-name descname">contents</code><a class="headerlink" href="#lihzahrd.chests.Chest.contents" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.chests.Chest.name">
<code class="sig-name descname">name</code><a class="headerlink" href="#lihzahrd.chests.Chest.name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.chests.Chest.position">
<code class="sig-name descname">position</code><a class="headerlink" href="#lihzahrd.chests.Chest.position" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
@ -186,10 +205,10 @@
<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="enums.html" class="btn btn-neutral float-right" title="lihzahrd.enums" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="world.html" class="btn btn-neutral float-left" title="lihzahrd.World" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="bestiary.html" class="btn btn-neutral float-left" title="lihzahrd.bestiary" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@ -198,7 +217,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

34506
docs/html/enums.html Normal file

File diff suppressed because it is too large Load diff

View file

@ -85,8 +85,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
@ -170,7 +174,7 @@
<h1>lihzahrd.errors<a class="headerlink" href="#lihzahrd-errors" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.errors.InvalidFooterError">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.errors.</code><code class="sig-name descname">InvalidFooterError</code><a class="headerlink" href="#lihzahrd.errors.InvalidFooterError" title="Permalink to this definition"></a></dt>
<dd><p>This exception is raised if the footer contents do not match the expected data.</p>
@ -198,7 +202,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

View file

@ -85,8 +85,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
@ -170,120 +174,224 @@
<h1>lihzahrd.fileutils<a class="headerlink" href="#lihzahrd-fileutils" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.fileutils"></span><dl class="py class">
<span class="target" id="module-lihzahrd.fileutils"></span><dl class="class">
<dt id="lihzahrd.fileutils.FileReader">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">FileReader</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.FileReader" title="Permalink to this definition"></a></dt>
<dd><dl class="py method">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">FileReader</code><span class="sig-paren">(</span><em class="sig-param">file: IO</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.FileReader" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute">
<dt id="lihzahrd.fileutils.FileReader._bitify">
<code class="sig-name descname">_bitify</code><a class="headerlink" href="#lihzahrd.fileutils.FileReader._bitify" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.bits">
<code class="sig-name descname">bits</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; Tuple<span class="p">[</span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">, </span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">, </span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">, </span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">, </span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">, </span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">, </span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">, </span>lihzahrd.fileutils.filereader.FileReader.bool<span class="p">]</span><a class="headerlink" href="#lihzahrd.fileutils.FileReader.bits" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">bits</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; Tuple[lihzahrd.fileutils.filereader.FileReader.bool, lihzahrd.fileutils.filereader.FileReader.bool, lihzahrd.fileutils.filereader.FileReader.bool, lihzahrd.fileutils.filereader.FileReader.bool, lihzahrd.fileutils.filereader.FileReader.bool, lihzahrd.fileutils.filereader.FileReader.bool, lihzahrd.fileutils.filereader.FileReader.bool, lihzahrd.fileutils.filereader.FileReader.bool]<a class="headerlink" href="#lihzahrd.fileutils.FileReader.bits" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.bool">
<code class="sig-name descname">bool</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)">bool</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.bool" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">bool</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#lihzahrd.fileutils.FileReader.bool" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.datetime">
<code class="sig-name descname">datetime</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/datetime.html#datetime.datetime" title="(in Python v3.7)">datetime.datetime</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.datetime" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">datetime</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; datetime.datetime<a class="headerlink" href="#lihzahrd.fileutils.FileReader.datetime" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.double">
<code class="sig-name descname">double</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#float" title="(in Python v3.7)">float</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.double" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">double</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; float<a class="headerlink" href="#lihzahrd.fileutils.FileReader.double" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="attribute">
<dt id="lihzahrd.fileutils.FileReader.file">
<code class="sig-name descname">file</code><a class="headerlink" href="#lihzahrd.fileutils.FileReader.file" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.int1">
<code class="sig-name descname">int1</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.int1" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">int1</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.int1" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.int2">
<code class="sig-name descname">int2</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.int2" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">int2</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.int2" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.int4">
<code class="sig-name descname">int4</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.int4" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">int4</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.int4" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.int8">
<code class="sig-name descname">int8</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.int8" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">int8</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.int8" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.read_until">
<code class="sig-name descname">read_until</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">address</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#bytearray" title="(in Python v3.7)">bytearray</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.read_until" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">read_until</code><span class="sig-paren">(</span><em class="sig-param">address: int</em><span class="sig-paren">)</span> &#x2192; bytearray<a class="headerlink" href="#lihzahrd.fileutils.FileReader.read_until" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.rect">
<code class="sig-name descname">rect</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; lihzahrd.fileutils.rect.Rect<a class="headerlink" href="#lihzahrd.fileutils.FileReader.rect" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.single">
<code class="sig-name descname">single</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#float" title="(in Python v3.7)">float</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.single" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">single</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; float<a class="headerlink" href="#lihzahrd.fileutils.FileReader.single" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.skip_until">
<code class="sig-name descname">skip_until</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">address</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/constants.html#None" title="(in Python v3.7)">None</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.skip_until" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">skip_until</code><span class="sig-paren">(</span><em class="sig-param">address: int</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#lihzahrd.fileutils.FileReader.skip_until" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.string">
<code class="sig-name descname">string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">size</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)">str</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.string" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">string</code><span class="sig-paren">(</span><em class="sig-param">size=None</em><span class="sig-paren">)</span> &#x2192; str<a class="headerlink" href="#lihzahrd.fileutils.FileReader.string" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.uint1">
<code class="sig-name descname">uint1</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint1" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">uint1</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint1" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.uint2">
<code class="sig-name descname">uint2</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint2" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">uint2</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint2" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.uint4">
<code class="sig-name descname">uint4</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint4" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">uint4</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint4" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.uint8">
<code class="sig-name descname">uint8</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint8" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">uint8</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.uint8" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.uleb128">
<code class="sig-name descname">uleb128</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.uleb128" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">uleb128</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#lihzahrd.fileutils.FileReader.uleb128" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.fileutils.FileReader.uuid">
<code class="sig-name descname">uuid</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <a class="reference external" href="https://docs.python.org/3.7/library/uuid.html#uuid.UUID" title="(in Python v3.7)">uuid.UUID</a><a class="headerlink" href="#lihzahrd.fileutils.FileReader.uuid" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">uuid</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; uuid.UUID<a class="headerlink" href="#lihzahrd.fileutils.FileReader.uuid" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.fileutils.Rect">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">Rect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">left</span></em>, <em class="sig-param"><span class="n">right</span></em>, <em class="sig-param"><span class="n">top</span></em>, <em class="sig-param"><span class="n">bottom</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.Rect" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">Rect</code><span class="sig-paren">(</span><em class="sig-param">left</em>, <em class="sig-param">right</em>, <em class="sig-param">top</em>, <em class="sig-param">bottom</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.Rect" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute">
<dt id="lihzahrd.fileutils.Rect.bottom">
<code class="sig-name descname">bottom</code><a class="headerlink" href="#lihzahrd.fileutils.Rect.bottom" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
<dl class="attribute">
<dt id="lihzahrd.fileutils.Rect.left">
<code class="sig-name descname">left</code><a class="headerlink" href="#lihzahrd.fileutils.Rect.left" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Rect.right">
<code class="sig-name descname">right</code><a class="headerlink" href="#lihzahrd.fileutils.Rect.right" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Rect.top">
<code class="sig-name descname">top</code><a class="headerlink" href="#lihzahrd.fileutils.Rect.top" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="lihzahrd.fileutils.Pointers">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">Pointers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">world_header</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">world_tiles</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">chests</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">signs</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">npcs</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">tile_entities</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">pressure_plates</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">town_manager</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">bestiary</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">journey_powers</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">footer</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="o">*</span><span class="n">unknown</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.Pointers" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">Pointers</code><span class="sig-paren">(</span><em class="sig-param">world_header: int</em>, <em class="sig-param">world_tiles: int</em>, <em class="sig-param">chests: int</em>, <em class="sig-param">signs: int</em>, <em class="sig-param">npcs: int</em>, <em class="sig-param">tile_entities: int</em>, <em class="sig-param">pressure_plates: int</em>, <em class="sig-param">town_manager: int</em>, <em class="sig-param">bestiary: int</em>, <em class="sig-param">journey_powers: int</em>, <em class="sig-param">footer: int</em>, <em class="sig-param">*unknown</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.Pointers" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.bestiary">
<code class="sig-name descname">bestiary</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.bestiary" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.chests">
<code class="sig-name descname">chests</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.chests" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.file_format">
<code class="sig-name descname">file_format</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.file_format" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.footer">
<code class="sig-name descname">footer</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.footer" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.journey_powers">
<code class="sig-name descname">journey_powers</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.journey_powers" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.npcs">
<code class="sig-name descname">npcs</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.npcs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.pressure_plates">
<code class="sig-name descname">pressure_plates</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.pressure_plates" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.signs">
<code class="sig-name descname">signs</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.signs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.tile_entities">
<code class="sig-name descname">tile_entities</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.tile_entities" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.town_manager">
<code class="sig-name descname">town_manager</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.town_manager" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.unknown">
<code class="sig-name descname">unknown</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.unknown" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.world_header">
<code class="sig-name descname">world_header</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.world_header" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Pointers.world_tiles">
<code class="sig-name descname">world_tiles</code><a class="headerlink" href="#lihzahrd.fileutils.Pointers.world_tiles" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="lihzahrd.fileutils.Coordinates">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">Coordinates</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">y</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.Coordinates" title="Permalink to this definition"></a></dt>
<dd><p>A pair of coordinates.</p>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.fileutils.</code><code class="sig-name descname">Coordinates</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.fileutils.Coordinates" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute">
<dt id="lihzahrd.fileutils.Coordinates.x">
<code class="sig-name descname">x</code><a class="headerlink" href="#lihzahrd.fileutils.Coordinates.x" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.fileutils.Coordinates.y">
<code class="sig-name descname">y</code><a class="headerlink" href="#lihzahrd.fileutils.Coordinates.y" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
@ -308,7 +416,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

View file

@ -191,7 +191,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

252
docs/html/items.html Normal file
View file

@ -0,0 +1,252 @@
<!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.items &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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script 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="stylesheet" href="_static/lihzahrd.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.journeypowers" href="journeypowers.html" />
<link rel="prev" title="lihzahrd.header" href="header.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"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.items</a><ul class="simple">
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l2"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l2"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l2"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li>
<li class="toctree-l2"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
</ul>
</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><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.items</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/items.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-items">
<h1>lihzahrd.items<a class="headerlink" href="#lihzahrd-items" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.items"></span><dl class="class">
<dt id="lihzahrd.items.ItemStack">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.items.</code><code class="sig-name descname">ItemStack</code><span class="sig-paren">(</span><em class="sig-param">type_: lihzahrd.enums.itemtype.ItemType</em>, <em class="sig-param">quantity: int = 1</em>, <em class="sig-param">prefix: Optional[lihzahrd.enums.prefixtype.PrefixType] = None</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.items.ItemStack" title="Permalink to this definition"></a></dt>
<dd><p>A stack of a certain item.</p>
<dl class="attribute">
<dt id="lihzahrd.items.ItemStack.prefix">
<code class="sig-name descname">prefix</code><a class="headerlink" href="#lihzahrd.items.ItemStack.prefix" title="Permalink to this definition"></a></dt>
<dd><p>The modifier of the item in this stack. Should be set only when quantity is 1.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.items.ItemStack.quantity">
<code class="sig-name descname">quantity</code><a class="headerlink" href="#lihzahrd.items.ItemStack.quantity" title="Permalink to this definition"></a></dt>
<dd><p>A number from 1 to 999 representing the number of items inside this stack.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.items.ItemStack.type">
<code class="sig-name descname">type</code><a class="headerlink" href="#lihzahrd.items.ItemStack.type" title="Permalink to this definition"></a></dt>
<dd><p>The type of item represented in this stack.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="journeypowers.html" class="btn btn-neutral float-right" title="lihzahrd.journeypowers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="header.html" class="btn btn-neutral float-left" title="lihzahrd.header" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, 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>

View file

@ -0,0 +1,280 @@
<!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.journeypowers &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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script 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="stylesheet" href="_static/lihzahrd.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.npcs" href="npcs.html" />
<link rel="prev" title="lihzahrd.items" href="items.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"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.journeypowers</a><ul class="simple">
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l2"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l2"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l2"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li>
<li class="toctree-l2"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
</ul>
</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><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.journeypowers</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/journeypowers.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-journeypowers">
<h1>lihzahrd.journeypowers<a class="headerlink" href="#lihzahrd-journeypowers" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.journeypowers"></span><dl class="class">
<dt id="lihzahrd.journeypowers.JourneyPowers">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.journeypowers.</code><code class="sig-name descname">JourneyPowers</code><span class="sig-paren">(</span><em class="sig-param">freeze_time: Optional[bool] = None</em>, <em class="sig-param">time_rate: Optional[float] = None</em>, <em class="sig-param">freeze_rain: Optional[bool] = None</em>, <em class="sig-param">freeze_wind: Optional[bool] = None</em>, <em class="sig-param">difficulty: Optional[float] = None</em>, <em class="sig-param">freeze_biome_spread: Optional[bool] = None</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers" title="Permalink to this definition"></a></dt>
<dd><p>Journey mode powers settings. Spawn rate does not appear to be stored in the world.</p>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.difficulty">
<code class="sig-name descname">difficulty</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.difficulty" title="Permalink to this definition"></a></dt>
<dd><p>Enemy difficulty scaling, 0.5x to 3x. Value ranges from 0.0 to 1.0.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.far_placement_range">
<code class="sig-name descname">far_placement_range</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.far_placement_range" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.freeze_biome_spread">
<code class="sig-name descname">freeze_biome_spread</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.freeze_biome_spread" title="Permalink to this definition"></a></dt>
<dd><p>Can evil biomes &amp; the hallow spread.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.freeze_rain">
<code class="sig-name descname">freeze_rain</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.freeze_rain" title="Permalink to this definition"></a></dt>
<dd><p>Can the rain change.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.freeze_time">
<code class="sig-name descname">freeze_time</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.freeze_time" title="Permalink to this definition"></a></dt>
<dd><p>Is time frozen?</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.freeze_wind">
<code class="sig-name descname">freeze_wind</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.freeze_wind" title="Permalink to this definition"></a></dt>
<dd><p>Can the wind speed and direction change.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.god_mode">
<code class="sig-name descname">god_mode</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.god_mode" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.journeypowers.JourneyPowers.time_rate">
<code class="sig-name descname">time_rate</code><a class="headerlink" href="#lihzahrd.journeypowers.JourneyPowers.time_rate" title="Permalink to this definition"></a></dt>
<dd><p>How fast does time go, 1x to 24x. Value ranges from 0.0 to 1.0.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="npcs.html" class="btn btn-neutral float-right" title="lihzahrd.npcs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="items.html" class="btn btn-neutral float-left" title="lihzahrd.items" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, 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>

File diff suppressed because it is too large Load diff

Binary file not shown.

View file

@ -85,8 +85,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.pressureplates</a><ul class="simple">
</ul>
@ -170,11 +174,11 @@
<h1>lihzahrd.pressureplates<a class="headerlink" href="#lihzahrd-pressureplates" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.pressureplates"></span><dl class="py class">
<span class="target" id="module-lihzahrd.pressureplates"></span><dl class="class">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.pressureplates.</code><code class="sig-name descname">WeighedPressurePlate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">position</span><span class="p">:</span> <span class="n">lihzahrd.fileutils.coordinates.Coordinates</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.pressureplates.</code><code class="sig-name descname">WeighedPressurePlate</code><span class="sig-paren">(</span><em class="sig-param">position: lihzahrd.fileutils.coordinates.Coordinates</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate" title="Permalink to this definition"></a></dt>
<dd><p>A single <a class="reference external" href="https://terraria.gamepedia.com/Pressure_Plates">Weighed Pressure Plate</a> placed in the world.</p>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.position">
<code class="sig-name descname">position</code><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate.position" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@ -203,7 +207,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

View file

@ -162,11 +162,21 @@
<td>
<code class="xref">lihzahrd</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="bestiary.html#module-lihzahrd.bestiary"><code class="xref">lihzahrd.bestiary</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="chests.html#module-lihzahrd.chests"><code class="xref">lihzahrd.chests</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="enums.html#module-lihzahrd.enums"><code class="xref">lihzahrd.enums</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
@ -177,6 +187,16 @@
<td>&#160;&#160;&#160;
<a href="header.html#module-lihzahrd.header"><code class="xref">lihzahrd.header</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="items.html#module-lihzahrd.items"><code class="xref">lihzahrd.items</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="journeypowers.html#module-lihzahrd.journeypowers"><code class="xref">lihzahrd.journeypowers</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
@ -225,7 +245,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

View file

@ -85,8 +85,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
@ -171,12 +175,24 @@
<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="bestiary.html">lihzahrd.bestiary</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="enums.html">lihzahrd.enums</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>
<li class="toctree-l1"><a class="reference internal" href="items.html">lihzahrd.items</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a><ul class="simple">
</ul>
</li>
@ -228,7 +244,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

View file

@ -169,7 +169,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

File diff suppressed because one or more lines are too long

View file

@ -85,8 +85,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.signs</a><ul class="simple">
@ -170,16 +174,16 @@
<h1>lihzahrd.signs<a class="headerlink" href="#lihzahrd-signs" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.signs"></span><dl class="py class">
<span class="target" id="module-lihzahrd.signs"></span><dl class="class">
<dt id="lihzahrd.signs.Sign">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.signs.</code><code class="sig-name descname">Sign</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">position</span><span class="p">:</span> <span class="n">lihzahrd.fileutils.coordinates.Coordinates</span></em>, <em class="sig-param"><span class="n">text</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)">str</a></span> <span class="o">=</span> <span class="default_value">''</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.signs.Sign" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.signs.</code><code class="sig-name descname">Sign</code><span class="sig-paren">(</span><em class="sig-param">position: lihzahrd.fileutils.coordinates.Coordinates</em>, <em class="sig-param">text: str = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.signs.Sign" title="Permalink to this definition"></a></dt>
<dd><p>A sign with something written on it.</p>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.signs.Sign.position">
<code class="sig-name descname">position</code><a class="headerlink" href="#lihzahrd.signs.Sign.position" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.signs.Sign.text">
<code class="sig-name descname">text</code><a class="headerlink" href="#lihzahrd.signs.Sign.text" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@ -208,7 +212,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

View file

@ -85,8 +85,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
@ -170,133 +174,133 @@
<h1>lihzahrd.tileentities<a class="headerlink" href="#lihzahrd-tileentities" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.tileentities"></span><dl class="py class">
<span class="target" id="module-lihzahrd.tileentities"></span><dl class="class">
<dt id="lihzahrd.tileentities.TileEntity">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">TileEntity</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id_</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">position</span><span class="p">:</span> <span class="n">lihzahrd.fileutils.coordinates.Coordinates</span></em>, <em class="sig-param"><span class="n">extra</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>lihzahrd.tileentities.targetdummy.TargetDummy<span class="p">, </span>lihzahrd.tileentities.itemframe.ItemFrame<span class="p">, </span>lihzahrd.tileentities.logicsensor.LogicSensor<span class="p">]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.TileEntity" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">TileEntity</code><span class="sig-paren">(</span><em class="sig-param">id_: int, position: lihzahrd.fileutils.coordinates.Coordinates, extra: Union[lihzahrd.tileentities.targetdummy.TargetDummy, lihzahrd.tileentities.itemframe.ItemFrame, lihzahrd.tileentities.logicsensor.LogicSensor]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.TileEntity" title="Permalink to this definition"></a></dt>
<dd><p>A TileEntity, such as a Training Dummy, an Item Frame or a Logic Sensor.</p>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.tileentities.TileEntity.data">
<code class="sig-name descname">data</code><a class="headerlink" href="#lihzahrd.tileentities.TileEntity.data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.tileentities.TileEntity.id">
<code class="sig-name descname">id</code><a class="headerlink" href="#lihzahrd.tileentities.TileEntity.id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.tileentities.TileEntity.position">
<code class="sig-name descname">position</code><a class="headerlink" href="#lihzahrd.tileentities.TileEntity.position" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.ItemFrame">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">ItemFrame</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span><span class="p">:</span> <span class="n">lihzahrd.items.itemstack.ItemStack</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame" title="Permalink to this definition"></a></dt>
<dd><p>An <cite>Item Frame &lt;https://terraria.gamepedia.com/Item_Frame&gt;</cite>.</p>
<dl class="py attribute">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">ItemFrame</code><span class="sig-paren">(</span><em class="sig-param">item: lihzahrd.items.itemstack.ItemStack</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame" title="Permalink to this definition"></a></dt>
<dd><p>An Item Frame (<a class="reference external" href="https://terraria.gamepedia.com/Item_Frame">https://terraria.gamepedia.com/Item_Frame</a>).</p>
<dl class="attribute">
<dt id="lihzahrd.tileentities.ItemFrame.item">
<code class="sig-name descname">item</code><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame.item" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.LogicSensor">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">LogicSensor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">logic_check</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em>, <em class="sig-param"><span class="n">enabled</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)">bool</a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.LogicSensor" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">LogicSensor</code><span class="sig-paren">(</span><em class="sig-param">logic_check: int</em>, <em class="sig-param">enabled: bool</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.LogicSensor" title="Permalink to this definition"></a></dt>
<dd><p>Data pertaining to a Logic Sensor (<a class="reference external" href="https://terraria.gamepedia.com/Sensors">https://terraria.gamepedia.com/Sensors</a>).</p>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.tileentities.LogicSensor.enabled">
<code class="sig-name descname">enabled</code><a class="headerlink" href="#lihzahrd.tileentities.LogicSensor.enabled" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.tileentities.LogicSensor.logic_check">
<code class="sig-name descname">logic_check</code><a class="headerlink" href="#lihzahrd.tileentities.LogicSensor.logic_check" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.TargetDummy">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">TargetDummy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">npc</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#int" title="(in Python v3.7)">int</a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.TargetDummy" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">TargetDummy</code><span class="sig-paren">(</span><em class="sig-param">npc: int</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.TargetDummy" title="Permalink to this definition"></a></dt>
<dd><p>Data pertaining to a Target Dummy (<a class="reference external" href="https://terraria.gamepedia.com/Target_Dummy">https://terraria.gamepedia.com/Target_Dummy</a>)</p>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.ClothingDisplay">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">ClothingDisplay</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearing_items</span><span class="p">:</span> <span class="n">List<span class="p">[</span>lihzahrd.items.itemstack.ItemStack<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">wearing_dyes</span><span class="p">:</span> <span class="n">List<span class="p">[</span>lihzahrd.items.itemstack.ItemStack<span class="p">]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">ClothingDisplay</code><span class="sig-paren">(</span><em class="sig-param">items: List[lihzahrd.items.itemstack.ItemStack], dyes: List[lihzahrd.items.itemstack.ItemStack]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay" title="Permalink to this definition"></a></dt>
<dd><p>Data pertaining to an item to display clothing.</p>
<dl class="py method">
<dl class="attribute">
<dt id="lihzahrd.tileentities.ClothingDisplay.dyes">
<code class="sig-name descname">dyes</code><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay.dyes" title="Permalink to this definition"></a></dt>
<dd><p>What dyes is the display wearing.</p>
</dd></dl>
<dl class="method">
<dt id="lihzahrd.tileentities.ClothingDisplay.dyes_count">
<em class="property">property </em><code class="sig-name descname">dyes_count</code><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay.dyes_count" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="attribute">
<dt id="lihzahrd.tileentities.ClothingDisplay.items">
<code class="sig-name descname">items</code><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay.items" title="Permalink to this definition"></a></dt>
<dd><p>What items is the display wearing.</p>
</dd></dl>
<dl class="method">
<dt id="lihzahrd.tileentities.ClothingDisplay.items_count">
<em class="property">property </em><code class="sig-name descname">items_count</code><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay.items_count" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.tileentities.ClothingDisplay.total_count">
<em class="property">property </em><code class="sig-name descname">total_count</code><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay.total_count" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="lihzahrd.tileentities.ClothingDisplay.wearing_dyes">
<code class="sig-name descname">wearing_dyes</code><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay.wearing_dyes" title="Permalink to this definition"></a></dt>
<dd><p>What dyes is the mannequin wearing.</p>
</dd></dl>
<dl class="py attribute">
<dt id="lihzahrd.tileentities.ClothingDisplay.wearing_items">
<code class="sig-name descname">wearing_items</code><a class="headerlink" href="#lihzahrd.tileentities.ClothingDisplay.wearing_items" title="Permalink to this definition"></a></dt>
<dd><p>What items is the mannequin wearing.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.Mannequin">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">Mannequin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearing_items</span><span class="p">:</span> <span class="n">List<span class="p">[</span>lihzahrd.items.itemstack.ItemStack<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">wearing_dyes</span><span class="p">:</span> <span class="n">List<span class="p">[</span>lihzahrd.items.itemstack.ItemStack<span class="p">]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.Mannequin" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">Mannequin</code><span class="sig-paren">(</span><em class="sig-param">items: List[lihzahrd.items.itemstack.ItemStack], dyes: List[lihzahrd.items.itemstack.ItemStack]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.Mannequin" title="Permalink to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://terraria.gamepedia.com/Mannequin">Mannequin</a>
/ <a class="reference external" href="https://terraria.gamepedia.com/Womannequin">Womannequin</a> containing up to 3 dyed armor pieces and up
to 5 dyed accessories.</p>
<dl class="py attribute">
<dt id="lihzahrd.tileentities.Mannequin.wearing_dyes">
<code class="sig-name descname">wearing_dyes</code><a class="headerlink" href="#lihzahrd.tileentities.Mannequin.wearing_dyes" title="Permalink to this definition"></a></dt>
<dl class="attribute">
<dt id="lihzahrd.tileentities.Mannequin.dyes">
<code class="sig-name descname">dyes</code><a class="headerlink" href="#lihzahrd.tileentities.Mannequin.dyes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="lihzahrd.tileentities.Mannequin.wearing_items">
<code class="sig-name descname">wearing_items</code><a class="headerlink" href="#lihzahrd.tileentities.Mannequin.wearing_items" title="Permalink to this definition"></a></dt>
<dl class="attribute">
<dt id="lihzahrd.tileentities.Mannequin.items">
<code class="sig-name descname">items</code><a class="headerlink" href="#lihzahrd.tileentities.Mannequin.items" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.HatRack">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">HatRack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearing_items</span><span class="p">:</span> <span class="n">List<span class="p">[</span>lihzahrd.items.itemstack.ItemStack<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">wearing_dyes</span><span class="p">:</span> <span class="n">List<span class="p">[</span>lihzahrd.items.itemstack.ItemStack<span class="p">]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.HatRack" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">HatRack</code><span class="sig-paren">(</span><em class="sig-param">items: List[lihzahrd.items.itemstack.ItemStack], dyes: List[lihzahrd.items.itemstack.ItemStack]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.HatRack" title="Permalink to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://terraria.gamepedia.com/Hat_Rack">Hat Rack</a> containing up to 2 dyed helmets.</p>
<dl class="py attribute">
<dt id="lihzahrd.tileentities.HatRack.wearing_dyes">
<code class="sig-name descname">wearing_dyes</code><a class="headerlink" href="#lihzahrd.tileentities.HatRack.wearing_dyes" title="Permalink to this definition"></a></dt>
<dl class="attribute">
<dt id="lihzahrd.tileentities.HatRack.dyes">
<code class="sig-name descname">dyes</code><a class="headerlink" href="#lihzahrd.tileentities.HatRack.dyes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="lihzahrd.tileentities.HatRack.wearing_items">
<code class="sig-name descname">wearing_items</code><a class="headerlink" href="#lihzahrd.tileentities.HatRack.wearing_items" title="Permalink to this definition"></a></dt>
<dl class="attribute">
<dt id="lihzahrd.tileentities.HatRack.items">
<code class="sig-name descname">items</code><a class="headerlink" href="#lihzahrd.tileentities.HatRack.items" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.SingleItemDisplay">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">SingleItemDisplay</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span><span class="p">:</span> <span class="n">lihzahrd.items.itemstack.ItemStack</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.SingleItemDisplay" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">SingleItemDisplay</code><span class="sig-paren">(</span><em class="sig-param">item: lihzahrd.items.itemstack.ItemStack</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.SingleItemDisplay" title="Permalink to this definition"></a></dt>
<dd><p>A display case for a single item, such as a <a class="reference external" href="https://terraria.gamepedia.com/Weapon_Rack">Weapon Rack</a>,
a <cite>Item Frame &lt;https://terraria.gamepedia.com/Item_Frame&gt;</cite> or a <a class="reference external" href="https://terraria.gamepedia.com/Plate">Plate</a>.</p>
<dl class="py attribute">
a <a class="reference external" href="https://terraria.gamepedia.com/Item_Frame">Item Frame</a> or a <a class="reference external" href="https://terraria.gamepedia.com/Plate">Plate</a>.</p>
<dl class="attribute">
<dt id="lihzahrd.tileentities.SingleItemDisplay.item">
<code class="sig-name descname">item</code><a class="headerlink" href="#lihzahrd.tileentities.SingleItemDisplay.item" title="Permalink to this definition"></a></dt>
<dd><p>The item which is on display.</p>
@ -304,28 +308,28 @@ a <cite>Item Frame &lt;https://terraria.gamepedia.com/Item_Frame&gt;</cite> or a
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.Pylon">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">Pylon</code><a class="headerlink" href="#lihzahrd.tileentities.Pylon" title="Permalink to this definition"></a></dt>
<dd><p>Data pertaining to a Pylon (<a class="reference external" href="https://terraria.gamepedia.com/Pylons">https://terraria.gamepedia.com/Pylons</a>)</p>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.Plate">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">Plate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span><span class="p">:</span> <span class="n">lihzahrd.items.itemstack.ItemStack</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.Plate" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">Plate</code><span class="sig-paren">(</span><em class="sig-param">item: lihzahrd.items.itemstack.ItemStack</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.Plate" title="Permalink to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://terraria.gamepedia.com/Plate">Plate</a>.</p>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.tileentities.Plate.item">
<code class="sig-name descname">item</code><a class="headerlink" href="#lihzahrd.tileentities.Plate.item" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="lihzahrd.tileentities.WeaponRack">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">WeaponRack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span><span class="p">:</span> <span class="n">lihzahrd.items.itemstack.ItemStack</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.WeaponRack" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tileentities.</code><code class="sig-name descname">WeaponRack</code><span class="sig-paren">(</span><em class="sig-param">item: lihzahrd.items.itemstack.ItemStack</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.WeaponRack" title="Permalink to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://terraria.gamepedia.com/Weapon_Rack">Weapon Rack</a>.</p>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.tileentities.WeaponRack.item">
<code class="sig-name descname">item</code><a class="headerlink" href="#lihzahrd.tileentities.WeaponRack.item" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@ -354,7 +358,7 @@ a <cite>Item Frame &lt;https://terraria.gamepedia.com/Item_Frame&gt;</cite> or a
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

File diff suppressed because it is too large Load diff

View file

@ -84,8 +84,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
@ -169,21 +173,21 @@
<h1>lihzahrd.timer<a class="headerlink" href="#lihzahrd-timer" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.timer"></span><dl class="py class">
<span class="target" id="module-lihzahrd.timer"></span><dl class="class">
<dt id="lihzahrd.timer.Timer">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.timer.</code><code class="sig-name descname">Timer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)">str</a></span></em>, <em class="sig-param"><span class="n">display</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)">bool</a></span> <span class="o">=</span> <span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.timer.Timer" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.timer.</code><code class="sig-name descname">Timer</code><span class="sig-paren">(</span><em class="sig-param">name: str</em>, <em class="sig-param">display: bool = True</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.timer.Timer" title="Permalink to this definition"></a></dt>
<dd><p>An object to track and print the time required to perform a section of code.</p>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.timer.Timer._result">
<em class="property">property </em><code class="sig-name descname">_result</code><a class="headerlink" href="#lihzahrd.timer.Timer._result" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.timer.Timer.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.timer.Timer.start" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dl class="method">
<dt id="lihzahrd.timer.Timer.stop">
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.timer.Timer.stop" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@ -210,7 +214,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

View file

@ -85,8 +85,12 @@
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="bestiary.html">lihzahrd.bestiary</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2"><a class="reference internal" href="enums.html">lihzahrd.enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l2"><a class="reference internal" href="items.html">lihzahrd.items</a></li>
<li class="toctree-l2"><a class="reference internal" href="journeypowers.html">lihzahrd.journeypowers</a></li>
<li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
@ -170,15 +174,15 @@
<h1>lihzahrd.townmanager<a class="headerlink" href="#lihzahrd-townmanager" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.townmanager"></span><dl class="py class">
<span class="target" id="module-lihzahrd.townmanager"></span><dl class="class">
<dt id="lihzahrd.townmanager.Room">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.townmanager.</code><code class="sig-name descname">Room</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">npc</span><span class="p">:</span> <span class="n">lihzahrd.npcs.npctype.EntityType</span></em>, <em class="sig-param"><span class="n">position</span><span class="p">:</span> <span class="n">lihzahrd.fileutils.coordinates.Coordinates</span></em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.townmanager.Room" title="Permalink to this definition"></a></dt>
<dd><dl class="py attribute">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.townmanager.</code><code class="sig-name descname">Room</code><span class="sig-paren">(</span><em class="sig-param">npc: lihzahrd.enums.entitytype.EntityType</em>, <em class="sig-param">position: lihzahrd.fileutils.coordinates.Coordinates</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.townmanager.Room" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute">
<dt id="lihzahrd.townmanager.Room.npc">
<code class="sig-name descname">npc</code><a class="headerlink" href="#lihzahrd.townmanager.Room.npc" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="lihzahrd.townmanager.Room.position">
<code class="sig-name descname">position</code><a class="headerlink" href="#lihzahrd.townmanager.Room.position" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@ -207,7 +211,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

View file

@ -161,13 +161,13 @@
<h1>Usage guide<a class="headerlink" href="#usage-guide" title="Permalink to this headline"></a></h1>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<p>To use <code class="docutils literal notranslate"><span class="pre">lihzahrd</span></code>, you need Python 3.7 or higher.</p>
<p>To use <code class="docutils literal notranslate"><span class="pre">lihzahrd</span></code>, you need Python 3.6 or higher.</p>
<p>Thats it! No other packages are required!</p>
</div>
<div class="section" id="installing">
<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline"></a></h2>
<p>You can download (or update) the package with <code class="docutils literal notranslate"><span class="pre">pip</span></code> by entering in your terminal:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span><span class="o">.</span><span class="mi">7</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">lihzahrd</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span><span class="o">.</span><span class="mi">8</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">lihzahrd</span>
</pre></div>
</div>
</div>
@ -219,7 +219,7 @@ attribute.</p>
<span class="c1"># &lt;Tile&gt;</span>
</pre></div>
</div>
<p>You can also use <a class="reference internal" href="fileutils.html#lihzahrd.fileutils.Coordinates" title="lihzahrd.fileutils.Coordinates"><code class="xref py py-class docutils literal notranslate"><span class="pre">fileutils.Coordinates</span></code></a> instead of a <a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#tuple" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> to fetch a specific tile:</p>
<p>You can also use <a class="reference internal" href="fileutils.html#lihzahrd.fileutils.Coordinates" title="lihzahrd.fileutils.Coordinates"><code class="xref py py-class docutils literal notranslate"><span class="pre">fileutils.Coordinates</span></code></a> instead of a <a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#tuple" title="(in Python v3.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> to fetch a specific tile:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">world</span><span class="o">.</span><span class="n">tiles</span><span class="p">[</span><span class="n">lihzahrd</span><span class="o">.</span><span class="n">fileutils</span><span class="o">.</span><span class="n">Coordinates</span><span class="p">(</span><span class="mi">2000</span><span class="p">,</span> <span class="mi">1000</span><span class="p">)])</span>
<span class="c1"># &lt;Tile B&gt;</span>
@ -295,7 +295,7 @@ object.</p>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
&copy; Copyright 2020, Stefano Pigozzi
</p>
</div>

File diff suppressed because one or more lines are too long

11
docs_source/bestiary.rst Normal file
View file

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

View file

@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------
project = 'lihzahrd'
copyright = '2019, Stefano Pigozzi'
copyright = '2020, Stefano Pigozzi'
author = 'Stefano Pigozzi'
# -- General configuration ---------------------------------------------------
@ -28,7 +28,7 @@ author = 'Stefano Pigozzi'
# ones.
extensions = ["sphinx.ext.napoleon", "sphinx.ext.intersphinx"]
intersphinx_mapping = {"python": ("https://docs.python.org/3.7", None)}
intersphinx_mapping = {"python": ("https://docs.python.org/3.6", None)}
napoleon_use_param = True

11
docs_source/enums.rst Normal file
View file

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

11
docs_source/items.rst Normal file
View file

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

View file

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

View file

@ -9,8 +9,12 @@ Type annotations are missing for some reason, maybe ``autodoc`` doesn't support
:maxdepth: 2
world
bestiary
chests
enums
header
items
journeypowers
npcs
pressureplates
signs

View file

@ -6,7 +6,7 @@ Usage guide
Prerequisites
------------------------------------
To use ``lihzahrd``, you need Python 3.7 or higher.
To use ``lihzahrd``, you need Python 3.6 or higher.
That's it! No other packages are required!
@ -15,7 +15,7 @@ Installing
You can download (or update) the package with ``pip`` by entering in your terminal: ::
python3.7 -m pip install --upgrade lihzahrd
python3.8 -m pip install --upgrade lihzahrd
Opening a world
------------------------------------

View file

@ -2,20 +2,21 @@ import typing
class Pets:
"""Pet related information"""
"""Information about the Pet Licenses that were activated in the world."""
def __init__(self,
cat: bool,
dog: bool,
bunny: bool):
self.cat: bool = cat
"""Was the `Cat License <https://terraria.gamepedia.com/Cat_License>`_ ever activated?"""
"""Was the Cat License (https://terraria.gamepedia.com/Cat_License) ever activated?"""
self.dog: int = dog
"""Was the `Dog License <https://terraria.gamepedia.com/Dog_License>`_ ever activated?"""
"""Was the Dog License (https://terraria.gamepedia.com/Dog_License) ever activated?"""
self.bunny: float = bunny
"""Was the `Bunny License <https://terraria.gamepedia.com/Bunny_License>`_ ever activated?"""
"""Was the Bunny License (https://terraria.gamepedia.com/Bunny_License) ever activated?"""
def __repr__(self):
return f"{self.__class__.__qualname__}(cat={self.cat}, dog={self.dog}, bunny={self.bunny})"

View file

@ -25,7 +25,7 @@ class NPC(Mob):
"""The coordinates of the home of this NPC, or ``None`` if the NPC is homeless."""
self.variation_index: int = variation_index
"""(Unknown) Possibly the current `Zoologist <https://terraria.gamepedia.com/Zoologist>`_ form?"""
"""(Unknown) Possibly the current Zoologist (https://terraria.gamepedia.com/Zoologist) form?"""
def __repr__(self):
return f"<NPC {repr(self.type)} at {self.position}>"

View file

@ -2,4 +2,4 @@ from .singleitemdisplay import SingleItemDisplay
class ItemFrame(SingleItemDisplay):
"""An `Item Frame <https://terraria.gamepedia.com/Item_Frame>`."""
"""An Item Frame (https://terraria.gamepedia.com/Item_Frame)."""

View file

@ -3,7 +3,8 @@ from ..items.itemstack import ItemStack
class SingleItemDisplay:
"""A display case for a single item, such as a `Weapon Rack <https://terraria.gamepedia.com/Weapon_Rack>`_,
a `Item Frame <https://terraria.gamepedia.com/Item_Frame>` or a `Plate <https://terraria.gamepedia.com/Plate>`_."""
a `Item Frame <https://terraria.gamepedia.com/Item_Frame>`_ or a `Plate <https://terraria.gamepedia.com/Plate>`_.
"""
__slots__ = ("item",)

View file

@ -110,15 +110,15 @@ class World:
"""The world size in tiles."""
self.difficulty: Difficulty = difficulty
"""The `difficulty <https://terraria.gamepedia.com/Difficulty>`_ the game is in."""
"""The difficulty (https://terraria.gamepedia.com/Difficulty) the game is in."""
self.is_drunk_world: bool = is_drunk_world
"""If the world was created with the `5162020 <https://terraria.gamepedia.com/Secret_world_seeds#Drunk_World>_`
"""If the world was created with the 5162020 (https://terraria.gamepedia.com/Secret_world_seeds#Drunk_World)
seed."""
self.is_for_the_worthy: bool = is_for_the_worthy
"""Was this world created with the
`for the worthy <https://terraria.gamepedia.com/Secret_world_seeds#For_the_worthy>` seed."""
"""If the world was created with the
for the worthy (https://terraria.gamepedia.com/Secret_world_seeds#For_the_worthy) seed."""
self.created_on = created_on
"""The date and time this world was created in."""