Class MimicLocalMap

java.lang.Object
com.github.yellowstonegames.world.WorldMapGenerator
com.github.yellowstonegames.world.LocalMap
com.github.yellowstonegames.world.MimicLocalMap
public class MimicLocalMap extends LocalMap
An unusual map generator that imitates an existing local map (such as a map of Australia, which it can do by default), without applying any projection or changing heat levels in the polar regions or equator. Example map, showing a variant on Australia

  • Field Details

    • earth

      public com.github.yellowstonegames.grid.Region earth

    • shallow

      public com.github.yellowstonegames.grid.Region shallow

    • coast

      public com.github.yellowstonegames.grid.Region coast

    • earthOriginal

      public com.github.yellowstonegames.grid.Region earthOriginal

    • buffer

      protected final transient com.github.yellowstonegames.grid.Region buffer

    • AUSTRALIA_ENCODED

      public static final String AUSTRALIA_ENCODED
      Stores a 256x256 Region that shows an unprojected map of Australia, in a format that can be read back with Region.decompress(String). By using Region's compression, this takes up a lot less room than it would with most text-based formats, and even beats uncompressed binary storage of the map by a factor of 9.4f. The map data won't change here, so this should stay compatible.
      This was flipped twice, once early in 2023, and once to undo that in late 2025.
      See Also:

  • Constructor Details

    • MimicLocalMap

      public MimicLocalMap()
      Constructs a concrete WorldMapGenerator for a map that should look like Australia, without projecting the land positions or changing heat by latitude. Always makes a 256x256 map. Uses Noise as its noise generator, with 1f as the octave multiplier affecting detail. If you were using MimicLocalMap(long, INoise, float), then this would be the same as passing the parameters 0x1337BABE1337D00DL, new Noise(DEFAULT_NOISE), 1f.

    • MimicLocalMap

      public MimicLocalMap(com.github.yellowstonegames.grid.Region toMimic)
      Constructs a concrete WorldMapGenerator for a map that should have land in roughly the same places as the given Region's "on" cells, without projecting the land positions or changing heat by latitude. The initial seed is set to the same large long every time, and it's likely that you would set the seed when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact. Uses Noise as its noise generator, with 1f as the octave multiplier affecting detail.
      Parameters:
      toMimic - the world map to imitate, as a Region with land as "on"; the height and width will be copied

    • MimicLocalMap

      public MimicLocalMap(long initialSeed, com.github.yellowstonegames.grid.Region toMimic)
      Constructs a concrete WorldMapGenerator for a map that should have land in roughly the same places as the given Region's "on" cells, without projecting the land positions or changing heat by latitude. Takes an initial seed and the Region containing land positions. The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact. Uses Noise as its noise generator, with 1f as the octave multiplier affecting detail.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      toMimic - the world map to imitate, as a Region with land as "on"; the height and width will be copied

    • MimicLocalMap

      public MimicLocalMap(long initialSeed, com.github.yellowstonegames.grid.Region toMimic, float octaveMultiplier)
      Constructs a concrete WorldMapGenerator for a map that should have land in roughly the same places as the given Region's "on" cells, without projecting the land positions or changing heat by latitude. Takes an initial seed, the Region containing land positions, and a multiplier that affects the level of detail by increasing or decreasing the number of octaves of noise used. The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact. Uses Noise as its noise generator, with the given octave multiplier affecting detail.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      toMimic - the world map to imitate, as a Region with land as "on"; the height and width will be copied
      octaveMultiplier - used to adjust the level of detail, with 0.5f at the bare-minimum detail and 1f normal

    • MimicLocalMap

      public MimicLocalMap(long initialSeed, com.github.yellowstonegames.grid.Region toMimic, com.github.yellowstonegames.grid.INoise noiseGenerator)
      Constructs a concrete WorldMapGenerator for a map that should have land in roughly the same places as the given Region's "on" cells, without projecting the land positions or changing heat by latitude. Takes an initial seed, the Region containing land positions, and parameters for noise generation (a Noise implementation, which is usually Noise.instance. The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact. Both Noise and Noise make sense to use for noiseGenerator, and the seed it's constructed with doesn't matter because this will change the seed several times at different scales of noise (it's fine to use the static Noise.instance or Noise.instance because they have no changing state between runs of the program). Uses the given noise generator, with 1f as the octave multiplier affecting detail.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      toMimic - the world map to imitate, as a Region with land as "on"; the height and width will be copied
      noiseGenerator - an instance of a noise generator capable of 3D noise, usually Noise or Noise

    • MimicLocalMap

      public MimicLocalMap(long initialSeed, com.github.yellowstonegames.grid.Region toMimic, com.github.yellowstonegames.grid.INoise noiseGenerator, float octaveMultiplier)
      Constructs a concrete WorldMapGenerator for a map that should have land in roughly the same places as the given Region's "on" cells, using an elliptical projection (specifically, a Mollweide projection). Takes an initial seed, the Region containing land positions, parameters for noise generation (a Noise implementation, which is usually Noise.instance, and a multiplier on how many octaves of noise to use, with 1f being normal (high) detail and higher multipliers producing even more detailed noise when zoomed-in). The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact. Noise will be the fastest 3D generator to use for noiseGenerator, and the seed it's constructed with doesn't matter because this will change the seed several times at different scales of noise (it's fine to use the static Noise.instance because it has no changing state between runs of the program). The octaveMultiplier parameter should probably be no lower than 0.5f, but can be arbitrarily high if you're willing to spend much more time on generating detail only noticeable at very high zoom; normally 1f is fine and may even be too high for maps that don't require zooming.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      toMimic - the world map to imitate, as a Region with land as "on"; the height and width will be copied
      noiseGenerator - an instance of a noise generator capable of 3D noise, usually Noise or Noise
      octaveMultiplier - used to adjust the level of detail, with 0.5f at the bare-minimum detail and 1f normal

    • MimicLocalMap

      public MimicLocalMap(int width, int height, String serialized)
      Creates a new generator from the given serialized String, produced by stringSerialize(), but this also requires width and height that match the first two lines of the given String (in Base.BASE86). It is almost always easier to use recreateFromString(String) instead.
      Parameters:
      width - width of the map or maps to generate; must match the first line of the given String in Base.BASE86
      height - height of the map or maps to generate; must match the second line of the given String in Base.BASE86
      serialized - should have been produced by stringSerialize()

    • MimicLocalMap

      public MimicLocalMap(long initialSeed)
      Constructs a 256x256 unprojected local map that will use land forms with a similar shape to Australia.
      Parameters:
      initialSeed -

    • MimicLocalMap

      public MimicLocalMap(long initialSeed, com.github.yellowstonegames.grid.INoise noiseGenerator, float octaveMultiplier)
      Constructs a 256x256 unprojected local map that will use land forms with a similar shape to Australia.
      Parameters:
      initialSeed -
      noiseGenerator -
      octaveMultiplier -

    • MimicLocalMap

      public MimicLocalMap(MimicLocalMap other)
      Copies the MimicLocalMap other to construct a new one that is exactly the same. References will only be shared to Noise classes.
      Parameters:
      other - a MimicLocalMap to copy

  • Method Details

    • stringSerialize

      public String stringSerialize()
      Serializes this generator's entire state to a String; it can be read back when creating a new instance of this type with MimicLocalMap(int, int, String) or (preferably) recreateFromString(String). Uses Base.BASE86 to represent values very concisely, but not at all readably. The String this produces tends to be very long because it includes several 2D arrays and a Region as Strings.
      Overrides:
      stringSerialize in class LocalMap
      Returns:
      a String that stores the entire state of this generator

    • recreateFromString

      public static MimicLocalMap recreateFromString(String data)
      Creates a new instance of this class from a serialized String produced by stringSerialize(). This can get the width and height from the String, which makes this probably preferable to using the constructor MimicLocalMap(int, int, String). This stores the last-generated map in this WorldMapGenerator, where it can be used by other code like a WorldMapView.
      Parameters:
      data - the output of stringSerialize()
      Returns:
      the map that was serialized, as a new generator

    • regenerate

      protected void regenerate(int startX, int startY, int usedWidth, int usedHeight, float landMod, float heatMod, long stateA, long stateB)
      Overrides:
      regenerate in class LocalMap

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class LocalMap

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class LocalMap

    • toString

      public String toString()
      Overrides:
      toString in class LocalMap