Describe the river placement, routing and grotto pool enums for the schema

This commit is contained in:
Brian Neumann-Fopiano committed 2026-09-02 11:46:29 -04:00
1 parent 1c577fc580
commit e63fd9c448
5 files changed
+70 -2

No files matched your search

@@ -1,5 +1,9 @@
package art.arcane.iris.engine.object;
import art.arcane.iris.engine.object.annotations.Desc;
@Desc("Where the pool at the bottom of a coastal grotto sits.")
public enum IrisGrottoPoolLevel {
@Desc("The pool surface sits at the dimension fluid height, so the grotto meets the sea.")
SEA_LEVEL
}
@@ -1,9 +1,17 @@
package art.arcane.iris.engine.object;
import art.arcane.iris.engine.object.annotations.Desc;
@Desc("Controls whether river sources may start inside a dimension, region or biome, and how strongly they are drawn there.")
public enum IrisRiverPlacementMode {
@Desc("No river source may start here. Rivers may still pass through when routing allows it.")
DISABLED,
@Desc("Rivers may pass through, but no source starts here.")
TRANSIT_ONLY,
@Desc("Sources start here on their own merits, ranked like everywhere else.")
NATURAL,
@Desc("Eligible source sites here rank ahead of sites elsewhere in the tile.")
PREFERRED_HEADWATER,
@Desc("At least one source starts here whenever a site can reach a legal outlet; sources.minimumPerTile can raise that quota.")
REQUIRED_HEADWATER
}
@@ -1,8 +1,15 @@
package art.arcane.iris.engine.object;
import art.arcane.iris.engine.object.annotations.Desc;
@Desc("Controls whether river routes may pass through a dimension, region or biome, and at what cost.")
public enum IrisRiverRoutingMode {
@Desc("Rivers never route through here.")
BLOCK,
@Desc("Rivers route through here only when no cheaper path exists; transit carries a strong cost.")
AVOID,
@Desc("Rivers route through here at the normal cost.")
ALLOW,
@Desc("Rivers route through here at a reduced cost, so routes are drawn toward this area.")
PREFER
}