deploy: de424a4

index.html

@@ -11,7 +11,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.9.2"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>SturdyPath: SturdyPath</title>
+<title>SturdyPath: Sturdy Path</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -95,11 +95,30 @@
 </div>
 
 <div><div class="header">
-  <div class="headertitle"><div class="title">SturdyPath </div></div>
+  <div class="headertitle"><div class="title">Sturdy Path </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p ><a class="anchor" id="md__github_workspace_README"></a></p>
-</div></div><!-- PageDoc -->
+<div class="textblock"><p ><a class="anchor" id="md__github_workspace_README"></a> Sturdy Path is a Godot .NET addon that provides a way to reference a scene or resource by path, in a manner that won't break when moving files around within the project. This is accomplished by keeping track of the target file's <code>uid://</code> path, which is invariant of the file's location within the project.</p>
+<p ><img src="https://github.com/user-attachments/assets/5efec515-aa99-4f41-a93e-d01a8d8e5a43" alt="image" class="inline"/></p>
+<h1><a class="anchor" id="autotoc_md1"></a>
+Example Usage</h1>
+<div class="fragment"><div class="line">{BattleEffect.cs} </div>
+<div class="line">using MPewsey.SturdyPath;</div>
+<div class="line"> </div>
+<div class="line">public partial class BattleEffect : Resource</div>
+<div class="line">{</div>
+<div class="line">    // Create an exported SturdyPathRef property for the scene or resource you wish to reference by path.</div>
+<div class="line">    [Export] public SturdyPathRef VfxScenePath { get; set; }</div>
+<div class="line"> </div>
+<div class="line">    // Use the SturdyPathRef.Load method to load the resource for use per typical Godot usage patterns.</div>
+<div class="line">    public void SpawnVfx(Node parent)</div>
+<div class="line">    {</div>
+<div class="line">        var scene = VfxScenePath.Load&lt;PackedScene&gt;();</div>
+<div class="line">        var vfx = scene.Instantiate();</div>
+<div class="line">        parent.AddChild(vfx);</div>
+<div class="line">    }</div>
+<div class="line">}</div>
+</div><!-- fragment --> </div></div><!-- PageDoc -->
 </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

navtreedata.js

@@ -25,6 +25,9 @@
 var NAVTREE =
 [
   [ "SturdyPath", "index.html", [
+    [ "Sturdy Path", "index.html", [
+      [ "Example Usage", "index.html#autotoc_md1", null ]
+    ] ],
     [ "Packages", "namespaces.html", [
       [ "Packages", "namespaces.html", "namespaces_dup" ]
     ] ],

navtreeindex0.js

@@ -1,49 +1,51 @@
 var NAVTREEINDEX0 =
 {
-"_sturdy_path_ref_8cs_source.html":[2,0,0,0,0,0,0],
-"annotated.html":[1,0],
+"_sturdy_path_ref_8cs_source.html":[3,0,0,0,0,0,0],
+"annotated.html":[2,0],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html":[2,0,0,0,0],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html":[1,0,0,0,0],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html":[0,0,0,0,0],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a082cd62c43e6b9e294d8fb851765693e":[2,0,0,0,0,3],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a082cd62c43e6b9e294d8fb851765693e":[1,0,0,0,0,3],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a082cd62c43e6b9e294d8fb851765693e":[0,0,0,0,0,3],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a0a09e5aa1e62461ddf543866aea3e921":[0,0,0,0,0,6],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a0a09e5aa1e62461ddf543866aea3e921":[2,0,0,0,0,6],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a0a09e5aa1e62461ddf543866aea3e921":[1,0,0,0,0,6],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a17daee0ad0af91cf977545764c54ce8a":[2,0,0,0,0,4],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a17daee0ad0af91cf977545764c54ce8a":[1,0,0,0,0,4],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a17daee0ad0af91cf977545764c54ce8a":[0,0,0,0,0,4],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a3d665ebae284fbfdd65cc6a31c93c5af":[0,0,0,0,0,1],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a3d665ebae284fbfdd65cc6a31c93c5af":[2,0,0,0,0,1],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a3d665ebae284fbfdd65cc6a31c93c5af":[1,0,0,0,0,1],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a45a1edf30521e856c66a5fcdd0736fcf":[1,0,0,0,0,12],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a45a1edf30521e856c66a5fcdd0736fcf":[0,0,0,0,0,12],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a52827c00253a20b4d23077f5d402170e":[0,0,0,0,0,0],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a45a1edf30521e856c66a5fcdd0736fcf":[2,0,0,0,0,12],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a52827c00253a20b4d23077f5d402170e":[1,0,0,0,0,0],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a52827c00253a20b4d23077f5d402170e":[2,0,0,0,0,0],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5b27376800f54c862ac710cc65936a24":[1,0,0,0,0,2],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5b27376800f54c862ac710cc65936a24":[0,0,0,0,0,2],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5dd75a0f9e722c757a41935133e8d107":[0,0,0,0,0,7],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5b27376800f54c862ac710cc65936a24":[2,0,0,0,0,2],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5dd75a0f9e722c757a41935133e8d107":[2,0,0,0,0,7],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5dd75a0f9e722c757a41935133e8d107":[1,0,0,0,0,7],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a9601718a5dd84e154e7f489f8ac2b4f1":[0,0,0,0,0,9],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a9601718a5dd84e154e7f489f8ac2b4f1":[1,0,0,0,0,9],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#aa9dafb6e480f1d61eb50585a094baacb":[0,0,0,0,0,11],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a9601718a5dd84e154e7f489f8ac2b4f1":[2,0,0,0,0,9],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#aa9dafb6e480f1d61eb50585a094baacb":[1,0,0,0,0,11],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#abe0f624dd84799e13f0161d1ccf457c3":[0,0,0,0,0,8],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#aa9dafb6e480f1d61eb50585a094baacb":[2,0,0,0,0,11],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#abe0f624dd84799e13f0161d1ccf457c3":[2,0,0,0,0,8],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#abe0f624dd84799e13f0161d1ccf457c3":[1,0,0,0,0,8],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ace1ebe7a20119d26725ebe592a23e5bd":[0,0,0,0,0,10],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ace1ebe7a20119d26725ebe592a23e5bd":[2,0,0,0,0,10],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ace1ebe7a20119d26725ebe592a23e5bd":[1,0,0,0,0,10],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ad5ee1c8c52082051ae333ca863af4dbc":[2,0,0,0,0,5],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ad5ee1c8c52082051ae333ca863af4dbc":[1,0,0,0,0,5],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ad5ee1c8c52082051ae333ca863af4dbc":[0,0,0,0,0,5],
-"classes.html":[1,1],
-"dir_1233bc0a3e869c10318208e4553a4fcb.html":[2,0,0],
-"dir_a5547802c643510176416013a9f6e00c.html":[2,0,0,0,0],
-"dir_b1ed97a5631d708b54c64f68a7ab468d.html":[2,0,0,0],
-"dir_d9578470ebd20619821dd6e979e6987a.html":[2,0,0,0,0,0],
-"files.html":[2,0],
-"functions.html":[1,3,0],
-"functions_func.html":[1,3,1],
-"functions_prop.html":[1,3,3],
-"functions_vars.html":[1,3,2],
-"hierarchy.html":[1,2],
+"classes.html":[2,1],
+"dir_1233bc0a3e869c10318208e4553a4fcb.html":[3,0,0],
+"dir_a5547802c643510176416013a9f6e00c.html":[3,0,0,0,0],
+"dir_b1ed97a5631d708b54c64f68a7ab468d.html":[3,0,0,0],
+"dir_d9578470ebd20619821dd6e979e6987a.html":[3,0,0,0,0,0],
+"files.html":[3,0],
+"functions.html":[2,3,0],
+"functions_func.html":[2,3,1],
+"functions_prop.html":[2,3,3],
+"functions_vars.html":[2,3,2],
+"hierarchy.html":[2,2],
+"index.html":[0],
 "index.html":[],
-"namespace_m_pewsey.html":[0,0,0],
-"namespace_m_pewsey_1_1_sturdy_path.html":[0,0,0,0],
-"namespaces.html":[0,0],
+"index.html#autotoc_md1":[0,0],
+"namespace_m_pewsey.html":[1,0,0],
+"namespace_m_pewsey_1_1_sturdy_path.html":[1,0,0,0],
+"namespaces.html":[1,0],
 "pages.html":[]
 };

search/all_5.js

@@ -1,6 +1,6 @@
 var searchData=
 [
   ['setrespath_0',['SetResPath',['../class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5dd75a0f9e722c757a41935133e8d107',1,'MPewsey::SturdyPath::SturdyPathRef']]],
-  ['sturdypath_1',['SturdyPath',['../index.html',1,'']]],
+  ['sturdy_20path_1',['Sturdy Path',['../index.html',1,'']]],
   ['sturdypathref_2',['SturdyPathRef',['../class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html',1,'SturdyPathRef'],['../class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a52827c00253a20b4d23077f5d402170e',1,'MPewsey.SturdyPath.SturdyPathRef.SturdyPathRef()']]]
 ];

search/pages_0.js

@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['sturdypath_0',['SturdyPath',['../index.html',1,'']]]
+  ['sturdy_20path_0',['Sturdy Path',['../index.html',1,'']]]
 ];