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

Update docs

Browse source
This commit is contained in:
Steffo 2019-08-11 17:30:53 +02:00
parent d677fb18de
commit e504bb9802
21 changed files with 29113 additions and 404 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

Binary file not shown.

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/tiles.doctree
View file

Binary file not shown.

BIN
docs/doctrees/world.doctree
View file

Binary file not shown.

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

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

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

@ -7,6 +7,7 @@ lihzahrd
world
header
tiles
chests
Some useful links

2
docs/html/_sources/tiles.rst.txt
View file

@ -1,4 +1,4 @@
lihzahrd.header
lihzahrd.tiles
====================================
.. toctree::

20138
docs/html/chests.html Normal file
View file

File diff suppressed because it is too large Load diff

9289
docs/html/genindex.html
View file

File diff suppressed because it is too large Load diff

13
docs/html/header.html
View file

@ -35,7 +35,7 @@
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.header" href="tiles.html" />
<link rel="next" title="lihzahrd.tiles" href="tiles.html" />
<link rel="prev" title="lihzahrd.World" href="world.html" />
</head>
@ -85,7 +85,8 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.header</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.header</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="chests.html">lihzahrd.chests</a></li>
</ul>
@ -408,12 +409,6 @@
<dd><p>Information about… the clouds in the world?</p>
</dd></dl>
<dl class="class">
<dt id="lihzahrd.header.Coordinates">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.header.</code><code class="sig-name descname">Coordinates</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.header.Coordinates" title="Permalink to this definition"></a></dt>
<dd><p>A pair of coordinates.</p>
</dd></dl>
<dl class="class">
<dt id="lihzahrd.header.Events">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.header.</code><code class="sig-name descname">Events</code><span class="sig-paren">(</span><em class="sig-param">blood_moon: bool</em>, <em class="sig-param">solar_eclipse: bool</em>, <em class="sig-param">invasion: lihzahrd.header.invasion.Invasion</em>, <em class="sig-param">slime_rain: float</em>, <em class="sig-param">rain: lihzahrd.header.rain.Rain</em>, <em class="sig-param">party: lihzahrd.header.party.Party</em>, <em class="sig-param">sandstorm: lihzahrd.header.sandstorm.Sandstorm</em>, <em class="sig-param">lunar_events: lihzahrd.header.lunarevents.LunarEvents</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.header.Events" title="Permalink to this definition"></a></dt>
@ -923,7 +918,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="tiles.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="tiles.html" class="btn btn-neutral float-right" title="lihzahrd.tiles" 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>

8
docs/html/index.html
View file

@ -82,7 +82,8 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.header</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="chests.html">lihzahrd.chests</a></li>
</ul>
@ -157,7 +158,10 @@
<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="tiles.html">lihzahrd.header</a><ul class="simple">
<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="chests.html">lihzahrd.chests</a><ul class="simple">
</ul>
</li>
</ul>

BIN
docs/html/objects.inv
View file

Binary file not shown.

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

@ -84,7 +84,8 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.header</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="chests.html">lihzahrd.chests</a></li>
</ul>
@ -162,6 +163,11 @@
<td>
<code class="xref">lihzahrd</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="chests.html#module-lihzahrd.chests"><code class="xref">lihzahrd.chests</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;

3
docs/html/search.html
View file

@ -82,7 +82,8 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1"><a class="reference internal" href="tiles.html">lihzahrd.header</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="chests.html">lihzahrd.chests</a></li>
</ul>

2
docs/html/searchindex.js
View file

File diff suppressed because one or more lines are too long

25
docs/html/tiles.html
View file

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>lihzahrd.header &mdash; lihzahrd documentation</title>
<title>lihzahrd.tiles &mdash; lihzahrd documentation</title>
@ -35,6 +35,7 @@
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="lihzahrd.chests" href="chests.html" />
<link rel="prev" title="lihzahrd.header" href="header.html" />
</head>
@ -82,9 +83,10 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="world.html">lihzahrd.World</a></li>
<li class="toctree-l1"><a class="reference internal" href="header.html">lihzahrd.header</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.header</a><ul class="simple">
<li class="toctree-l1 current"><a class="current reference internal" href="#">lihzahrd.tiles</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="chests.html">lihzahrd.chests</a></li>
</ul>
@ -130,7 +132,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>lihzahrd.header</li>
<li>lihzahrd.tiles</li>
<li class="wy-breadcrumbs-aside">
@ -149,8 +151,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="lihzahrd-header">
<h1>lihzahrd.header<a class="headerlink" href="#lihzahrd-header" title="Permalink to this headline"></a></h1>
<div class="section" id="lihzahrd-tiles">
<h1>lihzahrd.tiles<a class="headerlink" href="#lihzahrd-tiles" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-lihzahrd.tiles"></span><dl class="class">
@ -3830,7 +3832,7 @@ the save file.</p>
<dl class="class">
<dt id="lihzahrd.tiles.Block">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tiles.</code><code class="sig-name descname">Block</code><span class="sig-paren">(</span><em class="sig-param">type_: lihzahrd.tiles.blocktype.BlockType, frame: Optional[lihzahrd.tiles.frameimportantdata.FrameImportantData], shape: lihzahrd.tiles.shape.Shape, paint: Optional[int], is_active: bool = True</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Block" 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">Block</code><span class="sig-paren">(</span><em class="sig-param">type_: lihzahrd.tiles.blocktype.BlockType</em>, <em class="sig-param">shape: lihzahrd.tiles.shape.Shape = &lt;Shape.NORMAL: 0&gt;</em>, <em class="sig-param">frame: Optional[lihzahrd.tiles.frameimportantdata.FrameImportantData] = None</em>, <em class="sig-param">paint: Optional[int] = None</em>, <em class="sig-param">is_active: bool = True</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Block" title="Permalink to this definition"></a></dt>
<dd><p>A block that has been placed in the world.</p>
<dl class="attribute">
<dt id="lihzahrd.tiles.Block.frame">
@ -3853,7 +3855,8 @@ the save file.</p>
<dl class="attribute">
<dt id="lihzahrd.tiles.Block.shape">
<code class="sig-name descname">shape</code><a class="headerlink" href="#lihzahrd.tiles.Block.shape" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>The shape of the block, is changed with an hammer.</p>
</dd></dl>
<dl class="attribute">
<dt id="lihzahrd.tiles.Block.type">
@ -3865,7 +3868,7 @@ the save file.</p>
<dl class="class">
<dt id="lihzahrd.tiles.Wall">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tiles.</code><code class="sig-name descname">Wall</code><span class="sig-paren">(</span><em class="sig-param">type_: lihzahrd.tiles.walltype.WallType, paint: Optional[int]</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Wall" 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">Wall</code><span class="sig-paren">(</span><em class="sig-param">type_: lihzahrd.tiles.walltype.WallType</em>, <em class="sig-param">paint: Optional[int] = None</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Wall" title="Permalink to this definition"></a></dt>
<dd><p>A wall that has been placed in the world.</p>
<dl class="attribute">
<dt id="lihzahrd.tiles.Wall.paint">
@ -3881,7 +3884,7 @@ the save file.</p>
<dl class="class">
<dt id="lihzahrd.tiles.Liquid">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.tiles.</code><code class="sig-name descname">Liquid</code><span class="sig-paren">(</span><em class="sig-param">type_: lihzahrd.tiles.liquidtype.LiquidType</em>, <em class="sig-param">volume: int</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Liquid" 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">Liquid</code><span class="sig-paren">(</span><em class="sig-param">type_: lihzahrd.tiles.liquidtype.LiquidType</em>, <em class="sig-param">volume: int = 255</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.tiles.Liquid" title="Permalink to this definition"></a></dt>
<dd><p>A liquid present in a tile.</p>
<dl class="attribute">
<dt id="lihzahrd.tiles.Liquid.type">
@ -3901,7 +3904,7 @@ the save file.</p>
<dl class="class">
<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], wall: Optional[lihzahrd.tiles.wall.Wall], liquid: Optional[lihzahrd.tiles.liquid.Liquid], wiring: lihzahrd.tiles.wiring.Wiring</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: lihzahrd.tiles.wiring.Wiring = 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>
<dl class="attribute">
<dt id="lihzahrd.tiles.Tile.block">
@ -3935,6 +3938,8 @@ the save file.</p>
<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="header.html" class="btn btn-neutral float-left" title="lihzahrd.header" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

5
docs/html/world.html
View file

@ -85,7 +85,8 @@
</ul>
</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="tiles.html">lihzahrd.header</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="chests.html">lihzahrd.chests</a></li>
</ul>
@ -156,7 +157,7 @@
</div>
<dl class="class">
<dt id="lihzahrd.World">
<em class="property">class </em><code class="sig-prename descclassname">lihzahrd.</code><code class="sig-name descname">World</code><span class="sig-paren">(</span><em class="sig-param">version: lihzahrd.header.version.Version</em>, <em class="sig-param">savefile_type: int</em>, <em class="sig-param">revision: int</em>, <em class="sig-param">is_favorite: bool</em>, <em class="sig-param">name: str</em>, <em class="sig-param">generator: lihzahrd.header.generatorinfo.GeneratorInfo</em>, <em class="sig-param">uuid_: uuid.UUID</em>, <em class="sig-param">id_: int</em>, <em class="sig-param">bounds: lihzahrd.fileutils.rect.Rect</em>, <em class="sig-param">size: lihzahrd.header.coordinates.Coordinates</em>, <em class="sig-param">is_expert: bool</em>, <em class="sig-param">created_on</em>, <em class="sig-param">styles: lihzahrd.header.styles.Styles</em>, <em class="sig-param">backgrounds: lihzahrd.header.backgrounds.Backgrounds</em>, <em class="sig-param">spawn_point: lihzahrd.header.coordinates.Coordinates</em>, <em class="sig-param">underground_level: float</em>, <em class="sig-param">cavern_level: float</em>, <em class="sig-param">time: lihzahrd.header.time.Time</em>, <em class="sig-param">events: lihzahrd.header.events.Events</em>, <em class="sig-param">dungeon_point: lihzahrd.header.coordinates.Coordinates</em>, <em class="sig-param">world_evil: lihzahrd.header.worldeviltype.WorldEvilType</em>, <em class="sig-param">saved_npcs: lihzahrd.header.savednpcs.SavedNPCs</em>, <em class="sig-param">altars_smashed: lihzahrd.header.altarssmashed.AltarsSmashed</em>, <em class="sig-param">is_hardmode: bool</em>, <em class="sig-param">shadow_orbs: lihzahrd.header.shadoworbs.ShadowOrbs</em>, <em class="sig-param">bosses_defeated: lihzahrd.header.bossesdefeated.BossesDefeated</em>, <em class="sig-param">anglers_quest: lihzahrd.header.anglerquest.AnglerQuest</em>, <em class="sig-param">clouds: lihzahrd.header.clouds.Clouds</em>, <em class="sig-param">cultist_delay: int</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World" title="Permalink to this definition"></a></dt>
<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: List[List[lihzahrd.tiles.tile.Tile]], chests: List[lihzahrd.chests.chest.Chest], unknown_file_format_data: bytearray, unknown_world_header_data: bytearray, unknown_world_tiles_data: bytearray, unknown_chests_data: bytearray</em><span class="sig-paren">)</span><a class="headerlink" href="#lihzahrd.World" title="Permalink to this definition"></a></dt>
<dd><p>The Python representation of a Terraria world.</p>
<dl class="method">
<dt id="lihzahrd.World._read_tiles">

11
docs_source/chests.rst Normal file
View file

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

1
docs_source/index.rst
View file

@ -7,6 +7,7 @@ lihzahrd
world
header
tiles
chests
Some useful links