document pipeline stages

This commit is contained in:
dfsek 2021-04-26 12:13:58 -07:00
parent 4cdcdc0fee
commit c5bd7e7646
4 changed files with 33 additions and 0 deletions

View File

@ -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<BiomeBuilder> defaultTo;
/**
* Map of single biomes to their replacements.
*/
@Value("replace")
private Map<BiomeBuilder, ProbabilityCollection<BiomeBuilder>> replace;

View File

@ -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<BiomeBuilder> to;

View File

@ -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;

View File

@ -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<BiomeBuilder> to;