Consistent Map Stone Mod is a framework mod that allows other mods to consistently determine which stone type would appear at a given location on the map. Most players do not need to worry about how it works unless another mod requires it as a dependency.
Consistent Map Stone Features
For players, Consistent Map Stone Mod is designed to work quietly in the background and is compatible with virtually anything. You only need it if another mod depends on it.
FAQ
- Can I add this to an existing save? Yes. However, if your map was generated without Consistent Map Stone Mod, any dependent mods may use stone types that do not match the stone layout already present on that map. From that point onward, those mods will still remain consistent with each other.
- Can I remove this safely without messing up my save? Yes.
Mods that use this framework
- Soil Relocation Mod.
- Consistent Deep Drill Stone Mod.
For modders
Consistent Map Stone Mod allows other mods to determine what type of stone would exist at a specific cell if that tile were exposed stone terrain. Normally, RimWorld uses a random seed during map generation, and that seed is not available afterward, which makes this impossible without a framework like this one.
To get the stone type at a particular cell, add an assembly reference to Consistent Map Stone Mod and use:
var sg = Map.GetComponentCMS.MapComponent_StoneGrid();
You can then call the following functions:
- StoneTypeAt(IntVec3): Returns the
ThingDeffor the stone type itself. - StoneTerrainAt(IntVec3): Returns the
TerrainDeffor the stone type. - StoneChunkAt(IntVec3): Returns the
ThingDeffor the chunk of that stone type.
The latter two functions call the first one internally and then extract the relevant values. If you need more than one result, it is more efficient to call StoneTypeAt(IntVec3) first and drill down manually to avoid duplicate work.
Be sure to add Consistent Map Stone Mod as a dependency in your Steam upload so users can easily find and install it.
Compatibility notes
Consistent Map Stone Mod is described as compatible with virtually anything.
When troubleshooting the Consistent Map Stone Mod:
- See if the error persists if you just have this mod and its requirements active.
- If not, try adding your other mods until it happens again.
- Always post your log using the Log Uploader.
- For best support, please use the Discord-channel for error-reporting.
- Do not report errors by making a discussion-thread, I get no notification of that.
- If you have the solution for a problem, please post it to the GitHub repository.
- Use RimSort to sort your mods.