Update for 2024.3

Docs updated for new features, some minor corrections.
func-godot · Nov 27, 2024 · 73a5a8e · 73a5a8e
1 parent 585ff90
commit 73a5a8e
Show file tree

Hide file tree

Showing 29 changed files with 132 additions and 65 deletions.
diff --git a/FuncGodot Manual/FuncGodot Manual.html b/FuncGodot Manual/FuncGodot Manual.html
@@ -3,7 +3,7 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="images/godot_ranger.svg">
-    <link rel="stylesheet" href="styles.css">
+    <link rel="stylesheet" href="pages/styles.css">
 </head>
 <iframe name="main" class="main" src="pages/start.html" height="100%"></iframe>
 <iframe name="sidenav" class="sidenav" src="pages/sidenav.html"></iframe>

diff --git a/FuncGodot Manual/pages/core_func_godot.html b/FuncGodot Manual/pages/core_func_godot.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>CORE: FuncGodot</h1>
     </div>

diff --git a/FuncGodot Manual/pages/core_geo_generator.html b/FuncGodot Manual/pages/core_geo_generator.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>CORE: Geo Generator</h1>
     </div>

diff --git a/FuncGodot Manual/pages/core_map_data.html b/FuncGodot Manual/pages/core_map_data.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>CORE: Map Data</h1>
     </div>

diff --git a/FuncGodot Manual/pages/core_map_parser.html b/FuncGodot Manual/pages/core_map_parser.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>CORE: Map Parser</h1>
     </div>

diff --git a/FuncGodot Manual/pages/core_surface_gatherer.html b/FuncGodot Manual/pages/core_surface_gatherer.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>CORE: Surface Gatherer</h1>
     </div>

diff --git a/FuncGodot Manual/pages/faq.html b/FuncGodot Manual/pages/faq.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Frequently Asked Questions</h1>
 

diff --git a/FuncGodot Manual/pages/guide_building_maps.html b/FuncGodot Manual/pages/guide_building_maps.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Building Maps</h1>
         <p>

diff --git a/FuncGodot Manual/pages/guide_fgd.html b/FuncGodot Manual/pages/guide_fgd.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Forge Game Data</h1>
 

diff --git a/FuncGodot Manual/pages/guide_install.html b/FuncGodot Manual/pages/guide_install.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Installing FuncGodot</h1>
 

diff --git a/FuncGodot Manual/pages/guide_map_editor_config.html b/FuncGodot Manual/pages/guide_map_editor_config.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Map Editor Configuration</h1>
         <p>

diff --git a/FuncGodot Manual/pages/guide_project_config.html b/FuncGodot Manual/pages/guide_project_config.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Project Configuration</h1>
         <h3>Directory Structure</h3>

diff --git a/FuncGodot Manual/pages/guide_textures.html b/FuncGodot Manual/pages/guide_textures.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Textures</h1>
 

diff --git a/FuncGodot Manual/pages/header.html b/FuncGodot Manual/pages/header.html
@@ -3,11 +3,11 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="header">
     <!-- Header Begin -->
-    <div class="header"><img src="../images/godot_ranger.svg" height="50px" alt=""><img src="../images/logo_white.png" height="40px" alt="FuncGodot"></div>
+    <div><img src="../images/godot_ranger.svg" height="50px" alt=""><img src="../images/logo_white.png" height="40px" alt="FuncGodot"></div>
     <!-- Header End -->
 </body>
 </html>
diff --git a/FuncGodot Manual/pages/helpful_links.html b/FuncGodot Manual/pages/helpful_links.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Helpful Links</h1>
 

diff --git a/FuncGodot Manual/pages/ref_fgd_resources.html b/FuncGodot Manual/pages/ref_fgd_resources.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>FuncGodot FGD Resources</h1>
 
@@ -76,6 +76,7 @@ <h2 id="Entity">FuncGodotFGDEntityClass</h2>
                 <td>Type</td>
                 <td>Description</td>
             </tr>
+
             <tr class="header"><td>Entity Definition</td><td></td><td></td></tr>
             <tr>
                 <td>Classname</td>
@@ -129,7 +130,7 @@ <h2 id="Entity">FuncGodotFGDEntityClass</h2>
                     and <a href="https://trenchbroom.github.io/manual/latest/#display-models-for-entities" target="_blank">TrenchBroom</a> documentation for more information.
                 </td>
             </tr>
-
+            
             <tr class="header"><td>Node Generation</td><td></td><td></td></tr>
             <tr>
                 <td>Node Class</td>
@@ -234,7 +235,7 @@ <h2 id="Solid">FuncGodotFGDSolidClass</h2>
                     </ul>
                 </td>
             </tr>
-
+            
             <tr class="header"><td>Visual Build</td><td></td><td></td></tr>
             <tr>
                 <td>Build Visuals</td>
@@ -268,7 +269,7 @@ <h2 id="Solid">FuncGodotFGDSolidClass</h2>
                 <td>Int, 3D Render Flags</td>
                 <td>This Solid Class' MeshInstance3D will only be visible for Camera3Ds whose cull mask includes any of these render layers.</td>
             </tr>
-
+            
             <tr class="header"><td>Collision Build</td><td></td><td></td></tr>
             <tr>
                 <td>Collision Shape Type</td>
@@ -317,6 +318,66 @@ <h2 id="Solid">FuncGodotFGDSolidClass</h2>
                     for details.
                 </td>
             </tr>
+
+            <tr class="header">
+                <td>Mesh Metadata</td>
+                <td></td>
+                <td>
+                    The following properties tell FuncGodot to add a <i>"func_godot_mesh_data"</i> Dictionary to the metadata of the generated node upon build. 
+                    This data is parallelized, so that each element of the array is ordered to reference the same face in the mesh.
+                </td>
+            </tr>
+            <tr>
+                <td>Add Textures Metadata</td>
+                <td>Bool</td>
+                <td>
+                    Add a texture lookup table to the generated node's metadata on build.<br><br> 
+                    The data is split between an Array of <a href="https://docs.godotengine.org/en/stable/classes/class_stringname.html" target="_blank">StringName</a> 
+                    called <i>"texture_names"</i> containing all currently used texture materials and a 
+                    <a href="https://docs.godotengine.org/en/stable/classes/class_packedint32array.html" target="_blank">PackedInt32Array</a> 
+                    called <i>"textures"</i> where each element is an index corresponding to the <i>"texture_names"</i> entries.
+                </td>
+            </tr>
+            <tr>
+                <td>Add Vertex Metadata</td>
+                <td>Bool</td>
+                <td>
+                    Add a <a href="https://docs.godotengine.org/en/stable/classes/class_packedvector3array.html" target="_blank">PackedVector3Array</a> 
+                    called <i>"vertices"</i> to the generated node's metadata on build.<br><br> 
+                    This is a list of every vertex in the generated node's <i>MeshInstance3D</i>. Every 3 vertices represent a single face.
+                </td>
+            </tr>
+            <tr>
+                <td>Add Face Position Metadata</td>
+                <td>Bool</td>
+                <td>
+                    Add a <i>PackedVector3Array</i> called <i>"positions"</i> to the generated node's metadata on build.<br><br> 
+                    This is a list of positions for each face, local to the generated node, calculated by averaging the face's vertices to find its center.
+                </td>
+            </tr>
+            <tr>
+                <td>Add Face Normal Metadata</td>
+                <td>Bool</td>
+                <td>
+                    Add a <i>PackedVector3Array</i> called <i>"normals"</i> in the generated node's metadata on build.<br><br> 
+                    Contains a list of each face's normal.
+                </td>
+            </tr>
+            <tr>
+                <td>Add Collision Shape Face Range Metadata</td>
+                <td>Bool</td>
+                <td>
+                    Add a <i>Dictionary</i> called <i>"collision_shape_to_face_range_map"</i> to the generated node's metadata on build.<br><br> 
+                    Contains keys of <i>Strings</i>, which are the names of child <i>CollisionShape3D</i> nodes, and values of 
+                    <a href="https://docs.godotengine.org/en/stable/classes/class_vector2i.html" target="_blank">Vector2i</a> 
+                    where the <i>X</i> represents the starting index of that child's faces and the <i>Y</i> represents the
+                    ending index.<br><br>
+                    For example, an element of<br>
+                    <code>{ "entity_1_brush_0_collision_shape" : Vector2i(0, 15) }</code><br>
+                    shows that this solid class has been generated with one child collision shape named <i>entity_1_brush_0_collision_shape</i>
+                    which handles the first 15 faces of the parts of the mesh with collision.
+                </td>
+            </tr>
 
             <tr class="header"><td>Scripting</td><td></td><td></td></tr>
             <tr>

diff --git a/FuncGodot Manual/pages/ref_func_godot_map.html b/FuncGodot Manual/pages/ref_func_godot_map.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>FuncGodot Map Node</h1>
         <p><img src="../images/ref_func_godot_map.png"></p>

diff --git a/FuncGodot Manual/pages/ref_key_value_pairs.html b/FuncGodot Manual/pages/ref_key_value_pairs.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>Entity Key Value Pairs</h1>
         <p>

diff --git a/FuncGodot Manual/pages/ref_local_config.html b/FuncGodot Manual/pages/ref_local_config.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>FuncGodotLocalConfig</h1>
         <p><img src="../images/ref_local_config.png"></p>

diff --git a/FuncGodot Manual/pages/ref_netradiant_custom_resources.html b/FuncGodot Manual/pages/ref_netradiant_custom_resources.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>NetRadiant Custom Resources</h1>
         <p>

diff --git a/FuncGodot Manual/pages/ref_trenchbroom_resources.html b/FuncGodot Manual/pages/ref_trenchbroom_resources.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1>TrenchBroom Resources</h1>
         <p>

diff --git a/FuncGodot Manual/pages/sidenav.html b/FuncGodot Manual/pages/sidenav.html
@@ -3,10 +3,10 @@
 <head>
     <title>FuncGodot Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
-    <div class="sidenav">
+<body class="sidenav">
+    <div>
         <p class="sidenav"><a href="start.html" target="main">What <i>IS</i> FuncGodot?</a></p>
         <!--<p class="sidenav2"><a href="start.html#Credits" target="main">Who <i>MADE</i> FuncGodot?</a></p>-->
         <h3 class="sidenav">Getting Started</h3>

diff --git a/FuncGodot Manual/pages/start.html b/FuncGodot Manual/pages/start.html
@@ -3,9 +3,9 @@
 <head>
     <title>FuncGodot v2024.2 Manual</title>
     <link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
-    <link rel="stylesheet" href="../styles.css">
+    <link rel="stylesheet" href="styles.css">
 </head>
-<body>
+<body class="main">
     <div class="main">
         <h1 style="text-align:center;"><img src="../images/godot_ranger.svg" alt="FuncGodot Ranger" height="128"><br>What <i>IS</i> FuncGodot?</h1>
         <p>