From 5785aa4bcc8b77b89dd1495814d3b05c784428dd Mon Sep 17 00:00:00 2001 From: ChampionAsh5357 Date: Tue, 15 Oct 2024 13:10:42 -0400 Subject: [PATCH] feat(docs): Update misc section --- docs/misc/config.md | 7 ++++++- docs/misc/debugprofiler.md | 6 +++--- docs/misc/gametest.md | 2 +- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/misc/config.md b/docs/misc/config.md index 2f5aa57b..1c15a1c2 100644 --- a/docs/misc/config.md +++ b/docs/misc/config.md @@ -18,7 +18,12 @@ A configuration can be created using a subtype of `IConfigSpec`. NeoForge implem //Define a field to keep the config and spec for later public static final ExampleConfig CONFIG; public static final ModConfigSpec CONFIG_SPEC; - + +private ExampleConfig(ModConfigSpec.Builder builder) { + // Define properties used by the configuration + // ... +} + //CONFIG and CONFIG_SPEC are both built from the same builder, so we use a static block to seperate the properties static { Pair pair = diff --git a/docs/misc/debugprofiler.md b/docs/misc/debugprofiler.md index f90f99c0..c187c13c 100644 --- a/docs/misc/debugprofiler.md +++ b/docs/misc/debugprofiler.md @@ -42,9 +42,9 @@ Here is a small explanation of what each part means: The Debug Profiler has basic support for `Entity` and `BlockEntity`. If you would like to profile something else, you may need to manually create your sections like so: ```java -ProfilerFiller#push(yourSectionName : String); +Profiler.get().push("yourSectionName"); //The code you want to profile -ProfilerFiller#pop(); +Profiler.get().pop(); ``` -You can obtain the `ProfilerFiller` instance from a `Level`, `MinecraftServer`, or `Minecraft` instance. + Now you just need to search the results file for your section name. diff --git a/docs/misc/gametest.md b/docs/misc/gametest.md index 4702ae51..3912ab04 100644 --- a/docs/misc/gametest.md +++ b/docs/misc/gametest.md @@ -249,7 +249,7 @@ There must be no spaces in-between namespaces; otherwise, the namespace will not The Game Test Server is a special configuration which runs a build server. The build server returns an exit code of the number of required, failed Game Tests. All failed tests, whether required or optional, are logged. This server can be run using `gradlew runGameTestServer`.
-Important infromation on NeoGradle +Important information on NeoGradle :::caution Due to a quirk in how Gradle works, by default, if a task forces a system exit, the Gradle daemon will be killed, causing the Gradle runner to report a build failure. NeoGradle sets by default a force exit on run tasks such that any subprojects are not executed in sequence. However, as such, the Game Test Server will always fail.