built docs again

Cammin · Sep 28, 2023 · 7e53305 · 7e53305
1 parent b214890
commit 7e53305
Show file tree

Hide file tree

Showing 9 changed files with 194 additions and 42 deletions.
diff --git a/docs/api/LDtkUnity.LDtkFields.html b/docs/api/LDtkUnity.LDtkFields.html
@@ -1597,7 +1597,7 @@ <h5 class="returns">Returns</h5>
   </span>
   <a id="LDtkUnity_LDtkFields_GetMultiline_" data-uid="LDtkUnity.LDtkFields.GetMultiline*"></a>
   <h4 id="LDtkUnity_LDtkFields_GetMultiline_System_String_" data-uid="LDtkUnity.LDtkFields.GetMultiline(System.String)">GetMultiline(String)</h4>
-  <div class="markdown level1 summary"><p>Gets a multiline field's value.</p>
+  <div class="markdown level1 summary"><p>Gets a multiline field's value. IMPORTANT: Make sure that the LDtk project is configured to use &quot;Multilines&quot; in it's advanced settings</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
@@ -1659,7 +1659,7 @@ <h5 class="returns">Returns</h5>
   </span>
   <a id="LDtkUnity_LDtkFields_GetMultilineArray_" data-uid="LDtkUnity.LDtkFields.GetMultilineArray*"></a>
   <h4 id="LDtkUnity_LDtkFields_GetMultilineArray_System_String_" data-uid="LDtkUnity.LDtkFields.GetMultilineArray(System.String)">GetMultilineArray(String)</h4>
-  <div class="markdown level1 summary"><p>Gets a multiline field's values.</p>
+  <div class="markdown level1 summary"><p>Gets a multiline field's values. IMPORTANT: Make sure that the LDtk project is configured to use &quot;Multilines&quot; in it's advanced settings</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
@@ -3394,7 +3394,7 @@ <h5 class="returns">Returns</h5>
   </span>
   <a id="LDtkUnity_LDtkFields_TryGetMultiline_" data-uid="LDtkUnity.LDtkFields.TryGetMultiline*"></a>
   <h4 id="LDtkUnity_LDtkFields_TryGetMultiline_System_String_System_String__" data-uid="LDtkUnity.LDtkFields.TryGetMultiline(System.String,System.String@)">TryGetMultiline(String, out String)</h4>
-  <div class="markdown level1 summary"><p>Gets a multiline field's value.</p>
+  <div class="markdown level1 summary"><p>Gets a multiline field's value. IMPORTANT: Make sure that the LDtk project is configured to use &quot;Multilines&quot; in it's advanced settings</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
@@ -3462,7 +3462,7 @@ <h5 class="returns">Returns</h5>
   </span>
   <a id="LDtkUnity_LDtkFields_TryGetMultilineArray_" data-uid="LDtkUnity.LDtkFields.TryGetMultilineArray*"></a>
   <h4 id="LDtkUnity_LDtkFields_TryGetMultilineArray_System_String_System_String____" data-uid="LDtkUnity.LDtkFields.TryGetMultilineArray(System.String,System.String[]@)">TryGetMultilineArray(String, out String[])</h4>
-  <div class="markdown level1 summary"><p>Gets a multiline field's values.</p>
+  <div class="markdown level1 summary"><p>Gets a multiline field's values. IMPORTANT: Make sure that the LDtk project is configured to use &quot;Multilines&quot; in it's advanced settings</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 

diff --git a/docs/documentation/Installation/topic_StartupGuide.html b/docs/documentation/Installation/topic_StartupGuide.html
@@ -134,8 +134,7 @@ <h3 id="3-add-a-custom-command">3. Add a Custom Command</h3>
 </li>
 </ul>
 <p>After you're ready, drag the project from the project window into the scene or the hierarchy.<br>
-<img src="../../images/gif_DragNDrop.gif" alt="Drag-N-Drop"><br>
-Tip: Double clicking the LDtk file in the project window will conveniently open the project in LDtk.</p>
+<img src="../../images/gif_DragNDrop.gif" alt="Drag-N-Drop"></p>
 <h1 id="collision">Collision</h1>
 <p>There are two options to configure collision for the importer.</p>
 <h4 id="tileset-files">Tileset Files</h4>

diff --git a/docs/documentation/Topics/topic_CustomImporting.html b/docs/documentation/Topics/topic_CustomImporting.html
@@ -107,6 +107,19 @@ <h2 id="ldtkpostprocessor">LDtkPostprocessor</h2>
     protected override void OnPostprocessProject(GameObject root)
     {
         Debug.Log($&quot;Post process LDtk project: {root.name}&quot;);
+        foreach (Transform world in root.transform)
+        {
+            foreach (Transform level in world)
+            {
+                foreach (Transform layer in level)
+                {
+                    foreach (Transform tilemapOrEntity in layer)
+                    {
+                        //Iterate upon any children of the root
+                    }
+                }
+            }
+        }
     }
 
     protected override void OnPostprocessLevel(GameObject root, LdtkJson projectJson)
@@ -171,7 +184,7 @@ <h3 id="ordering">Ordering</h3>
               <div class="contribution">
                 <ul class="nav">
                   <li>
-                    <a href="https://github.com/Cammin/LDtkToUnity/blob/feature/spriteManagementRework/DocFX/documentation/Topics/topic_CustomImporting.md/#L1" class="contribution-link">Improve this Doc</a>
+                    <a href="https://github.com/Cammin/LDtkToUnity/blob/develop/DocFX/documentation/Topics/topic_CustomImporting.md/#L1" class="contribution-link">Improve this Doc</a>
                   </li>
                 </ul>
               </div>

diff --git a/docs/documentation/Topics/topic_Fields.html b/docs/documentation/Topics/topic_Fields.html
@@ -96,6 +96,7 @@ <h1 id="fields">Fields</h1>
       }
 }
 </code></pre>
+<p>The above example uses an <code>Item</code> type, which was generated as a C# file by the importer.</p>
 </li>
 </ul>
 <h2 id="nullables">Nullables</h2>
@@ -130,7 +131,7 @@ <h3 id="note">Note</h3>
               <div class="contribution">
                 <ul class="nav">
                   <li>
-                    <a href="https://github.com/Cammin/LDtkToUnity/blob/feature/spriteManagementRework/DocFX/documentation/Topics/topic_Fields.md/#L1" class="contribution-link">Improve this Doc</a>
+                    <a href="https://github.com/Cammin/LDtkToUnity/blob/develop/DocFX/documentation/Topics/topic_Fields.md/#L1" class="contribution-link">Improve this Doc</a>
                   </li>
                 </ul>
               </div>

diff --git a/docs/documentation/Topics/topic_Tips.html b/docs/documentation/Topics/topic_Tips.html
@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<!--[if IE]><![endif]-->
+<html>
+
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title>Tips </title>
+    <meta name="viewport" content="width=device-width">
+    <meta name="title" content="Tips ">
+    <meta name="generator" content="docfx 2.56.7.0">
+
+    <link rel="shortcut icon" href="../../favicon.ico">
+    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
+    <link rel="stylesheet" href="../../styles/docfx.css">
+    <link rel="stylesheet" href="../../styles/main.css">
+    <meta property="docfx:navrel" content="../../toc.html">
+    <meta property="docfx:tocrel" content="../toc.html">
+
+
+
+  </head>
+  <body data-spy="scroll" data-target="#affix" data-offset="120">
+    <div id="wrapper">
+      <header>
+
+        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
+          <div class="container">
+            <div class="navbar-header">
+              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
+                <span class="sr-only">Toggle navigation</span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+              </button>
+
+              <a class="navbar-brand" href="../../index.html">
+                <img id="logo" class="svg" src="../../images/img_logo_white.png" alt="">
+              </a>
+            </div>
+            <div class="collapse navbar-collapse" id="navbar">
+              <ol class="navbar-icons-list">
+                <li><a class="navbar-logo-link" href="https://github.com/Cammin/LDtkUnity"><img src="../../images/github.svg"></a></li>
+              </ol>
+            </div>
+            <form class="navbar-form navbar-right" role="search" id="search">
+              <div class="form-group">
+                <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
+              </div>
+            </form>
+          </div>
+        </nav>
+
+        <div class="subnav navbar navbar-default">
+          <div class="container hide-when-search" id="breadcrumb">
+            <ul class="breadcrumb">
+              <li></li>
+            </ul>
+          </div>
+        </div>
+      </header>
+      <div role="main" class="container body-content hide-when-search">
+
+        <div class="sidenav hide-when-search">
+          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
+          <div class="sidetoggle collapse" id="sidetoggle">
+            <div id="sidetoc"></div>
+          </div>
+        </div>
+        <div class="article row grid-right">
+          <div class="col-md-10">
+            <article class="content wrap" id="_content" data-uid="">
+<h1 id="tips">Tips</h1>
+
+<p>Some Tips &amp; Tricks and best practice encouragement.</p>
+<ul>
+<li><p>It's best to make entity prefabs be simple prefabs in order to avoid lots of time-consuming reimporting</p>
+</li>
+<li><p>Double clicking the LDtk file in the project window will conveniently open the project in LDtk.</p>
+</li>
+<li><p>Most (if not all) fields have tooltips to help explain itself.</p>
+</li>
+<li><p>Most (if not all) MonoBehaviours and ScriptableObjects have help references available to quickly refer back to topics in this documentation.<br>
+<img src="../../images/img_Unity_HelpUrl.png" alt="Asset Reference"></p>
+</li>
+<li><p>Renaming LDtk assets inside of Unity is blocked. You should only be allowed to rename projects from inside LDtk. LDtk will automatically also rename the meta file!</p>
+</li>
+</ul>
+</article>
+          </div>
+
+          <div class="hidden-sm col-md-2" role="complementary">
+            <div class="sideaffix">
+              <div class="contribution">
+                <ul class="nav">
+                  <li>
+                    <a href="https://github.com/Cammin/LDtkToUnity/blob/develop/DocFX/documentation/Topics/topic_Tips.md/#L1" class="contribution-link">Improve this Doc</a>
+                  </li>
+                </ul>
+              </div>
+              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
+                <h5>In This Article</h5>
+                <div></div>
+              </nav>
+            </div>
+          </div>
+        </div>
+      </div>
+
+      <footer>
+        <div class="grad-bottom"></div>
+        <div class="footer">
+          <div class="container">
+            <span class="pull-right">
+              <a href="#top">Back to top</a>
+            </span>
+
+            <span>Generated by <strong>DocFX</strong></span>
+          </div>
+        </div>
+      </footer>
+    </div>
+
+    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
+    <script type="text/javascript" src="../../styles/docfx.js"></script>
+    <script type="text/javascript" src="../../styles/main.js"></script>
+  </body>
+</html>
diff --git a/docs/documentation/Topics/topic_Troubleshooting.html b/docs/documentation/Topics/topic_Troubleshooting.html
@@ -115,9 +115,14 @@ <h2 id="custom-prefab-identifier-uniqueness">Custom Prefab Identifier Uniqueness
 <h2 id="tilemap-seams">Tilemap Seams</h2>
 <p>The solution is by using a sprite atlas to add padding between sprite slices.<br>
 See <strong><a href="topic_TilemapTearing.html">Tilemap Seams</a></strong></p>
-<h2 id="unexpected-composite-collider">Unexpected Composite Collider</h2>
-<p>Sometimes it's possible that the composite colliders retain changes between the previous import which can negatively impact the expected collision of levels.
-To fix this, select the root LDtk project in the scene, and then revert the prefab overrides, which should revert any unexpected changes applied to the composite collider components.<br>
+<h2 id="scene-overrides">Scene Overrides</h2>
+<p>Sometimes there are problems with the LDtk object in the scene where the LDtk object has scene overrides.
+This can cause numerous issues:</p>
+<ul>
+<li>Composite colliders can retain changes between the previous import which can negatively impact the expected collision of levels.</li>
+<li>Moving/Undoing can becomes very slow when there's lots of dirty tilemap changes.</li>
+</ul>
+<p>To fix this, select the root LDtk project in the scene, and then revert the prefab overrides, which should revert any unexpected changes applied to the composite collider components.<br>
 A fix was investigated, but not found yet. This may still be fixed in the future.</p>
 <h2 id="missing-levels-array">Missing Levels Array</h2>
 <p>When digging through the root json data (via LDtkPostprocessor.OnPostprocessLevel for instance), you may find that the <code>Levels</code> array is empty when it shouldn't be.

diff --git a/docs/documentation/toc.html b/docs/documentation/toc.html
@@ -70,6 +70,9 @@
                           <li>
                               <a href="Topics/topic_Troubleshooting.html" name="" title="Troubleshooting">Troubleshooting</a>
                           </li>
+                          <li>
+                              <a href="Topics/topic_Tips.html" name="" title="Tips">Tips</a>
+                          </li>
                           <li>
                               <a href="Topics/topic_IntGridTile.html" name="" title="IntGrid Tile">IntGrid Tile</a>
                           </li>

diff --git a/docs/index.html b/docs/index.html
@@ -71,19 +71,10 @@ <h3 id="install"><a href="documentation/Installation/topic_Install.html">Install
 <h3 id="startup-guide"><a href="documentation/Installation/topic_StartupGuide.html">Startup Guide</a></h3>
 <p>Check the <a href="documentation/Installation/topic_StartupGuide.html">DOCS</a>
 or <a href="api/LDtkUnity.html">API</a> to find more content.</p>
-<h3 id="tips">Tips</h3>
 <ul>
-<li><p>Most (if not all) fields have tooltips to help explain itself.</p>
-</li>
-<li><p>Most (if not all) MonoBehaviours and ScriptableObjects have help references available to quickly refer back to topics in this documentation.<br>
-<img src="images/img_Unity_HelpUrl.png" alt="Asset Reference"></p>
-</li>
-<li><p>Feedback is always appreciated. Post issues if you find any bugs or want to suggest features or improvements.</p>
-</li>
-<li><p>Feel free to help improve this wiki by submitting pull requests.</p>
-</li>
-<li><p>To contribute to the repository, check out the guide detailed on the Discord server.</p>
-</li>
+<li>Feedback is always appreciated. Post issues if you find any bugs or want to suggest features or improvements.</li>
+<li>Feel free to help improve this wiki by submitting pull requests.</li>
+<li>To contribute to the repository, check out the guide detailed on the Discord server.</li>
 </ul>
 </article>
           </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -70,6 +70,9 @@ @@
                               <li>
                                   <a href="Topics/topic_Troubleshooting.html" name="" title="Troubleshooting">Troubleshooting</a>
                               </li>
+                              <li>
+                                  <a href="Topics/topic_Tips.html" name="" title="Tips">Tips</a>
+                              </li>
                               <li>
                                   <a href="Topics/topic_IntGridTile.html" name="" title="IntGrid Tile">IntGrid Tile</a>
                               </li>
@@ Expand Down @@