From 85ecdbc66edcde7f195eac1280e6b46f94461dc0 Mon Sep 17 00:00:00 2001 From: Max Litruv Boonzaayer Date: Thu, 30 Jan 2025 10:08:17 +1100 Subject: [PATCH] Add DeepImpact documentation and update references in app configuration --- docs/.obsidian/app.json | 4 +++- docs/.obsidian/workspace.json | 22 +++++++++---------- ...Blueprint Depth Trace.md => DeepImpact.md} | 13 +++++------ docs/index.md | 2 +- index.json | 6 ++--- 5 files changed, 24 insertions(+), 23 deletions(-) rename docs/{Blueprint Depth Trace.md => DeepImpact.md} (87%) diff --git a/docs/.obsidian/app.json b/docs/.obsidian/app.json index 9e26dfe..6abe4c1 100644 --- a/docs/.obsidian/app.json +++ b/docs/.obsidian/app.json @@ -1 +1,3 @@ -{} \ No newline at end of file +{ + "alwaysUpdateLinks": true +} \ No newline at end of file diff --git a/docs/.obsidian/workspace.json b/docs/.obsidian/workspace.json index 7817f7a..b3dcde9 100644 --- a/docs/.obsidian/workspace.json +++ b/docs/.obsidian/workspace.json @@ -13,12 +13,12 @@ "state": { "type": "markdown", "state": { - "file": "index.md", + "file": "DeepImpact.md", "mode": "source", "source": false }, "icon": "lucide-file", - "title": "index" + "title": "DeepImpact" } } ] @@ -93,7 +93,7 @@ "state": { "type": "backlink", "state": { - "file": "index.md", + "file": "DeepImpact.md", "collapseAll": false, "extraContext": false, "sortOrder": "alphabetical", @@ -103,7 +103,7 @@ "unlinkedCollapsed": true }, "icon": "links-coming-in", - "title": "Backlinks for index" + "title": "Backlinks for DeepImpact" } }, { @@ -112,12 +112,12 @@ "state": { "type": "outgoing-link", "state": { - "file": "index.md", + "file": "DeepImpact.md", "linksCollapsed": false, "unlinkedCollapsed": true }, "icon": "links-going-out", - "title": "Outgoing links from index" + "title": "Outgoing links from DeepImpact" } }, { @@ -139,10 +139,10 @@ "state": { "type": "outline", "state": { - "file": "index.md" + "file": "DeepImpact.md" }, "icon": "lucide-list", - "title": "Outline of index" + "title": "Outline of DeepImpact" } } ] @@ -164,8 +164,8 @@ }, "active": "1eda716d35acafe8", "lastOpenFiles": [ - "Blueprint Penetration Trace.md", - "Blueprint Depth Trace.md", - "index.md" + "index.md", + "DeepImpact.md", + "Blueprint Penetration Trace.md" ] } \ No newline at end of file diff --git a/docs/Blueprint Depth Trace.md b/docs/DeepImpact.md similarity index 87% rename from docs/Blueprint Depth Trace.md rename to docs/DeepImpact.md index a5bac2b..279a202 100644 --- a/docs/Blueprint Depth Trace.md +++ b/docs/DeepImpact.md @@ -1,7 +1,6 @@ --- -title: Blueprint Depth Trace -description: A Blueprint Function Library for depth-based line traces in Unreal Engine, providing realistic penetration and bullet holes -image: TraceExample.png +title: DeepImpact +description: A Blueprint Function Library for depth-based line traces in Unreal Engine, providing realistic penetration and bullet hole positioning --- This is a `Blueprint Function Library` with a few functions that are callable in `AActors` to do depth trace results, for use in things like projectiles and tools. @@ -32,10 +31,10 @@ Depth Trace by Profile | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Start** | Start of the Trace | | **End** | End of the Trace | -| **Trace Complex** | If the trace will use [Complex Collision](https://dev.epicgames.com/documentation/en-us/unreal-engine/simple-versus-complex-collision-in-unreal-engine) | -| **Actors To Ignore** | Array of Actors, to ignore while tracing | +| **Trace Complex** | If the trace will use [`Complex Collision`](https://dev.epicgames.com/documentation/en-us/unreal-engine/simple-versus-complex-collision-in-unreal-engine) | +| **Actors To Ignore** | Array of `AActor`s, to ignore while tracing | | **Draw Debug Type** | Draw Debug Arrows over Time, or Persistently | -| **Ignore Self** | If the traces should ignore the Current actor (Self) | +| **Ignore Self** | If the traces should ignore the Current actor (`Self`) | | **Trace Color** | The color of the trace, when it's not going through anything. | | **Trace Hit Color** | The color of the trace, when it's going through something. | | **Draw Time** | Amount of time to draw debug lines (if not persistent) | @@ -63,7 +62,7 @@ For more detailed instructions on adding a custom object type to your project, y ## Physical materials (optional) -Default [Physical Material](https://dev.epicgames.com/documentation/en-us/unreal-engine/physical-materials-user-guide-for-unreal-engine) properties are at **1 g/cm**, but adding more physical properties into your game can add extra depth. +Default [`Physical Material`](https://dev.epicgames.com/documentation/en-us/unreal-engine/physical-materials-user-guide-for-unreal-engine) properties are at **1 g/cm³**, but adding more physical properties into your game can add extra depth. ### Example Material Densities | Material | Density (g/cm³) | diff --git a/docs/index.md b/docs/index.md index c80b85a..f35ad9a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ Here you'll find documentation for various tools and projects I've created. Sele ## Available Documentation -- **[[Blueprint Depth Trace]]** - A Blueprint Function Library for depth-based line traces in Unreal Engine +- **[[DeepImpact]]** - A Blueprint Function Library for depth-based line traces in Unreal Engine - More documentation coming soon... ## Getting Help diff --git a/index.json b/index.json index 1114a6b..7001015 100644 --- a/index.json +++ b/index.json @@ -10,9 +10,9 @@ "type": "folder", "items": [ { - "title": "Blueprint Depth Trace", - "path": "docs/Blueprint Depth Trace.md", - "slug": "blueprint-depth-trace" + "title": "DeepImpact", + "path": "docs/DeepImpact.md", + "slug": "deep-impact" } ] }