Subscribe to download
TerrainMovementKit

A mod for other mods to add terrain specific movement options and restrictions


This mod is for other mods to use, it has no direct benefit to players without writing additional rules for terrain / pawns based.

What the mod provides is a toolkit for adding rules and statistics for managing movement on various terrain types to the game. It makes pawns respect new Speed baseStats for both moving through a type of terrain and for planning pathing through that terrain. It also allows you to specify new pathCost stats to pair with Speed stats in order for pawns with the stat to move at a different speed than pawns without the stat. And finally it adds rules such that pawns can be restricted to certain terrain, or not able to enter other terrain.

What's an example of using this mod?

The SwimmingKit mod uses this mod to enable SwimSpeed to affect movement in water. It also add the aquatic tag in a mod extension to make pawns only able to traverse water tiles. This is being used in the Biomes! to support Sharks, Turtles, and other semi-aquatic or fully aquatic animals.

For modded tile types you could also add movement rules. Say you have a lava tile. You can add a Lava Monster who can only move on lava. Then add some special tech armor that lets your pawns walk on lava to go battle it.


I have not run into compatibility issues in testing, but I believe there are some incompatibilities with some existing mods. The Swimming Kit mod has been using this mod for quite some time without reported issues. But anything that modifies pathing has a high likelihood of failure in combination with this mod. There's additional work needed to improve the code to reduce these potential incompatibilities. See FAQ[github.com] for more details.


See the TMK wiki[github.com] for details on how to add these rules to your mod.


The mod can be used as a mod dependency OR as a direct DLL[github.com] in your mod assemblies. If you use the second option, be advised that you should add the following to your About.xml to help ensure multiple mods using the same kit will load the latest version.
If the mods above are not present it will still check for mod load orders of this library DLL and emit an error message (but still load) if it detects a later version lower in the users mod list.


The mod Logo above used the following free assets:

Lava: "LuminousDragonGames"[opengameart.org]
Rock: "Para"[opengameart.org]
Sand: "txturs"[opengameart.org]
Water: "Aswin Vos"[opengameart.org]