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

1.0b1

Browse source
This commit is contained in:
Steffo 2019-08-13 19:56:17 +02:00
parent b97cd85766
commit c2bc719aa9
55 changed files with 1739 additions and 818 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -1,9 +1,45 @@
# lihzahrd # ![](https://gamepedia.cursecdn.com/terraria_gamepedia/e/ee/Lihzahrd.png?version=b8e7ea78b2f9f27a46e2e70d5684b344) `lihzahrd` ![](https://img.shields.io/pypi/v/lihzahrd)
A Terraria world parser in Python
## References A Terraria 1.3.5.3 world parser in Python.
- http://seancode.com/terrafirma/world.html
- http://ludwig.schafer.free.fr/ You can use this package to get programmer-friendly data from a Terraria world!
- https://github.com/cokolele/terraria-world-parser/
- https://github.com/TEdit/Terraria-Map-Editor/blob/master/TEditXna/Terraria/World.FileV2.cs Install with:
- https://steamcommunity.com/sharedfiles/filedetails/?id=841032800 ```
pip install lihzahrd
```
## Usage
You can open a world file and get a `World` object by calling:
```
import lihzahrd
world = lihzahrd.World.create_from_file("filename.wld")
```
It _will_ take a while to process: a small Terraria world contains more than 5 million tiles!
Once you have a `World` object, you can use all data present in the save file by accessing [its attributes](http://gh.steffo.eu/lihzahrd/html/world.html).
## Documentation
The documentation is available [here](https://gh.steffo.eu/lihzahrd/html/).
It's a bit messy and incomplete, as I still have not figured out the meaning of some data, and the code is in need of some refactoring.
If you know something that isn't present in the documentation, please let me know [with an issue](https://github.com/Steffo99/lihzahrd/issues/new)!
## References used
- The [TEdit World Parser](https://github.com/TEdit/Terraria-Map-Editor/blob/master/TEditXna/Terraria/World.FileV2.cs), the most accurate source currently available.
- The [tModLoader wiki](https://github.com/tModLoader/tModLoader/wiki), containing lists of all possible IDs.
- The [Terrafirma world documentation](http://seancode.com/terrafirma/world.html), accurate for old worlds (version <69)
- The [1.3.x.x world documentation](http://ludwig.schafer.free.fr/), a bit incomplete, but an useful source nevertheless.
- A [JS World Parser](https://github.com/cokolele/terraria-world-parser/) on GitHub.
- A [Background Guide](https://steamcommunity.com/sharedfiles/filedetails/?id=841032800) on Steam that displays all possible world backgrounds.
## License
`lihzard` is licensed under the [AGPL 3.0](/LICENSE.txt).
That means you have to publish under the same license the source code of any program you create that uses `lihzahrd`.

BIN
docs/doctrees/environment.pickle
View file

Binary file not shown.

BIN
docs/doctrees/header.doctree
View file

Binary file not shown.

BIN
docs/doctrees/index.doctree
View file

Binary file not shown.

BIN
docs/doctrees/pressureplates.doctree
View file

Binary file not shown.

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

Binary file not shown.

BIN
docs/doctrees/tileentities.doctree
View file

Binary file not shown.

BIN
docs/doctrees/tiles.doctree
View file

Binary file not shown.

BIN
docs/doctrees/townmanager.doctree
View file

Binary file not shown.

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

Binary file not shown.

BIN
docs/doctrees/world.doctree
View file

Binary file not shown.

BIN
docs/html/_images/lihzahrd.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 853 B

36
docs/html/_sources/index.rst.txt
View file

@ -1,25 +1,31 @@
lihzahrd lihzahrd
==================================== ====================================
.. toctree:: .. image:: lihzahrd.png
:maxdepth: 2 :width: 32px
:height: 48px
:alt: A Lihzahrd from the Jungle Temple
chests ``lihzahrd`` is a Terraria 1.3.5.3 world parser in Python.
fileutils
header
npcs
pressureplates
signs
tileentities
tiles
timer
townmanager
world
errors
You can use this package to get programmer-friendly data from a Terraria world!
Some useful links Documentation pages
------------------------------------ ------------------------------------
Find out more on how to use ``lihzahrd`` in these pages:
.. toctree::
:maxdepth: 1
usage
reference
Some more links
------------------------------------
Here are some links that may be useful:
* `Lihzahrd on GitHub <https://github.com/Steffo99/lihzahrd>`_ * `Lihzahrd on GitHub <https://github.com/Steffo99/lihzahrd>`_
* :ref:`genindex` * :ref:`genindex`

22
docs/html/_sources/reference.rst.txt Normal file
View file

@ -0,0 +1,22 @@
API Reference
====================================
Here are the pages autogenerated from the docstrings inside the Python library code.
Type annotations are missing for some reason, maybe ``autodoc`` doesn't support them yet?
.. toctree::
:maxdepth: 2
world
chests
header
npcs
pressureplates
signs
tileentities
tiles
townmanager
errors
fileutils
timer

122
docs/html/_sources/usage.rst.txt Normal file
View file

@ -0,0 +1,122 @@
.. currentmodule:: lihzahrd
Usage guide
====================================
Prerequisites
------------------------------------
To use ``lihzahrd``, you need Python 3.7 or higher.
That's it! No other packages are required!
Installing
------------------------------------
You can download (or update) the package with ``pip`` by entering in your terminal: ::
python3.7 -m pip install --upgrade lihzahrd
Opening a world
------------------------------------
To open a Terraria world file named ``terra.wld`` located in the current working directory, you should import the
:py:mod:`lihzahrd` package and then call the :py:meth:`World.create_from_file` function: ::
import lihzahrd
world = lihzahrd.World.create_from_file("terra.wld")
It should take **up to a few minutes**, depending on the size of the world, and then return a
:py:class:`World` object.
Accessing the world properties
------------------------------------
Most of the world properties are accessible directly as attributes of the :py:class:`World` object: ::
print(world.name)
# "Terra"
print(world.is_hardmode)
# False
print(world.spawn_point)
# Coordinates(2101, 246)
Some world properties may be grouped in other objects: ::
print(world.bosses_defeated)
# <BossesDefeated>
print(world.bosses_defeated.eye_of_cthulhu)
# False
You can look at the :py:class:`World` class documentation or use an IDE that supports type annotations
(such as `PyCharm <https://www.jetbrains.com/pycharm/>`_) to find all available attributes.
Accessing the tile data
------------------------------------
All :py:class:`tiles.Tile` are stored in the :py:class:`tiles.TileMatrix` accessible at the :py:attr:`World.tiles`
attribute. ::
print(world.tiles)
# <TileMatrix 4200x1200>
You can access them by using the ``tiles`` attribute as a two-dimensional array, where (0, 0) is the top-left block: ::
print(world.tiles[0, 0])
# <Tile >
You can also use :py:class:`fileutils.Coordinates` instead of a :py:class:`tuple` to fetch a specific tile: ::
print(world.tiles[lihzahrd.fileutils.Coordinates(2000, 1000)])
# <Tile B>
print(world.tiles[world.spawn_point])
# <Tile B>
Counting tiles from the bottom-right is possible too: ::
print(world.tiles[-1, -1])
# <Tile >
A single :py:class:`tiles.Tile` has five attributes that you can access:
* :py:attr:`tiles.Tile.block`, the foreground :py:class:`tiles.Block`;
* :py:attr:`tiles.Tile.wall`, the background :py:class:`tiles.Wall`;
* :py:attr:`tiles.Tile.liquid`, the :py:class:`tiles.Liquid` present in that tile;
* :py:attr:`tiles.Tile.wiring`, the colored wires and actuators (:py:class:`tiles.Wiring`);
* :py:attr:`tiles.Tile.extra`, additional data about the block present at that tile, such as the contents of a chest.
All of these attributes may be :py:const:`None` if the property isn't applicable for the tile:
for example, :py:attr:`tiles.Tile.block` is :py:const:`None` if there is no block ("air") placed there.
Accessing extra data
------------------------------------
Extra data, such as the content of chests or the text of signs, may be accessed in two different ways:
* Through the :py:attr:`tiles.Tile.extra` attribute: ::
print(world.tiles[2893, 1074].extra)
# <Chest '' at 2893, 1074>
* Through the various lists available in the :py:class:`World` class, such as :py:attr:`World.chests`: ::
print(world.chests[0])
# <Chest '' at 2893, 1074>
Both ways return the same object, but one may be faster than the other, depending on your use case: ::
print(world.tiles[2893, 1074].extra is world.chests[0])
# True
Something else
------------------------------------
All information included in a Terraria savefile is parsed in this package and made available in the :py:class:`World`
object.
If you couldn't find what you needed in this short usage guide, check the API Reference or have a look at the
`source code <https://github.com/Steffo99/lihzahrd/tree/master/lihzahrd>`_ !

1
docs/html/_sources/world.rst.txt
View file

@ -7,5 +7,4 @@ lihzahrd.World
.. autoclass:: lihzahrd.World .. autoclass:: lihzahrd.World
:members: :members:
:private-members:
:undoc-members: :undoc-members:

3
docs/html/_static/lihzahrd.css Normal file
View file

@ -0,0 +1,3 @@
.wy-side-nav-search {
background-color:#7FA23E !important;
}

39
docs/html/chests.html
View file

@ -33,10 +33,11 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.fileutils" href="fileutils.html" /> <link rel="next" title="lihzahrd.header" href="header.html" />
<link rel="prev" title="lihzahrd" href="index.html" /> <link rel="prev" title="lihzahrd.World" href="world.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.chests</a><ul class="simple"> <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.chests</a><ul class="simple">
</ul>
</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="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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.chests</li> <li>lihzahrd.chests</li>
@ -20105,10 +20112,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="fileutils.html" class="btn btn-neutral float-right" title="lihzahrd.fileutils" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="header.html" class="btn btn-neutral float-right" title="lihzahrd.header" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="lihzahrd" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <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> </div>

38
docs/html/errors.html
View file

@ -33,9 +33,11 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="prev" title="lihzahrd.World" href="world.html" /> <link rel="next" title="lihzahrd.fileutils" href="fileutils.html" />
<link rel="prev" title="lihzahrd.townmanager" href="townmanager.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -80,18 +82,22 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li> <li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li> <li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li> <li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li> <li class="toctree-l2"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li> <li class="toctree-l2"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li> <li class="toctree-l2"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.errors</a><ul class="simple"> <li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.errors</a><ul class="simple">
</ul>
</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> </ul>
</li> </li>
</ul> </ul>
@ -139,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.errors</li> <li>lihzahrd.errors</li>
@ -178,8 +186,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="fileutils.html" class="btn btn-neutral float-right" title="lihzahrd.fileutils" 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="townmanager.html" class="btn btn-neutral float-left" title="lihzahrd.townmanager" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>

39
docs/html/fileutils.html
View file

@ -33,10 +33,11 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.header" href="header.html" /> <link rel="next" title="lihzahrd.timer" href="timer.html" />
<link rel="prev" title="lihzahrd.chests" href="chests.html" /> <link rel="prev" title="lihzahrd.errors" href="errors.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <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="#">lihzahrd.fileutils</a><ul class="simple"> <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="chests.html">lihzahrd.chests</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="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 current"><a class="current reference internal" href="#">lihzahrd.fileutils</a><ul class="simple">
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.fileutils</li> <li>lihzahrd.fileutils</li>
@ -284,10 +291,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <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="timer.html" class="btn btn-neutral float-right" title="lihzahrd.timer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="chests.html" class="btn btn-neutral float-left" title="lihzahrd.chests" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="errors.html" class="btn btn-neutral float-left" title="lihzahrd.errors" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>

69
docs/html/genindex.html
View file

@ -34,6 +34,7 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/lihzahrd.css" type="text/css" />
<link rel="index" title="Index" href="#" /> <link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
</head> </head>
@ -80,18 +81,8 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -190,14 +181,10 @@
<h2 id="_">_</h2> <h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="tiles.html#lihzahrd.tiles.TileMatrix.__getitem__">__getitem__() (lihzahrd.tiles.TileMatrix method)</a> <li><a href="timer.html#lihzahrd.timer.Timer._result">_result() (lihzahrd.timer.Timer property)</a>
</li>
<li><a href="world.html#lihzahrd.World._read_tile_block">_read_tile_block() (lihzahrd.World static method)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="timer.html#lihzahrd.timer.Timer._result">_result() (lihzahrd.timer.Timer property)</a>
</li>
<li><a href="header.html#lihzahrd.header.Version._version_ids">_version_ids (lihzahrd.header.Version attribute)</a> <li><a href="header.html#lihzahrd.header.Version._version_ids">_version_ids (lihzahrd.header.Version attribute)</a>
</li> </li>
</ul></td> </ul></td>
@ -3442,8 +3429,6 @@
<h2 id="E">E</h2> <h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="tileentities.html#lihzahrd.tileentities.ItemFrame.e">e (lihzahrd.tileentities.ItemFrame attribute)</a>
</li>
<li><a href="chests.html#lihzahrd.chests.ItemType.EATER_MASK">EATER_MASK (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.EATER_MASK">EATER_MASK (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.EATER_OF_PLANKTON">EATER_OF_PLANKTON (lihzahrd.header.AnglerQuestFish attribute)</a> <li><a href="header.html#lihzahrd.header.AnglerQuestFish.EATER_OF_PLANKTON">EATER_OF_PLANKTON (lihzahrd.header.AnglerQuestFish attribute)</a>
@ -5584,12 +5569,6 @@
<h2 id="I">I</h2> <h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pressureplates.html#lihzahrd.pressureplates.WeighedPressurePlate.i">i (lihzahrd.pressureplates.WeighedPressurePlate attribute)</a>
<ul>
<li><a href="tileentities.html#lihzahrd.tileentities.ItemFrame.i">(lihzahrd.tileentities.ItemFrame attribute)</a>
</li>
</ul></li>
<li><a href="npcs.html#lihzahrd.npcs.EntityType.ICE_BAT">ICE_BAT (lihzahrd.npcs.EntityType attribute)</a> <li><a href="npcs.html#lihzahrd.npcs.EntityType.ICE_BAT">ICE_BAT (lihzahrd.npcs.EntityType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.ICE_BAT_BANNER">ICE_BAT_BANNER (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.ICE_BAT_BANNER">ICE_BAT_BANNER (lihzahrd.chests.ItemType attribute)</a>
@ -5692,10 +5671,12 @@
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.ICY_WATER_FOUNTAIN">ICY_WATER_FOUNTAIN (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.ICY_WATER_FOUNTAIN">ICY_WATER_FOUNTAIN (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="tileentities.html#lihzahrd.tileentities.TileEntity.id">id (lihzahrd.tileentities.TileEntity attribute)</a> <li><a href="header.html#lihzahrd.header.Version.id">id (lihzahrd.header.Version attribute)</a>
<ul> <ul>
<li><a href="world.html#lihzahrd.World.id">(lihzahrd.World attribute)</a> <li><a href="world.html#lihzahrd.World.id">(lihzahrd.World attribute)</a>
</li>
<li><a href="tileentities.html#lihzahrd.tileentities.TileEntity.id">(lihzahrd.tileentities.TileEntity attribute)</a>
</li> </li>
</ul></li> </ul></li>
<li><a href="chests.html#lihzahrd.chests.ItemType.ILLEGAL_GUN_PARTS">ILLEGAL_GUN_PARTS (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.ILLEGAL_GUN_PARTS">ILLEGAL_GUN_PARTS (lihzahrd.chests.ItemType attribute)</a>
@ -6670,8 +6651,6 @@
<h2 id="M">M</h2> <h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="tileentities.html#lihzahrd.tileentities.ItemFrame.m">m (lihzahrd.tileentities.ItemFrame attribute)</a>
</li>
<li><a href="chests.html#lihzahrd.chests.ItemType.MAGIC_CUFFS">MAGIC_CUFFS (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.MAGIC_CUFFS">MAGIC_CUFFS (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.MAGIC_DAGGER">MAGIC_DAGGER (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.MAGIC_DAGGER">MAGIC_DAGGER (lihzahrd.chests.ItemType attribute)</a>
@ -7084,10 +7063,10 @@
<li><a href="header.html#lihzahrd.header.AnglerQuestFish.MIRAGE_FISH">(lihzahrd.header.AnglerQuestFish attribute)</a> <li><a href="header.html#lihzahrd.header.AnglerQuestFish.MIRAGE_FISH">(lihzahrd.header.AnglerQuestFish attribute)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="npcs.html#lihzahrd.npcs.EntityType.MISASSEMBLED_SKELETON">MISASSEMBLED_SKELETON (lihzahrd.npcs.EntityType attribute)</a> <li><a href="npcs.html#lihzahrd.npcs.EntityType.MISASSEMBLED_SKELETON">MISASSEMBLED_SKELETON (lihzahrd.npcs.EntityType attribute)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="npcs.html#lihzahrd.npcs.EntityType.MISTER_STABBY">MISTER_STABBY (lihzahrd.npcs.EntityType attribute)</a> <li><a href="npcs.html#lihzahrd.npcs.EntityType.MISTER_STABBY">MISTER_STABBY (lihzahrd.npcs.EntityType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.MISTER_STABBY_BANNER">MISTER_STABBY_BANNER (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.MISTER_STABBY_BANNER">MISTER_STABBY_BANNER (lihzahrd.chests.ItemType attribute)</a>
@ -7510,8 +7489,6 @@
<h2 id="N">N</h2> <h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pressureplates.html#lihzahrd.pressureplates.WeighedPressurePlate.n">n (lihzahrd.pressureplates.WeighedPressurePlate attribute)</a>
</li>
<li><a href="chests.html#lihzahrd.chests.ItemType.NAIL">NAIL (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.NAIL">NAIL (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.NAIL_GUN">NAIL_GUN (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.NAIL_GUN">NAIL_GUN (lihzahrd.chests.ItemType attribute)</a>
@ -7598,10 +7575,10 @@
</li> </li>
<li><a href="npcs.html#lihzahrd.npcs.EntityType.NECROMANCER_ARMORED">NECROMANCER_ARMORED (lihzahrd.npcs.EntityType attribute)</a> <li><a href="npcs.html#lihzahrd.npcs.EntityType.NECROMANCER_ARMORED">NECROMANCER_ARMORED (lihzahrd.npcs.EntityType attribute)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="chests.html#lihzahrd.chests.ItemType.NECROMANCER_BANNER">NECROMANCER_BANNER (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.NECROMANCER_BANNER">NECROMANCER_BANNER (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="chests.html#lihzahrd.chests.ItemType.NECROMANTIC_SCROLL">NECROMANTIC_SCROLL (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.NECROMANTIC_SCROLL">NECROMANTIC_SCROLL (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.NECROMANTIC_SIGN">NECROMANTIC_SIGN (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.NECROMANTIC_SIGN">NECROMANTIC_SIGN (lihzahrd.chests.ItemType attribute)</a>
@ -7667,6 +7644,8 @@
<li><a href="header.html#lihzahrd.header.HardmodeTier3Ore.NOT_DETERMINED_TOO">NOT_DETERMINED_TOO (lihzahrd.header.HardmodeTier3Ore attribute)</a> <li><a href="header.html#lihzahrd.header.HardmodeTier3Ore.NOT_DETERMINED_TOO">NOT_DETERMINED_TOO (lihzahrd.header.HardmodeTier3Ore attribute)</a>
</li> </li>
<li><a href="npcs.html#lihzahrd.npcs.NPC">NPC (class in lihzahrd.npcs)</a> <li><a href="npcs.html#lihzahrd.npcs.NPC">NPC (class in lihzahrd.npcs)</a>
</li>
<li><a href="townmanager.html#lihzahrd.townmanager.Room.npc">npc (lihzahrd.townmanager.Room attribute)</a>
</li> </li>
<li><a href="world.html#lihzahrd.World.npcs">npcs (lihzahrd.World attribute)</a> <li><a href="world.html#lihzahrd.World.npcs">npcs (lihzahrd.World attribute)</a>
</li> </li>
@ -7696,8 +7675,6 @@
<h2 id="O">O</h2> <h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pressureplates.html#lihzahrd.pressureplates.WeighedPressurePlate.o">o (lihzahrd.pressureplates.WeighedPressurePlate attribute)</a>
</li>
<li><a href="chests.html#lihzahrd.chests.ItemType.OBELISK">OBELISK (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.OBELISK">OBELISK (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.OBSIDIAN">OBSIDIAN (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.OBSIDIAN">OBSIDIAN (lihzahrd.chests.ItemType attribute)</a>
@ -7878,8 +7855,6 @@
<h2 id="P">P</h2> <h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pressureplates.html#lihzahrd.pressureplates.WeighedPressurePlate.p">p (lihzahrd.pressureplates.WeighedPressurePlate attribute)</a>
</li>
<li><a href="chests.html#lihzahrd.chests.ItemType.PAD_THAI">PAD_THAI (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.PAD_THAI">PAD_THAI (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="tiles.html#lihzahrd.tiles.Block.paint">paint (lihzahrd.tiles.Block attribute)</a> <li><a href="tiles.html#lihzahrd.tiles.Block.paint">paint (lihzahrd.tiles.Block attribute)</a>
@ -8358,10 +8333,10 @@
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.PINK_ESKIMO_COAT">PINK_ESKIMO_COAT (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.PINK_ESKIMO_COAT">PINK_ESKIMO_COAT (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="chests.html#lihzahrd.chests.ItemType.PINK_ESKIMO_HOOD">PINK_ESKIMO_HOOD (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.PINK_ESKIMO_HOOD">PINK_ESKIMO_HOOD (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="chests.html#lihzahrd.chests.ItemType.PINK_ESKIMO_PANTS">PINK_ESKIMO_PANTS (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.PINK_ESKIMO_PANTS">PINK_ESKIMO_PANTS (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.PINK_GEL">PINK_GEL (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.PINK_GEL">PINK_GEL (lihzahrd.chests.ItemType attribute)</a>
@ -8618,6 +8593,8 @@
<li><a href="signs.html#lihzahrd.signs.Sign.position">(lihzahrd.signs.Sign attribute)</a> <li><a href="signs.html#lihzahrd.signs.Sign.position">(lihzahrd.signs.Sign attribute)</a>
</li> </li>
<li><a href="tileentities.html#lihzahrd.tileentities.TileEntity.position">(lihzahrd.tileentities.TileEntity attribute)</a> <li><a href="tileentities.html#lihzahrd.tileentities.TileEntity.position">(lihzahrd.tileentities.TileEntity attribute)</a>
</li>
<li><a href="townmanager.html#lihzahrd.townmanager.Room.position">(lihzahrd.townmanager.Room attribute)</a>
</li> </li>
</ul></li> </ul></li>
<li><a href="npcs.html#lihzahrd.npcs.EntityType.POSSESSED_ARMOR">POSSESSED_ARMOR (lihzahrd.npcs.EntityType attribute)</a> <li><a href="npcs.html#lihzahrd.npcs.EntityType.POSSESSED_ARMOR">POSSESSED_ARMOR (lihzahrd.npcs.EntityType attribute)</a>
@ -9316,8 +9293,6 @@
<h2 id="S">S</h2> <h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pressureplates.html#lihzahrd.pressureplates.WeighedPressurePlate.s">s (lihzahrd.pressureplates.WeighedPressurePlate attribute)</a>
</li>
<li><a href="chests.html#lihzahrd.chests.ItemType.SAFE">SAFE (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.SAFE">SAFE (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="tiles.html#lihzahrd.tiles.BlockType.SAFES">SAFES (lihzahrd.tiles.BlockType attribute)</a> <li><a href="tiles.html#lihzahrd.tiles.BlockType.SAFES">SAFES (lihzahrd.tiles.BlockType attribute)</a>
@ -10978,12 +10953,6 @@
<h2 id="T">T</h2> <h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pressureplates.html#lihzahrd.pressureplates.WeighedPressurePlate.t">t (lihzahrd.pressureplates.WeighedPressurePlate attribute)</a>
<ul>
<li><a href="tileentities.html#lihzahrd.tileentities.ItemFrame.t">(lihzahrd.tileentities.ItemFrame attribute)</a>
</li>
</ul></li>
<li><a href="chests.html#lihzahrd.chests.ItemType.TABI">TABI (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.TABI">TABI (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="tiles.html#lihzahrd.tiles.BlockType.TABLES">TABLES (lihzahrd.tiles.BlockType attribute)</a> <li><a href="tiles.html#lihzahrd.tiles.BlockType.TABLES">TABLES (lihzahrd.tiles.BlockType attribute)</a>
@ -11324,10 +11293,10 @@
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.TIN_CHAINMAIL">TIN_CHAINMAIL (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.TIN_CHAINMAIL">TIN_CHAINMAIL (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="chests.html#lihzahrd.chests.ItemType.TIN_CHANDELIER">TIN_CHANDELIER (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.TIN_CHANDELIER">TIN_CHANDELIER (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="chests.html#lihzahrd.chests.ItemType.TIN_GREAVES">TIN_GREAVES (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.TIN_GREAVES">TIN_GREAVES (lihzahrd.chests.ItemType attribute)</a>
</li> </li>
<li><a href="chests.html#lihzahrd.chests.ItemType.TIN_HAMMER">TIN_HAMMER (lihzahrd.chests.ItemType attribute)</a> <li><a href="chests.html#lihzahrd.chests.ItemType.TIN_HAMMER">TIN_HAMMER (lihzahrd.chests.ItemType attribute)</a>

40
docs/html/header.html
View file

@ -33,10 +33,11 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.npcs" href="npcs.html" /> <link rel="next" title="lihzahrd.npcs" href="npcs.html" />
<link rel="prev" title="lihzahrd.fileutils" href="fileutils.html" /> <link rel="prev" title="lihzahrd.chests" href="chests.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.header</a><ul class="simple"> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.header</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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.header</li> <li>lihzahrd.header</li>
@ -893,6 +900,11 @@
<code class="sig-name descname">_version_ids</code><em class="property"> = {71: '1.2.0.3.1', 77: '1.2.2', 104: '1.2.3', 140: '1.3.0.1', 151: '1.3.0.4', 153: '1.3.0.5', 154: '1.3.0.6', 155: '1.3.0.7', 156: '1.3.0.8', 170: '1.3.2', 174: '1.3.3', 178: '1.3.4', 194: '1.3.5.3'}</em><a class="headerlink" href="#lihzahrd.header.Version._version_ids" title="Permalink to this definition"></a></dt> <code class="sig-name descname">_version_ids</code><em class="property"> = {71: '1.2.0.3.1', 77: '1.2.2', 104: '1.2.3', 140: '1.3.0.1', 151: '1.3.0.4', 153: '1.3.0.5', 154: '1.3.0.6', 155: '1.3.0.7', 156: '1.3.0.8', 170: '1.3.2', 174: '1.3.3', 178: '1.3.4', 194: '1.3.5.3'}</em><a class="headerlink" href="#lihzahrd.header.Version._version_ids" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.header.Version.id">
<code class="sig-name descname">id</code><a class="headerlink" href="#lihzahrd.header.Version.id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method"> <dl class="method">
<dt id="lihzahrd.header.Version.name"> <dt id="lihzahrd.header.Version.name">
<em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#lihzahrd.header.Version.name" title="Permalink to this definition"></a></dt> <em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#lihzahrd.header.Version.name" title="Permalink to this definition"></a></dt>
@ -929,7 +941,7 @@
<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="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="fileutils.html" class="btn btn-neutral float-left" title="lihzahrd.fileutils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="chests.html" class="btn btn-neutral float-left" title="lihzahrd.chests" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>

69
docs/html/index.html
View file

@ -33,9 +33,10 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.chests" href="chests.html" /> <link rel="next" title="Usage guide" href="usage.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -80,18 +81,8 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -158,48 +149,22 @@
<div class="section" id="lihzahrd"> <div class="section" id="lihzahrd">
<h1>lihzahrd<a class="headerlink" href="#lihzahrd" title="Permalink to this headline"></a></h1> <h1>lihzahrd<a class="headerlink" href="#lihzahrd" title="Permalink to this headline"></a></h1>
<a class="reference internal image-reference" href="_images/lihzahrd.png"><img alt="A Lihzahrd from the Jungle Temple" src="_images/lihzahrd.png" style="width: 32px; height: 48px;" /></a>
<p><code class="docutils literal notranslate"><span class="pre">lihzahrd</span></code> is a Terraria 1.3.5.3 world parser in Python.</p>
<p>You can use this package to get programmer-friendly data from a Terraria world!</p>
<div class="section" id="documentation-pages">
<h2>Documentation pages<a class="headerlink" href="#documentation-pages" title="Permalink to this headline"></a></h2>
<p>Find out more on how to use <code class="docutils literal notranslate"><span class="pre">lihzahrd</span></code> in these pages:</p>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a><ul class="simple"> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
</ul> <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
</li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</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="npcs.html">lihzahrd.npcs</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a><ul class="simple">
</ul>
</li>
<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="errors.html">lihzahrd.errors</a><ul class="simple">
</ul>
</li>
</ul> </ul>
</div> </div>
<div class="section" id="some-useful-links"> </div>
<h2>Some useful links<a class="headerlink" href="#some-useful-links" title="Permalink to this headline"></a></h2> <div class="section" id="some-more-links">
<h2>Some more links<a class="headerlink" href="#some-more-links" title="Permalink to this headline"></a></h2>
<p>Here are some links that may be useful:</p>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/Steffo99/lihzahrd">Lihzahrd on GitHub</a></p></li> <li><p><a class="reference external" href="https://github.com/Steffo99/lihzahrd">Lihzahrd on GitHub</a></p></li>
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
@ -215,7 +180,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <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="usage.html" class="btn btn-neutral float-right" title="Usage guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div> </div>

31
docs/html/npcs.html
View file

@ -33,6 +33,7 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.pressureplates" href="pressureplates.html" /> <link rel="next" title="lihzahrd.pressureplates" href="pressureplates.html" />
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.npcs</a><ul class="simple"> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</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.npcs</a><ul class="simple">
</ul>
</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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.npcs</li> <li>lihzahrd.npcs</li>

BIN
docs/html/objects.inv
View file

Binary file not shown.

63
docs/html/pressureplates.html
View file

@ -33,6 +33,7 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.signs" href="signs.html" /> <link rel="next" title="lihzahrd.signs" href="signs.html" />
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.pressureplates</a><ul class="simple"> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</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>
</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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.pressureplates</li> <li>lihzahrd.pressureplates</li>
@ -166,42 +173,12 @@
<span class="target" id="module-lihzahrd.pressureplates"></span><dl class="class"> <span class="target" id="module-lihzahrd.pressureplates"></span><dl class="class">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate"> <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">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> <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 pressure plate placed in the world.</p> <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="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.i">
<code class="sig-name descname">i</code><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate.i" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.n">
<code class="sig-name descname">n</code><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate.n" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.o">
<code class="sig-name descname">o</code><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate.o" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.p">
<code class="sig-name descname">p</code><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate.p" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute"> <dl class="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.position"> <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> <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> <dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.s">
<code class="sig-name descname">s</code><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate.s" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.pressureplates.WeighedPressurePlate.t">
<code class="sig-name descname">t</code><a class="headerlink" href="#lihzahrd.pressureplates.WeighedPressurePlate.t" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl> </dd></dl>
</div> </div>

15
docs/html/py-modindex.html
View file

@ -33,6 +33,7 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
@ -82,18 +83,8 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>

260
docs/html/reference.html Normal file
View file

@ -0,0 +1,260 @@
<!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>API Reference &mdash; lihzahrd documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="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.World" href="world.html" />
<link rel="prev" title="Usage guide" href="usage.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="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="chests.html">lihzahrd.chests</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="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>API Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/reference.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="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h1>
<p>Here are the pages autogenerated from the docstrings inside the Python library code.</p>
<p>Type annotations are missing for some reason, maybe <code class="docutils literal notranslate"><span class="pre">autodoc</span></code> doesn’t support them yet?</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</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="npcs.html">lihzahrd.npcs</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a><ul class="simple">
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="world.html" class="btn btn-neutral float-right" title="lihzahrd.World" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="usage.html" class="btn btn-neutral float-left" title="Usage guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

15
docs/html/search.html
View file

@ -34,6 +34,7 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" /> <link rel="search" title="Search" href="#" />
</head> </head>
@ -80,18 +81,8 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>

2
docs/html/searchindex.js
View file

File diff suppressed because one or more lines are too long

31
docs/html/signs.html
View file

@ -33,6 +33,7 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.tileentities" href="tileentities.html" /> <link rel="next" title="lihzahrd.tileentities" href="tileentities.html" />
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.signs</a><ul class="simple"> <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">
</ul>
</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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.signs</li> <li>lihzahrd.signs</li>

52
docs/html/tileentities.html
View file

@ -33,6 +33,7 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.tiles" href="tiles.html" /> <link rel="next" title="lihzahrd.tiles" href="tiles.html" />
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li> <li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.tileentities</a><ul class="simple"> <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 current"><a class="current reference internal" href="#">lihzahrd.tileentities</a><ul class="simple">
</ul>
</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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.tileentities</li> <li>lihzahrd.tileentities</li>
@ -187,31 +194,12 @@
<dl class="class"> <dl class="class">
<dt id="lihzahrd.tileentities.ItemFrame"> <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">item: lihzahrd.chests.itemstack.ItemStack</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame" 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">ItemFrame</code><span class="sig-paren">(</span><em class="sig-param">item: lihzahrd.chests.itemstack.ItemStack</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute"> <dd><p>Data pertaining to an <a class="reference external" href="https://terraria.gamepedia.com/Item_Frame">https://terraria.gamepedia.com/Item_Frame</a> .</p>
<dt id="lihzahrd.tileentities.ItemFrame.e">
<code class="sig-name descname">e</code><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame.e" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.tileentities.ItemFrame.i">
<code class="sig-name descname">i</code><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame.i" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute"> <dl class="attribute">
<dt id="lihzahrd.tileentities.ItemFrame.item"> <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> <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></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.tileentities.ItemFrame.m">
<code class="sig-name descname">m</code><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame.m" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="lihzahrd.tileentities.ItemFrame.t">
<code class="sig-name descname">t</code><a class="headerlink" href="#lihzahrd.tileentities.ItemFrame.t" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl> </dd></dl>
<dl class="class"> <dl class="class">

49
docs/html/tiles.html
View file

@ -33,9 +33,10 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.timer" href="timer.html" /> <link rel="next" title="lihzahrd.townmanager" href="townmanager.html" />
<link rel="prev" title="lihzahrd.tileentities" href="tileentities.html" /> <link rel="prev" title="lihzahrd.tileentities" href="tileentities.html" />
</head> </head>
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li> <li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li> <li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.tiles</a><ul class="simple"> <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 current"><a class="current reference internal" href="#">lihzahrd.tiles</a><ul class="simple">
</ul>
</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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.tiles</li> <li>lihzahrd.tiles</li>
@ -3912,7 +3919,7 @@ the save file.</p>
<dl class="class"> <dl class="class">
<dt id="lihzahrd.tiles.Tile"> <dt id="lihzahrd.tiles.Tile">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tiles.</code><code class="sig-name descname">Tile</code><span class="sig-paren">(</span><em class="sig-param">block: Optional[lihzahrd.tiles.block.Block] = None</em>, <em class="sig-param">wall: Optional[lihzahrd.tiles.wall.Wall] = None</em>, <em class="sig-param">liquid: Optional[lihzahrd.tiles.liquid.Liquid] = None</em>, <em class="sig-param">wiring: Optional[lihzahrd.tiles.wiring.Wiring] = None</em>, <em class="sig-param">extra: Optional[lihzahrd.chests.chest.Chest] = None</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Tile" title="Permalink to this definition"></a></dt> <em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tiles.</code><code class="sig-name descname">Tile</code><span class="sig-paren">(</span><em class="sig-param">block: Optional[lihzahrd.tiles.block.Block] = None</em>, <em class="sig-param">wall: Optional[lihzahrd.tiles.wall.Wall] = None</em>, <em class="sig-param">liquid: Optional[lihzahrd.tiles.liquid.Liquid] = None</em>, <em class="sig-param">wiring: Optional[lihzahrd.tiles.wiring.Wiring] = None</em>, <em class="sig-param">extra: Union[lihzahrd.chests.chest.Chest</em>, <em class="sig-param">lihzahrd.signs.sign.Sign</em>, <em class="sig-param">lihzahrd.pressureplates.weighedpressureplate.WeighedPressurePlate</em>, <em class="sig-param">lihzahrd.tileentities.tileentity.TileEntity</em>, <em class="sig-param">None] = None</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Tile" title="Permalink to this definition"></a></dt>
<dd><p>A tile, composed by a block, a wall, a liquid and wires.</p> <dd><p>A tile, composed by a block, a wall, a liquid and wires.</p>
<dl class="attribute"> <dl class="attribute">
<dt id="lihzahrd.tiles.Tile.block"> <dt id="lihzahrd.tiles.Tile.block">
@ -3922,7 +3929,8 @@ the save file.</p>
<dl class="attribute"> <dl class="attribute">
<dt id="lihzahrd.tiles.Tile.extra"> <dt id="lihzahrd.tiles.Tile.extra">
<code class="sig-name descname">extra</code><a class="headerlink" href="#lihzahrd.tiles.Tile.extra" title="Permalink to this definition"></a></dt> <code class="sig-name descname">extra</code><a class="headerlink" href="#lihzahrd.tiles.Tile.extra" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd><p>A reference to the extra data of this tile, such as Chest or Sign data.</p>
</dd></dl>
<dl class="attribute"> <dl class="attribute">
<dt id="lihzahrd.tiles.Tile.liquid"> <dt id="lihzahrd.tiles.Tile.liquid">
@ -3945,15 +3953,6 @@ the save file.</p>
<dt id="lihzahrd.tiles.TileMatrix"> <dt id="lihzahrd.tiles.TileMatrix">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tiles.</code><code class="sig-name descname">TileMatrix</code><a class="headerlink" href="#lihzahrd.tiles.TileMatrix" title="Permalink to this definition"></a></dt> <em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tiles.</code><code class="sig-name descname">TileMatrix</code><a class="headerlink" href="#lihzahrd.tiles.TileMatrix" title="Permalink to this definition"></a></dt>
<dd><p>A huge matrix containing the tiles of a whole world.</p> <dd><p>A huge matrix containing the tiles of a whole world.</p>
<dl class="method">
<dt id="lihzahrd.tiles.TileMatrix.__getitem__">
<code class="sig-name descname">__getitem__</code><span class="sig-paren">(</span><em class="sig-param">item: Union[Tuple, lihzahrd.fileutils.coordinates.Coordinates]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.TileMatrix.__getitem__" title="Permalink to this definition"></a></dt>
<dd><p>Get a tile at specific coordinates.</p>
<p>(x=0, y=0) returns the top-left tile in the map.</p>
<p>You can specify a negative coordinate to count tiles respectively from the right or from the bottom:
(x=-1, y=-1) returns the bottom-right tile in the map.</p>
</dd></dl>
<dl class="method"> <dl class="method">
<dt id="lihzahrd.tiles.TileMatrix.add_column"> <dt id="lihzahrd.tiles.TileMatrix.add_column">
<code class="sig-name descname">add_column</code><span class="sig-paren">(</span><em class="sig-param">column: List[lihzahrd.tiles.tile.Tile]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.TileMatrix.add_column" title="Permalink to this definition"></a></dt> <code class="sig-name descname">add_column</code><span class="sig-paren">(</span><em class="sig-param">column: List[lihzahrd.tiles.tile.Tile]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.TileMatrix.add_column" title="Permalink to this definition"></a></dt>
@ -3978,7 +3977,7 @@ the save file.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="timer.html" class="btn btn-neutral float-right" title="lihzahrd.timer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="townmanager.html" class="btn btn-neutral float-right" title="lihzahrd.townmanager" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="tileentities.html" class="btn btn-neutral float-left" title="lihzahrd.tileentities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="tileentities.html" class="btn btn-neutral float-left" title="lihzahrd.tileentities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

38
docs/html/timer.html
View file

@ -33,10 +33,10 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.townmanager" href="townmanager.html" /> <link rel="prev" title="lihzahrd.fileutils" href="fileutils.html" />
<link rel="prev" title="lihzahrd.tiles" href="tiles.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -81,20 +81,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li> <li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li> <li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li> <li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.timer</a><ul class="simple"> <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 current"><a class="current reference internal" href="#">lihzahrd.timer</a><ul class="simple">
</ul>
</li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +144,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.timer</li> <li>lihzahrd.timer</li>
@ -194,10 +200,8 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="townmanager.html" class="btn btn-neutral float-right" title="lihzahrd.townmanager" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="fileutils.html" class="btn btn-neutral float-left" title="lihzahrd.fileutils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="tiles.html" class="btn btn-neutral float-left" title="lihzahrd.tiles" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>

49
docs/html/townmanager.html
View file

@ -33,10 +33,11 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.World" href="world.html" /> <link rel="next" title="lihzahrd.errors" href="errors.html" />
<link rel="prev" title="lihzahrd.timer" href="timer.html" /> <link rel="prev" title="lihzahrd.tiles" href="tiles.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li> <li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li> <li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li> <li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li> <li class="toctree-l2"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.townmanager</a><ul class="simple"> <li class="toctree-l2"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.townmanager</a><ul class="simple">
</ul>
</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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.townmanager</li> <li>lihzahrd.townmanager</li>
@ -166,8 +173,18 @@
<span class="target" id="module-lihzahrd.townmanager"></span><dl class="class"> <span class="target" id="module-lihzahrd.townmanager"></span><dl class="class">
<dt id="lihzahrd.townmanager.Room"> <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">npc: lihzahrd.npcs.npctype.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> <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.npcs.npctype.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> <dd></dd></dl>
<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>
</dd></dl>
</div> </div>
@ -178,10 +195,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="world.html" class="btn btn-neutral float-right" title="lihzahrd.World" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="errors.html" class="btn btn-neutral float-right" title="lihzahrd.errors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="timer.html" class="btn btn-neutral float-left" title="lihzahrd.timer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="tiles.html" class="btn btn-neutral float-left" title="lihzahrd.tiles" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>

327
docs/html/usage.html Normal file
View file

@ -0,0 +1,327 @@
<!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>Usage guide &mdash; lihzahrd documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="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="API Reference" href="reference.html" />
<link rel="prev" title="lihzahrd" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> lihzahrd
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Usage guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installing">Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#opening-a-world">Opening a world</a></li>
<li class="toctree-l2"><a class="reference internal" href="#accessing-the-world-properties">Accessing the world properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="#accessing-the-tile-data">Accessing the tile data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#accessing-extra-data">Accessing extra data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#something-else">Something else</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">lihzahrd</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Usage guide</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/usage.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="usage-guide">
<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>That’s 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>
</pre></div>
</div>
</div>
<div class="section" id="opening-a-world">
<h2>Opening a world<a class="headerlink" href="#opening-a-world" title="Permalink to this headline"></a></h2>
<p>To open a Terraria world file named <code class="docutils literal notranslate"><span class="pre">terra.wld</span></code> located in the current working directory, you should import the
<code class="xref py py-mod docutils literal notranslate"><span class="pre">lihzahrd</span></code> package and then call the <a class="reference internal" href="world.html#lihzahrd.World.create_from_file" title="lihzahrd.World.create_from_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">World.create_from_file()</span></code></a> function:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">lihzahrd</span>
<span class="n">world</span> <span class="o">=</span> <span class="n">lihzahrd</span><span class="o">.</span><span class="n">World</span><span class="o">.</span><span class="n">create_from_file</span><span class="p">(</span><span class="s2">&quot;terra.wld&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>It should take <strong>up to a few minutes</strong>, depending on the size of the world, and then return a
<a class="reference internal" href="world.html#lihzahrd.World" title="lihzahrd.World"><code class="xref py py-class docutils literal notranslate"><span class="pre">World</span></code></a> object.</p>
</div>
<div class="section" id="accessing-the-world-properties">
<h2>Accessing the world properties<a class="headerlink" href="#accessing-the-world-properties" title="Permalink to this headline"></a></h2>
<p>Most of the world properties are accessible directly as attributes of the <a class="reference internal" href="world.html#lihzahrd.World" title="lihzahrd.World"><code class="xref py py-class docutils literal notranslate"><span class="pre">World</span></code></a> object:</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">name</span><span class="p">)</span>
<span class="c1"># &quot;Terra&quot;</span>
<span class="nb">print</span><span class="p">(</span><span class="n">world</span><span class="o">.</span><span class="n">is_hardmode</span><span class="p">)</span>
<span class="c1"># False</span>
<span class="nb">print</span><span class="p">(</span><span class="n">world</span><span class="o">.</span><span class="n">spawn_point</span><span class="p">)</span>
<span class="c1"># Coordinates(2101, 246)</span>
</pre></div>
</div>
<p>Some world properties may be grouped in other objects:</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">bosses_defeated</span><span class="p">)</span>
<span class="c1"># &lt;BossesDefeated&gt;</span>
<span class="nb">print</span><span class="p">(</span><span class="n">world</span><span class="o">.</span><span class="n">bosses_defeated</span><span class="o">.</span><span class="n">eye_of_cthulhu</span><span class="p">)</span>
<span class="c1"># False</span>
</pre></div>
</div>
<p>You can look at the <a class="reference internal" href="world.html#lihzahrd.World" title="lihzahrd.World"><code class="xref py py-class docutils literal notranslate"><span class="pre">World</span></code></a> class documentation or use an IDE that supports type annotations
(such as <a class="reference external" href="https://www.jetbrains.com/pycharm/">PyCharm</a>) to find all available attributes.</p>
</div>
<div class="section" id="accessing-the-tile-data">
<h2>Accessing the tile data<a class="headerlink" href="#accessing-the-tile-data" title="Permalink to this headline"></a></h2>
<p>All <a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile" title="lihzahrd.tiles.Tile"><code class="xref py py-class docutils literal notranslate"><span class="pre">tiles.Tile</span></code></a> are stored in the <a class="reference internal" href="tiles.html#lihzahrd.tiles.TileMatrix" title="lihzahrd.tiles.TileMatrix"><code class="xref py py-class docutils literal notranslate"><span class="pre">tiles.TileMatrix</span></code></a> accessible at the <a class="reference internal" href="world.html#lihzahrd.World.tiles" title="lihzahrd.World.tiles"><code class="xref py py-attr docutils literal notranslate"><span class="pre">World.tiles</span></code></a>
attribute.</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="c1"># &lt;TileMatrix 4200x1200&gt;</span>
</pre></div>
</div>
<p>You can access them by using the <code class="docutils literal notranslate"><span class="pre">tiles</span></code> attribute as a two-dimensional array, where (0, 0) is the top-left block:</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="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">])</span>
<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>
<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>
<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">world</span><span class="o">.</span><span class="n">spawn_point</span><span class="p">])</span>
<span class="c1"># &lt;Tile B&gt;</span>
</pre></div>
</div>
<p>Counting tiles from the bottom-right is possible too:</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="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="c1"># &lt;Tile &gt;</span>
</pre></div>
</div>
<p>A single <a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile" title="lihzahrd.tiles.Tile"><code class="xref py py-class docutils literal notranslate"><span class="pre">tiles.Tile</span></code></a> has five attributes that you can access:</p>
<ul class="simple">
<li><p><a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile.block" title="lihzahrd.tiles.Tile.block"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tiles.Tile.block</span></code></a>, the foreground <a class="reference internal" href="tiles.html#lihzahrd.tiles.Block" title="lihzahrd.tiles.Block"><code class="xref py py-class docutils literal notranslate"><span class="pre">tiles.Block</span></code></a>;</p></li>
<li><p><a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile.wall" title="lihzahrd.tiles.Tile.wall"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tiles.Tile.wall</span></code></a>, the background <a class="reference internal" href="tiles.html#lihzahrd.tiles.Wall" title="lihzahrd.tiles.Wall"><code class="xref py py-class docutils literal notranslate"><span class="pre">tiles.Wall</span></code></a>;</p></li>
<li><p><a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile.liquid" title="lihzahrd.tiles.Tile.liquid"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tiles.Tile.liquid</span></code></a>, the <a class="reference internal" href="tiles.html#lihzahrd.tiles.Liquid" title="lihzahrd.tiles.Liquid"><code class="xref py py-class docutils literal notranslate"><span class="pre">tiles.Liquid</span></code></a> present in that tile;</p></li>
<li><p><a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile.wiring" title="lihzahrd.tiles.Tile.wiring"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tiles.Tile.wiring</span></code></a>, the colored wires and actuators (<a class="reference internal" href="tiles.html#lihzahrd.tiles.Wiring" title="lihzahrd.tiles.Wiring"><code class="xref py py-class docutils literal notranslate"><span class="pre">tiles.Wiring</span></code></a>);</p></li>
<li><p><a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile.extra" title="lihzahrd.tiles.Tile.extra"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tiles.Tile.extra</span></code></a>, additional data about the block present at that tile, such as the contents of a chest.</p></li>
</ul>
<p>All of these attributes may be <code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code> if the property isn’t applicable for the tile:
for example, <a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile.block" title="lihzahrd.tiles.Tile.block"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tiles.Tile.block</span></code></a> is <code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code> if there is no block (“air”) placed there.</p>
</div>
<div class="section" id="accessing-extra-data">
<h2>Accessing extra data<a class="headerlink" href="#accessing-extra-data" title="Permalink to this headline"></a></h2>
<p>Extra data, such as the content of chests or the text of signs, may be accessed in two different ways:</p>
<ul>
<li><p>Through the <a class="reference internal" href="tiles.html#lihzahrd.tiles.Tile.extra" title="lihzahrd.tiles.Tile.extra"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tiles.Tile.extra</span></code></a> attribute:</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="mi">2893</span><span class="p">,</span> <span class="mi">1074</span><span class="p">]</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
<span class="c1"># &lt;Chest &#39;&#39; at 2893, 1074&gt;</span>
</pre></div>
</div>
</li>
<li><p>Through the various lists available in the <a class="reference internal" href="world.html#lihzahrd.World" title="lihzahrd.World"><code class="xref py py-class docutils literal notranslate"><span class="pre">World</span></code></a> class, such as <a class="reference internal" href="world.html#lihzahrd.World.chests" title="lihzahrd.World.chests"><code class="xref py py-attr docutils literal notranslate"><span class="pre">World.chests</span></code></a>:</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">chests</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="c1"># &lt;Chest &#39;&#39; at 2893, 1074&gt;</span>
</pre></div>
</div>
</li>
</ul>
<p>Both ways return the same object, but one may be faster than the other, depending on your use case:</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="mi">2893</span><span class="p">,</span> <span class="mi">1074</span><span class="p">]</span><span class="o">.</span><span class="n">extra</span> <span class="ow">is</span> <span class="n">world</span><span class="o">.</span><span class="n">chests</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="c1"># True</span>
</pre></div>
</div>
</div>
<div class="section" id="something-else">
<h2>Something else<a class="headerlink" href="#something-else" title="Permalink to this headline"></a></h2>
<p>All information included in a Terraria savefile is parsed in this package and made available in the <a class="reference internal" href="world.html#lihzahrd.World" title="lihzahrd.World"><code class="xref py py-class docutils literal notranslate"><span class="pre">World</span></code></a>
object.</p>
<p>If you couldn’t find what you needed in this short usage guide, check the API Reference or have a look at the
<a class="reference external" href="https://github.com/Steffo99/lihzahrd/tree/master/lihzahrd">source code</a> !</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="reference.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="lihzahrd" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Stefano Pigozzi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

58
docs/html/world.html
View file

@ -33,10 +33,11 @@
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <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/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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.errors" href="errors.html" /> <link rel="next" title="lihzahrd.chests" href="chests.html" />
<link rel="prev" title="lihzahrd.townmanager" href="townmanager.html" /> <link rel="prev" title="API Reference" href="reference.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -81,20 +82,24 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="fileutils.html">lihzahrd.fileutils</a></li> <li class="toctree-l1 current"><a class="reference internal" href="reference.html">API Reference</a><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">lihzahrd.World</a><ul class="simple">
<li class="toctree-l1"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li> </ul>
<li class="toctree-l1"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li> </li>
<li class="toctree-l1"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li> <li class="toctree-l2"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
<li class="toctree-l1"><a class="reference internal" href="tileentities.html">lihzahrd.tileentities</a></li> <li class="toctree-l2"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.tiles</a></li> <li class="toctree-l2"><a class="reference internal" href="npcs.html">lihzahrd.npcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="timer.html">lihzahrd.timer</a></li> <li class="toctree-l2"><a class="reference internal" href="pressureplates.html">lihzahrd.pressureplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="townmanager.html">lihzahrd.townmanager</a></li> <li class="toctree-l2"><a class="reference internal" href="signs.html">lihzahrd.signs</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.World</a><ul class="simple"> <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> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">lihzahrd.errors</a></li>
</ul> </ul>
@ -140,6 +145,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="reference.html">API Reference</a> &raquo;</li>
<li>lihzahrd.World</li> <li>lihzahrd.World</li>
@ -167,11 +174,6 @@
<dt id="lihzahrd.World"> <dt id="lihzahrd.World">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.</code><code class="sig-name descname">World</code><span class="sig-paren">(</span><em class="sig-param">version: lihzahrd.header.version.Version, savefile_type: int, revision: int, is_favorite: bool, name: str, generator: lihzahrd.header.generatorinfo.GeneratorInfo, uuid_: uuid.UUID, id_: int, bounds: lihzahrd.fileutils.rect.Rect, size: lihzahrd.fileutils.coordinates.Coordinates, is_expert: bool, created_on, styles: lihzahrd.header.styles.Styles, backgrounds: lihzahrd.header.backgrounds.Backgrounds, spawn_point: lihzahrd.fileutils.coordinates.Coordinates, underground_level: float, cavern_level: float, time: lihzahrd.header.time.Time, events: lihzahrd.header.events.Events, dungeon_point: lihzahrd.fileutils.coordinates.Coordinates, world_evil: lihzahrd.header.worldeviltype.WorldEvilType, saved_npcs: lihzahrd.header.savednpcs.SavedNPCs, altars_smashed: lihzahrd.header.altarssmashed.AltarsSmashed, is_hardmode: bool, shadow_orbs: lihzahrd.header.shadoworbs.ShadowOrbs, bosses_defeated: lihzahrd.header.bossesdefeated.BossesDefeated, anglers_quest: lihzahrd.header.anglerquest.AnglerQuest, clouds: lihzahrd.header.clouds.Clouds, cultist_delay: int, tiles: lihzahrd.tiles.tilematrix.TileMatrix, chests: List[lihzahrd.chests.chest.Chest], signs: List[lihzahrd.signs.sign.Sign], npcs: List[lihzahrd.npcs.npc.NPC], mobs: List[lihzahrd.npcs.mob.Mob], tile_entities: List[lihzahrd.tileentities.tileentity.TileEntity], weighed_pressure_plates: List[lihzahrd.pressureplates.weighedpressureplate.WeighedPressurePlate], rooms: List[lihzahrd.townmanager.room.Room], unknown_file_format_data: bytes = b'', unknown_world_header_data: bytes = b'', unknown_world_tiles_data: bytes = b'', unknown_chests_data: bytes = b'', unknown_signs_data: bytes = b'', unknown_npcs_data: bytes = b'', unknown_tile_entities_data: bytes = b'', unknown_pressure_plates_data: bytes = b'', unknown_town_manager_data: bytes = b''</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World" title="Permalink to this definition"></a></dt> <em class="property">class </em><code class="sig-prename descclassname">lihzahrd.</code><code class="sig-name descname">World</code><span class="sig-paren">(</span><em class="sig-param">version: lihzahrd.header.version.Version, savefile_type: int, revision: int, is_favorite: bool, name: str, generator: lihzahrd.header.generatorinfo.GeneratorInfo, uuid_: uuid.UUID, id_: int, bounds: lihzahrd.fileutils.rect.Rect, size: lihzahrd.fileutils.coordinates.Coordinates, is_expert: bool, created_on, styles: lihzahrd.header.styles.Styles, backgrounds: lihzahrd.header.backgrounds.Backgrounds, spawn_point: lihzahrd.fileutils.coordinates.Coordinates, underground_level: float, cavern_level: float, time: lihzahrd.header.time.Time, events: lihzahrd.header.events.Events, dungeon_point: lihzahrd.fileutils.coordinates.Coordinates, world_evil: lihzahrd.header.worldeviltype.WorldEvilType, saved_npcs: lihzahrd.header.savednpcs.SavedNPCs, altars_smashed: lihzahrd.header.altarssmashed.AltarsSmashed, is_hardmode: bool, shadow_orbs: lihzahrd.header.shadoworbs.ShadowOrbs, bosses_defeated: lihzahrd.header.bossesdefeated.BossesDefeated, anglers_quest: lihzahrd.header.anglerquest.AnglerQuest, clouds: lihzahrd.header.clouds.Clouds, cultist_delay: int, tiles: lihzahrd.tiles.tilematrix.TileMatrix, chests: List[lihzahrd.chests.chest.Chest], signs: List[lihzahrd.signs.sign.Sign], npcs: List[lihzahrd.npcs.npc.NPC], mobs: List[lihzahrd.npcs.mob.Mob], tile_entities: List[lihzahrd.tileentities.tileentity.TileEntity], weighed_pressure_plates: List[lihzahrd.pressureplates.weighedpressureplate.WeighedPressurePlate], rooms: List[lihzahrd.townmanager.room.Room], unknown_file_format_data: bytes = b'', unknown_world_header_data: bytes = b'', unknown_world_tiles_data: bytes = b'', unknown_chests_data: bytes = b'', unknown_signs_data: bytes = b'', unknown_npcs_data: bytes = b'', unknown_tile_entities_data: bytes = b'', unknown_pressure_plates_data: bytes = b'', unknown_town_manager_data: bytes = b''</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World" title="Permalink to this definition"></a></dt>
<dd><p>The Python representation of a Terraria world.</p> <dd><p>The Python representation of a Terraria world.</p>
<dl class="method">
<dt id="lihzahrd.World._read_tile_block">
<em class="property">static </em><code class="sig-name descname">_read_tile_block</code><span class="sig-paren">(</span><em class="sig-param">fr: lihzahrd.fileutils.filereader.FileReader</em>, <em class="sig-param">tileframeimportant</em><span class="sig-paren">)</span> &#x2192; List<a class="headerlink" href="#lihzahrd.World._read_tile_block" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute"> <dl class="attribute">
<dt id="lihzahrd.World.altars_smashed"> <dt id="lihzahrd.World.altars_smashed">
<code class="sig-name descname">altars_smashed</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.altars_smashed" title="Permalink to this definition"></a></dt> <code class="sig-name descname">altars_smashed</code><em class="property"> = None</em><a class="headerlink" href="#lihzahrd.World.altars_smashed" title="Permalink to this definition"></a></dt>
@ -216,8 +218,17 @@
<dl class="method"> <dl class="method">
<dt id="lihzahrd.World.create_from_file"> <dt id="lihzahrd.World.create_from_file">
<em class="property">classmethod </em><code class="sig-name descname">create_from_file</code><span class="sig-paren">(</span><em class="sig-param">file</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World.create_from_file" title="Permalink to this definition"></a></dt> <em class="property">classmethod </em><code class="sig-name descname">create_from_file</code><span class="sig-paren">(</span><em class="sig-param">filename: str</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World.create_from_file" title="Permalink to this definition"></a></dt>
<dd><p>Create a World object from a .wld file.</p> <dd><p>Create a World object from a .wld file.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Parsing an entire world may take up to a few minutes and quite a bit of memory!</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filename</strong> – The name of the file that should be parsed.</p>
</dd>
</dl>
</dd></dl> </dd></dl>
<dl class="attribute"> <dl class="attribute">
@ -229,7 +240,8 @@
<dl class="method"> <dl class="method">
<dt id="lihzahrd.World.crimson_hearts"> <dt id="lihzahrd.World.crimson_hearts">
<em class="property">property </em><code class="sig-name descname">crimson_hearts</code><a class="headerlink" href="#lihzahrd.World.crimson_hearts" title="Permalink to this definition"></a></dt> <em class="property">property </em><code class="sig-name descname">crimson_hearts</code><a class="headerlink" href="#lihzahrd.World.crimson_hearts" title="Permalink to this definition"></a></dt>
<dd></dd></dl> <dd><p>Information related to the Shadow Orbs or Crimson Hearts in the world.</p>
</dd></dl>
<dl class="attribute"> <dl class="attribute">
<dt id="lihzahrd.World.dungeon_point"> <dt id="lihzahrd.World.dungeon_point">
@ -399,10 +411,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="errors.html" class="btn btn-neutral float-right" title="lihzahrd.errors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <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="townmanager.html" class="btn btn-neutral float-left" title="lihzahrd.townmanager" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="reference.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>

3
docs_source/_static/lihzahrd.css Normal file
View file

@ -0,0 +1,3 @@
.wy-side-nav-search {
background-color:#7FA23E !important;
}

4
docs_source/conf.py
View file

@ -26,7 +26,7 @@ author = 'Stefano Pigozzi'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.intersphinx"] 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.7", None)}
napoleon_use_param = True napoleon_use_param = True
@ -39,7 +39,7 @@ def skip(app, what, name: str, obj, would_skip, options):
def setup(app): def setup(app):
app.connect("autodoc-skip-member", skip) app.add_stylesheet('lihzahrd.css')
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

36
docs_source/index.rst
View file

@ -1,25 +1,31 @@
lihzahrd lihzahrd
==================================== ====================================
.. toctree:: .. image:: lihzahrd.png
:maxdepth: 2 :width: 32px
:height: 48px
:alt: A Lihzahrd from the Jungle Temple
chests ``lihzahrd`` is a Terraria 1.3.5.3 world parser in Python.
fileutils
header
npcs
pressureplates
signs
tileentities
tiles
timer
townmanager
world
errors
You can use this package to get programmer-friendly data from a Terraria world!
Some useful links Documentation pages
------------------------------------ ------------------------------------
Find out more on how to use ``lihzahrd`` in these pages:
.. toctree::
:maxdepth: 1
usage
reference
Some more links
------------------------------------
Here are some links that may be useful:
* `Lihzahrd on GitHub <https://github.com/Steffo99/lihzahrd>`_ * `Lihzahrd on GitHub <https://github.com/Steffo99/lihzahrd>`_
* :ref:`genindex` * :ref:`genindex`

BIN
docs_source/lihzahrd.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 853 B

5
docs_source/make.bat
View file

@ -8,7 +8,7 @@ if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build set SPHINXBUILD=sphinx-build
) )
set SOURCEDIR=. set SOURCEDIR=.
set BUILDDIR=../docs set BUILDDIR=..\docs
if "%1" == "" goto help if "%1" == "" goto help
@ -25,6 +25,9 @@ if errorlevel 9009 (
exit /b 1 exit /b 1
) )
del /f /q /s ..\docs\html\*.*
del /f /q /s ..\docs\doctrees\*.*
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end goto end

22
docs_source/reference.rst Normal file
View file

@ -0,0 +1,22 @@
API Reference
====================================
Here are the pages autogenerated from the docstrings inside the Python library code.
Type annotations are missing for some reason, maybe ``autodoc`` doesn't support them yet?
.. toctree::
:maxdepth: 2
world
chests
header
npcs
pressureplates
signs
tileentities
tiles
townmanager
errors
fileutils
timer

122
docs_source/usage.rst Normal file
View file

@ -0,0 +1,122 @@
.. currentmodule:: lihzahrd
Usage guide
====================================
Prerequisites
------------------------------------
To use ``lihzahrd``, you need Python 3.7 or higher.
That's it! No other packages are required!
Installing
------------------------------------
You can download (or update) the package with ``pip`` by entering in your terminal: ::
python3.7 -m pip install --upgrade lihzahrd
Opening a world
------------------------------------
To open a Terraria world file named ``terra.wld`` located in the current working directory, you should import the
:py:mod:`lihzahrd` package and then call the :py:meth:`World.create_from_file` function: ::
import lihzahrd
world = lihzahrd.World.create_from_file("terra.wld")
It should take **a few minutes**, depending on the size of the world, and then return a
:py:class:`World` object.
Accessing the world properties
------------------------------------
Most of the world properties are accessible directly as attributes of the :py:class:`World` object: ::
print(world.name)
# "Terra"
print(world.is_hardmode)
# False
print(world.spawn_point)
# Coordinates(2101, 246)
Some world properties may be grouped in other objects: ::
print(world.bosses_defeated)
# <BossesDefeated>
print(world.bosses_defeated.eye_of_cthulhu)
# False
You can look at the :py:class:`World` class documentation or use an IDE that supports type annotations
(such as `PyCharm <https://www.jetbrains.com/pycharm/>`_) to find all available attributes.
Accessing the tile data
------------------------------------
All :py:class:`tiles.Tile` are stored in the :py:class:`tiles.TileMatrix` accessible at the :py:attr:`World.tiles`
attribute. ::
print(world.tiles)
# <TileMatrix 4200x1200>
You can access them by using the ``tiles`` attribute as a two-dimensional array, where (0, 0) is the top-left block: ::
print(world.tiles[0, 0])
# <Tile >
You can also use :py:class:`fileutils.Coordinates` instead of a :py:class:`tuple` to fetch a specific tile: ::
print(world.tiles[lihzahrd.fileutils.Coordinates(2000, 1000)])
# <Tile B>
print(world.tiles[world.spawn_point])
# <Tile B>
Counting tiles from the bottom-right is possible too: ::
print(world.tiles[-1, -1])
# <Tile >
A single :py:class:`tiles.Tile` has five attributes that you can access:
* :py:attr:`tiles.Tile.block`, the foreground :py:class:`tiles.Block`;
* :py:attr:`tiles.Tile.wall`, the background :py:class:`tiles.Wall`;
* :py:attr:`tiles.Tile.liquid`, the :py:class:`tiles.Liquid` present in that tile;
* :py:attr:`tiles.Tile.wiring`, the colored wires and actuators (:py:class:`tiles.Wiring`);
* :py:attr:`tiles.Tile.extra`, additional data about the block present at that tile, such as the contents of a chest.
All of these attributes may be :py:const:`None` if the property isn't applicable for the tile:
for example, :py:attr:`tiles.Tile.block` is :py:const:`None` if there is no block ("air") placed there.
Accessing extra data
------------------------------------
Extra data, such as the content of chests or the text of signs, may be accessed in two different ways:
* Through the :py:attr:`tiles.Tile.extra` attribute: ::
print(world.tiles[2893, 1074].extra)
# <Chest '' at 2893, 1074>
* Through the various lists available in the :py:class:`World` class, such as :py:attr:`World.chests`: ::
print(world.chests[0])
# <Chest '' at 2893, 1074>
Both ways return the same object, but one may be faster than the other, depending on your use case: ::
print(world.tiles[2893, 1074].extra is world.chests[0])
# True
Something else
------------------------------------
All information included in a Terraria savefile is parsed in this package and made available in the :py:class:`World`
object.
If you couldn't find what you needed in this short usage guide, check the API Reference or have a look at the
`source code <https://github.com/Steffo99/lihzahrd/tree/master/lihzahrd>`_ !

1
docs_source/world.rst
View file

@ -7,5 +7,4 @@ lihzahrd.World
.. autoclass:: lihzahrd.World .. autoclass:: lihzahrd.World
:members: :members:
:private-members:
:undoc-members: :undoc-members:

4
lihzahrd/__init__.py
View file

@ -1,3 +1,5 @@
from .world import World from .world import World
from . import chests, fileutils, header, npcs, pressureplates, signs, tileentities, tiles, townmanager
__all__ = ["World"] __all__ = ["World", "chests", "fileutils", "header", "npcs", "pressureplates", "signs", "tileentities", "tiles",
"townmanager"]

2
lihzahrd/header/bossesdefeated.py
View file

@ -57,4 +57,4 @@ class BossesDefeated:
self.old_ones_army: OldOnesArmyTiers = old_ones_army self.old_ones_army: OldOnesArmyTiers = old_ones_army
def __repr__(self): def __repr__(self):
return f"<WorldBossesDefeated>" return f"<BossesDefeated>"

2
lihzahrd/header/version.py
View file

@ -4,6 +4,8 @@ import typing
class Version: class Version:
"""A Terraria version.""" """A Terraria version."""
__slots__ = ("id", )
_version_ids = { _version_ids = {
71: "1.2.0.3.1", 71: "1.2.0.3.1",
77: "1.2.2", 77: "1.2.2",

4
lihzahrd/pressureplates/weighedpressureplate.py
View file

@ -2,9 +2,9 @@ from ..fileutils import Coordinates
class WeighedPressurePlate: class WeighedPressurePlate:
"""A single pressure plate placed in the world.""" """A single `Weighed Pressure Plate <https://terraria.gamepedia.com/Pressure_Plates>`_ placed in the world."""
__slots__ = "position" __slots__ = ("position", )
def __init__(self, position: Coordinates): def __init__(self, position: Coordinates):
self.position: Coordinates = position self.position: Coordinates = position

2
lihzahrd/tileentities/itemframe.py
View file

@ -4,7 +4,7 @@ from ..chests import ItemStack
class ItemFrame: class ItemFrame:
"""Data pertaining to an https://terraria.gamepedia.com/Item_Frame .""" """Data pertaining to an https://terraria.gamepedia.com/Item_Frame ."""
__slots__ = "item" __slots__ = ("item", )
def __init__(self, item: ItemStack): def __init__(self, item: ItemStack):
self.item: ItemStack = item self.item: ItemStack = item

11
lihzahrd/tiles/tile.py
View file

@ -4,6 +4,9 @@ from .wall import Wall
from .liquid import Liquid from .liquid import Liquid
from .wiring import Wiring from .wiring import Wiring
from ..chests import Chest from ..chests import Chest
from ..signs import Sign
from ..pressureplates import WeighedPressurePlate
from ..tileentities import TileEntity
class Tile: class Tile:
@ -16,7 +19,7 @@ class Tile:
wall: typing.Optional[Wall] = None, wall: typing.Optional[Wall] = None,
liquid: typing.Optional[Liquid] = None, liquid: typing.Optional[Liquid] = None,
wiring: typing.Optional[Wiring] = None, wiring: typing.Optional[Wiring] = None,
extra: typing.Optional[typing.Union[Chest]] = None): extra: typing.Optional[typing.Union[Chest, Sign, WeighedPressurePlate, TileEntity]] = None):
if wiring is None: if wiring is None:
wiring = Wiring() wiring = Wiring()
@ -24,7 +27,9 @@ class Tile:
self.wall: typing.Optional[Wall] = wall self.wall: typing.Optional[Wall] = wall
self.liquid: typing.Optional[Liquid] = liquid self.liquid: typing.Optional[Liquid] = liquid
self.wiring: typing.Optional[Wiring] = wiring self.wiring: typing.Optional[Wiring] = wiring
self.extra: typing.Optional[typing.Union[Chest]] = extra
self.extra: typing.Optional[typing.Union[Chest, Sign, WeighedPressurePlate, TileEntity]] = extra
"""A reference to the extra data of this tile, such as Chest or Sign data."""
def __repr__(self): def __repr__(self):
return f"<Tile {'B' if self.block else '_'}{'W' if self.wall else '_'}{'L' if self.liquid else '_'}{'W' if self.wiring else '_'}{'E' if self.extra else '_'}>" return f"<Tile {'B' if self.block else ''}{'W' if self.wall else ''}{'L' if self.liquid else ''}{'W' if self.wiring else ''}{'E' if self.extra else ''}>"

2
lihzahrd/townmanager/room.py
View file

@ -3,6 +3,8 @@ from ..npcs import EntityType
class Room: class Room:
__slots__ = "npc", "position"
def __init__(self, npc: EntityType, position: Coordinates): def __init__(self, npc: EntityType, position: Coordinates):
self.npc: EntityType = npc self.npc: EntityType = npc
self.position: Coordinates = position self.position: Coordinates = position

47
lihzahrd/world.py
View file

@ -185,6 +185,7 @@ class World:
@property @property
def crimson_hearts(self) -> ShadowOrbs: def crimson_hearts(self) -> ShadowOrbs:
"""Information related to the Shadow Orbs or Crimson Hearts in the world."""
return self.shadow_orbs return self.shadow_orbs
@crimson_hearts.setter @crimson_hearts.setter
@ -263,13 +264,20 @@ class World:
return [tile] * multiply_by return [tile] * multiply_by
@classmethod @classmethod
def create_from_file(cls, file): def create_from_file(cls, filename: str):
"""Create a World object from a .wld file.""" """Create a World object from a .wld file.
Warning:
Parsing an entire world may take up to a few minutes and quite a bit of memory!
Arguments:
filename: The name of the file that should be parsed."""
# This code is a mess. # This code is a mess.
file = open(filename, "rb")
f = FileReader(file) f = FileReader(file)
with Timer("File Format", display=True): # File header
version = Version(f.int4()) version = Version(f.int4())
relogic = f.string(7) relogic = f.string(7)
savefile_type = f.uint1() savefile_type = f.uint1()
@ -289,7 +297,6 @@ class World:
unknown_file_format_data = f.read_until(pointers.world_header) unknown_file_format_data = f.read_until(pointers.world_header)
with Timer("World Header", display=True):
name = f.string() name = f.string()
generator = GeneratorInfo(f.string(), f.uint8()) generator = GeneratorInfo(f.string(), f.uint8())
@ -515,7 +522,7 @@ class World:
unknown_world_header_data = f.read_until(pointers.world_tiles) unknown_world_header_data = f.read_until(pointers.world_tiles)
with Timer("World Tiles", display=True): # Tiles
tm = TileMatrix() tm = TileMatrix()
while tm.size.x < world_size.x: while tm.size.x < world_size.x:
column = [] column = []
@ -526,7 +533,7 @@ class World:
unknown_world_tiles_data = f.read_until(pointers.chests) unknown_world_tiles_data = f.read_until(pointers.chests)
with Timer("Chests", display=True): # Chests
chests = [] chests = []
chests_count = f.int2() chests_count = f.int2()
@ -552,10 +559,11 @@ class World:
name=chest_name, name=chest_name,
contents=chest_contents) contents=chest_contents)
chests.append(chest) chests.append(chest)
tm[chest.position].extra = chest
unknown_chests_data = f.read_until(pointers.signs) unknown_chests_data = f.read_until(pointers.signs)
with Timer("Signs", display=True): # Signs
signs = [] signs = []
signs_count = f.int2() signs_count = f.int2()
@ -563,10 +571,12 @@ class World:
for _ in range(signs_count): for _ in range(signs_count):
sign = Sign(text=f.string(), sign = Sign(text=f.string(),
position=Coordinates(f.int4(), f.int4())) position=Coordinates(f.int4(), f.int4()))
signs.append(sign)
tm[sign.position].extra = sign
unknown_signs_data = f.read_until(pointers.npcs) unknown_signs_data = f.read_until(pointers.npcs)
with Timer("Entities", display=True): # Entities
npcs = [] npcs = []
mobs = [] mobs = []
@ -589,13 +599,13 @@ class World:
mob_type = EntityType(f.int4()) mob_type = EntityType(f.int4())
mob_position = Coordinates(f.single(), f.single()) mob_position = Coordinates(f.single(), f.single())
mob = Mob(type_=npc_type, mob = Mob(type_=mob_type,
position=npc_position) position=mob_position)
mobs.append(mob) mobs.append(mob)
unknown_npcs_data = f.read_until(pointers.tile_entities) unknown_npcs_data = f.read_until(pointers.tile_entities)
with Timer("Tile Entities", display=True): # Tile entities
tile_entities_count = f.int4() tile_entities_count = f.int4()
tile_entities = [] tile_entities = []
@ -611,22 +621,26 @@ class World:
quantity=f.int2())) quantity=f.int2()))
elif te_type == 2: elif te_type == 2:
te_extra = LogicSensor(logic_check=f.uint1(), enabled=f.bool()) te_extra = LogicSensor(logic_check=f.uint1(), enabled=f.bool())
else:
te_extra = ...
tile_entity = TileEntity(id_=te_id, position=te_position, extra=te_extra) tile_entity = TileEntity(id_=te_id, position=te_position, extra=te_extra)
tile_entities.append(tile_entity) tile_entities.append(tile_entity)
tm[tile_entity.position].extra = tile_entity
unknown_tile_entities_data = f.read_until(pointers.pressure_plates) unknown_tile_entities_data = f.read_until(pointers.pressure_plates)
with Timer("Weighed Pressure Plates", display=True): # Weighed Pressure Plates
weighed_pressure_plates_count = f.int4() weighed_pressure_plates_count = f.int4()
weighed_pressure_plates = [] weighed_pressure_plates = []
for _ in range(weighed_pressure_plates_count): for _ in range(weighed_pressure_plates_count):
wpp = WeighedPressurePlate(position=Coordinates(f.int4(), f.int4())) wpp = WeighedPressurePlate(position=Coordinates(f.int4(), f.int4()))
weighed_pressure_plates.append(wpp) weighed_pressure_plates.append(wpp)
tm[wpp.position].extra = wpp
unknown_pressure_plates_data = f.read_until(pointers.town_manager) unknown_pressure_plates_data = f.read_until(pointers.town_manager)
with Timer("Town Manager", display=True): # Town Manager
rooms_count = f.int4() rooms_count = f.int4()
rooms = [] rooms = []
@ -636,7 +650,8 @@ class World:
unknown_town_manager_data = f.read_until(pointers.footer) unknown_town_manager_data = f.read_until(pointers.footer)
world = World(version=version, savefile_type=savefile_type, revision=revision, is_favorite=is_favorite, # Object creation
world = cls(version=version, savefile_type=savefile_type, revision=revision, is_favorite=is_favorite,
name=name, generator=generator, uuid_=uuid_, id_=id_, bounds=bounds, size=world_size, name=name, generator=generator, uuid_=uuid_, id_=id_, bounds=bounds, size=world_size,
is_expert=is_expert, created_on=created_on, styles=world_styles, backgrounds=backgrounds, is_expert=is_expert, created_on=created_on, styles=world_styles, backgrounds=backgrounds,
spawn_point=spawn_point, underground_level=underground_level, cavern_level=cavern_level, spawn_point=spawn_point, underground_level=underground_level, cavern_level=cavern_level,
@ -656,7 +671,7 @@ class World:
unknown_pressure_plates_data=unknown_pressure_plates_data, unknown_pressure_plates_data=unknown_pressure_plates_data,
unknown_town_manager_data=unknown_town_manager_data) unknown_town_manager_data=unknown_town_manager_data)
with Timer("Footer", display=True): # Footer
if not f.bool(): if not f.bool():
raise InvalidFooterError("Invalid footer") raise InvalidFooterError("Invalid footer")
if not f.string() == world.name: if not f.string() == world.name:
@ -664,4 +679,6 @@ class World:
if not f.int4() == world.id: if not f.int4() == world.id:
raise InvalidFooterError("Invalid footer") raise InvalidFooterError("Invalid footer")
f.file.close()
return world return world

2
setup.py
View file

@ -5,7 +5,7 @@ with open("README.md", "r") as f:
setuptools.setup( setuptools.setup(
name="lihzahrd", name="lihzahrd",
version="1.0a1", version="1.0b1",
author="Stefano Pigozzi", author="Stefano Pigozzi",
author_email="ste.pigozzi@gmail.com", author_email="ste.pigozzi@gmail.com",
description="A Terraria world parser in Python", description="A Terraria world parser in Python",

2
test.py
View file

@ -1,3 +1,3 @@
import lihzahrd import lihzahrd
lihzahrd.World.create_from_file(open("Small_Example.wld", "rb")) lihzahrd.World.create_from_file("Small_Example.wld")