From c5bd7e7646b0351f9fff32bce23f64ff93eb56fd Mon Sep 17 00:00:00 2001 From: dfsek Date: Mon, 26 Apr 2021 12:13:58 -0700 Subject: [PATCH] document pipeline stages --- .../stage/mutator/BorderListMutatorTemplate.java | 13 +++++++++++++ .../stage/mutator/BorderMutatorTemplate.java | 11 +++++++++++ .../stage/mutator/ReplaceListMutatorTemplate.java | 3 +++ .../stage/mutator/ReplaceMutatorTemplate.java | 6 ++++++ 4 files changed, 33 insertions(+) diff --git a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderListMutatorTemplate.java b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderListMutatorTemplate.java index a38ce64c8..80c0100d6 100644 --- a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderListMutatorTemplate.java +++ b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderListMutatorTemplate.java @@ -14,15 +14,28 @@ import java.util.Map; @SuppressWarnings("unused") @AutoDocAlias("BorderListMutator") public class BorderListMutatorTemplate extends MutatorStageTemplate { + /** + * Tag of the biome on the external side of the border. + */ @Value("from") private String from; + /** + * Tag of biomes to replace when bordering biomes with + * tag "from". + */ @Value("default-replace") private String defaultReplace; + /** + * Default replacement biomes. + */ @Value("default-to") private ProbabilityCollection defaultTo; + /** + * Map of single biomes to their replacements. + */ @Value("replace") private Map> replace; diff --git a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderMutatorTemplate.java b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderMutatorTemplate.java index 47b3c2cbf..28d851e9d 100644 --- a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderMutatorTemplate.java +++ b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/BorderMutatorTemplate.java @@ -10,12 +10,23 @@ import com.dfsek.terra.config.builder.BiomeBuilder; @SuppressWarnings("unused") @AutoDocAlias("BorderMutator") public class BorderMutatorTemplate extends MutatorStageTemplate { + /** + * Tag of the biome on the external side of the border. + */ @Value("from") private String from; + /** + * Tag of biomes to replace when bordering biomes + * with tag "from" + */ @Value("replace") private String replace; + /** + * Collection of biomes to place at borders + * of "from" and "to" + */ @Value("to") private ProbabilityCollection to; diff --git a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceListMutatorTemplate.java b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceListMutatorTemplate.java index a8c6bf98b..adcef1aaa 100644 --- a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceListMutatorTemplate.java +++ b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceListMutatorTemplate.java @@ -14,6 +14,9 @@ import java.util.Map; @SuppressWarnings("unused") @AutoDocAlias("ReplaceListMutator") public class ReplaceListMutatorTemplate extends MutatorStageTemplate { + /** + * Default tag to replace from + */ @Value("default-from") private String defaultFrom; diff --git a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceMutatorTemplate.java b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceMutatorTemplate.java index 4bfa4a2a1..d285f01c1 100644 --- a/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceMutatorTemplate.java +++ b/common/src/main/java/com/dfsek/terra/config/loaders/config/biome/templates/stage/mutator/ReplaceMutatorTemplate.java @@ -10,9 +10,15 @@ import com.dfsek.terra.config.builder.BiomeBuilder; @SuppressWarnings("unused") @AutoDocAlias("ReplaceMutator") public class ReplaceMutatorTemplate extends MutatorStageTemplate { + /** + * Tag of biomes to replace. + */ @Value("from") private String from; + /** + * Biomes to replace with. + */ @Value("to") private ProbabilityCollection to;