Skip to content

Commit 73a5a8e

Browse files
Update for 2024.3
Docs updated for new features, some minor corrections.
1 parent 585ff90 commit 73a5a8e

29 files changed

+132
-65
lines changed

FuncGodot Manual/FuncGodot Manual.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="images/godot_ranger.svg">
6-
<link rel="stylesheet" href="styles.css">
6+
<link rel="stylesheet" href="pages/styles.css">
77
</head>
88
<iframe name="main" class="main" src="pages/start.html" height="100%"></iframe>
99
<iframe name="sidenav" class="sidenav" src="pages/sidenav.html"></iframe>

FuncGodot Manual/pages/core_func_godot.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>CORE: FuncGodot</h1>
1111
</div>

FuncGodot Manual/pages/core_geo_generator.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>CORE: Geo Generator</h1>
1111
</div>

FuncGodot Manual/pages/core_map_data.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>CORE: Map Data</h1>
1111
</div>

FuncGodot Manual/pages/core_map_parser.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>CORE: Map Parser</h1>
1111
</div>

FuncGodot Manual/pages/core_surface_gatherer.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>CORE: Surface Gatherer</h1>
1111
</div>

FuncGodot Manual/pages/faq.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Frequently Asked Questions</h1>
1111

FuncGodot Manual/pages/guide_building_maps.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Building Maps</h1>
1111
<p>

FuncGodot Manual/pages/guide_fgd.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Forge Game Data</h1>
1111

FuncGodot Manual/pages/guide_install.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Installing FuncGodot</h1>
1111

FuncGodot Manual/pages/guide_map_editor_config.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Map Editor Configuration</h1>
1111
<p>

FuncGodot Manual/pages/guide_project_config.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Project Configuration</h1>
1111
<h3>Directory Structure</h3>

FuncGodot Manual/pages/guide_textures.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Textures</h1>
1111

FuncGodot Manual/pages/header.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="header">
99
<!-- Header Begin -->
10-
<div class="header"><img src="../images/godot_ranger.svg" height="50px" alt=""><img src="../images/logo_white.png" height="40px" alt="FuncGodot"></div>
10+
<div><img src="../images/godot_ranger.svg" height="50px" alt=""><img src="../images/logo_white.png" height="40px" alt="FuncGodot"></div>
1111
<!-- Header End -->
1212
</body>
1313
</html>

FuncGodot Manual/pages/helpful_links.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Helpful Links</h1>
1111

FuncGodot Manual/pages/ref_fgd_resources.html

+66-5
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>FuncGodot FGD Resources</h1>
1111

@@ -76,6 +76,7 @@ <h2 id="Entity">FuncGodotFGDEntityClass</h2>
7676
<td>Type</td>
7777
<td>Description</td>
7878
</tr>
79+
7980
<tr class="header"><td>Entity Definition</td><td></td><td></td></tr>
8081
<tr>
8182
<td>Classname</td>
@@ -129,7 +130,7 @@ <h2 id="Entity">FuncGodotFGDEntityClass</h2>
129130
and <a href="https://trenchbroom.github.io/manual/latest/#display-models-for-entities" target="_blank">TrenchBroom</a> documentation for more information.
130131
</td>
131132
</tr>
132-
133+
133134
<tr class="header"><td>Node Generation</td><td></td><td></td></tr>
134135
<tr>
135136
<td>Node Class</td>
@@ -234,7 +235,7 @@ <h2 id="Solid">FuncGodotFGDSolidClass</h2>
234235
</ul>
235236
</td>
236237
</tr>
237-
238+
238239
<tr class="header"><td>Visual Build</td><td></td><td></td></tr>
239240
<tr>
240241
<td>Build Visuals</td>
@@ -268,7 +269,7 @@ <h2 id="Solid">FuncGodotFGDSolidClass</h2>
268269
<td>Int, 3D Render Flags</td>
269270
<td>This Solid Class' MeshInstance3D will only be visible for Camera3Ds whose cull mask includes any of these render layers.</td>
270271
</tr>
271-
272+
272273
<tr class="header"><td>Collision Build</td><td></td><td></td></tr>
273274
<tr>
274275
<td>Collision Shape Type</td>
@@ -317,6 +318,66 @@ <h2 id="Solid">FuncGodotFGDSolidClass</h2>
317318
for details.
318319
</td>
319320
</tr>
321+
322+
<tr class="header">
323+
<td>Mesh Metadata</td>
324+
<td></td>
325+
<td>
326+
The following properties tell FuncGodot to add a <i>"func_godot_mesh_data"</i> Dictionary to the metadata of the generated node upon build.
327+
This data is parallelized, so that each element of the array is ordered to reference the same face in the mesh.
328+
</td>
329+
</tr>
330+
<tr>
331+
<td>Add Textures Metadata</td>
332+
<td>Bool</td>
333+
<td>
334+
Add a texture lookup table to the generated node's metadata on build.<br><br>
335+
The data is split between an Array of <a href="https://docs.godotengine.org/en/stable/classes/class_stringname.html" target="_blank">StringName</a>
336+
called <i>"texture_names"</i> containing all currently used texture materials and a
337+
<a href="https://docs.godotengine.org/en/stable/classes/class_packedint32array.html" target="_blank">PackedInt32Array</a>
338+
called <i>"textures"</i> where each element is an index corresponding to the <i>"texture_names"</i> entries.
339+
</td>
340+
</tr>
341+
<tr>
342+
<td>Add Vertex Metadata</td>
343+
<td>Bool</td>
344+
<td>
345+
Add a <a href="https://docs.godotengine.org/en/stable/classes/class_packedvector3array.html" target="_blank">PackedVector3Array</a>
346+
called <i>"vertices"</i> to the generated node's metadata on build.<br><br>
347+
This is a list of every vertex in the generated node's <i>MeshInstance3D</i>. Every 3 vertices represent a single face.
348+
</td>
349+
</tr>
350+
<tr>
351+
<td>Add Face Position Metadata</td>
352+
<td>Bool</td>
353+
<td>
354+
Add a <i>PackedVector3Array</i> called <i>"positions"</i> to the generated node's metadata on build.<br><br>
355+
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.
356+
</td>
357+
</tr>
358+
<tr>
359+
<td>Add Face Normal Metadata</td>
360+
<td>Bool</td>
361+
<td>
362+
Add a <i>PackedVector3Array</i> called <i>"normals"</i> in the generated node's metadata on build.<br><br>
363+
Contains a list of each face's normal.
364+
</td>
365+
</tr>
366+
<tr>
367+
<td>Add Collision Shape Face Range Metadata</td>
368+
<td>Bool</td>
369+
<td>
370+
Add a <i>Dictionary</i> called <i>"collision_shape_to_face_range_map"</i> to the generated node's metadata on build.<br><br>
371+
Contains keys of <i>Strings</i>, which are the names of child <i>CollisionShape3D</i> nodes, and values of
372+
<a href="https://docs.godotengine.org/en/stable/classes/class_vector2i.html" target="_blank">Vector2i</a>
373+
where the <i>X</i> represents the starting index of that child's faces and the <i>Y</i> represents the
374+
ending index.<br><br>
375+
For example, an element of<br>
376+
<code>{ "entity_1_brush_0_collision_shape" : Vector2i(0, 15) }</code><br>
377+
shows that this solid class has been generated with one child collision shape named <i>entity_1_brush_0_collision_shape</i>
378+
which handles the first 15 faces of the parts of the mesh with collision.
379+
</td>
380+
</tr>
320381

321382
<tr class="header"><td>Scripting</td><td></td><td></td></tr>
322383
<tr>

FuncGodot Manual/pages/ref_func_godot_map.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>FuncGodot Map Node</h1>
1111
<p><img src="../images/ref_func_godot_map.png"></p>

FuncGodot Manual/pages/ref_key_value_pairs.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>Entity Key Value Pairs</h1>
1111
<p>

FuncGodot Manual/pages/ref_local_config.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>FuncGodotLocalConfig</h1>
1111
<p><img src="../images/ref_local_config.png"></p>

FuncGodot Manual/pages/ref_netradiant_custom_resources.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>NetRadiant Custom Resources</h1>
1111
<p>

FuncGodot Manual/pages/ref_trenchbroom_resources.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1>TrenchBroom Resources</h1>
1111
<p>

FuncGodot Manual/pages/sidenav.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
<head>
44
<title>FuncGodot Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
9-
<div class="sidenav">
8+
<body class="sidenav">
9+
<div>
1010
<p class="sidenav"><a href="start.html" target="main">What <i>IS</i> FuncGodot?</a></p>
1111
<!--<p class="sidenav2"><a href="start.html#Credits" target="main">Who <i>MADE</i> FuncGodot?</a></p>-->
1212
<h3 class="sidenav">Getting Started</h3>

FuncGodot Manual/pages/start.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<title>FuncGodot v2024.2 Manual</title>
55
<link rel="icon" type="image/x-icon" href="../images/godot_ranger.svg">
6-
<link rel="stylesheet" href="../styles.css">
6+
<link rel="stylesheet" href="styles.css">
77
</head>
8-
<body>
8+
<body class="main">
99
<div class="main">
1010
<h1 style="text-align:center;"><img src="../images/godot_ranger.svg" alt="FuncGodot Ranger" height="128"><br>What <i>IS</i> FuncGodot?</h1>
1111
<p>

0 commit comments

Comments
 (0)