Keen:Planet Modding/Fast Travel

Fast travel settings modding

In Medieval Engineers players can only fast travel through reachable terrain, blocked terrain has to be crossed on foot or walked around. In this section of the guide we will show you how to mod which sectors are blocked. There are 2 ways you can go about it:

Generate automatically based on terrain shape

Game is capable of creating fast travel map on its own based on height and terrain steepness. It is possible to mod thresholds for both height and steepness. You will find the thresholds in Content\Data\Game\FastTravel.sbc. In a MyObjectBuilder_TerrainReachabilityProviderDefinition.

<Definition xsi:type="MyObjectBuilder_TerrainReachabilityProviderDefinition">
	<Id Type="MyObjectBuilder_TerrainReachabilityProviderDefinition" Subtype="Terra"/>

	<RiseThreshold>.14</RiseThreshold>
	<HeightThreshold>.6</HeightThreshold>
    
	<OverrideForward>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Front_ForbiddenAreas.png</OverrideForward>
	<OverrideBackward>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Back_ForbiddenAreas.png</OverrideBackward>
	<OverrideLeft>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Left_ForbiddenAreas.png</OverrideLeft>
	<OverrideRight>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Right_ForbiddenAreas.png</OverrideRight>
	<OverrideUp>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Up_ForbiddenAreas.png</OverrideUp>
	<OverrideDown>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Down_ForbiddenAreas.png</OverrideDown>
</Definition>

<RiseThreshold> - Sets min. terrain height change which will cause that area is unreachable. <HeightThreshold> - Sets height of terrain after which area is unreachable, if it goes over this value. Range is 0 - 1.

If there are texture overrides in the definition, you have to erase them in order for the parameters to take effect. Texture overrides are used to override the generated fast travel map. You will learn more about these overrides in the next part of Fast travel modding.

Creating fast travel texture override

If you want to have full control over which areas are reachable and which are not regardless of terrain, you can create a simple texture on which you mark unreachable areas.

The texture is 80x80 pixels, RGB 8 bit. Black pixels forbid entrance.

When you have the texture, select route to it in the definition:

<OverrideForward>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Front_ForbiddenAreas.png</OverrideForward>

Reachability definition example:

<Definition xsi:type="MyObjectBuilder_TerrainReachabilityProviderDefinition">
<Id Type="MyObjectBuilder_TerrainReachabilityProviderDefinition" Subtype="Terra"/>
<RiseThreshold>.14</RiseThreshold>
	<HeightThreshold>.6</HeightThreshold>
		<OverrideForward>Data/PlanetDataFiles/EarthLike/FastTravelOverrides/Front_ForbiddenAreas.png</OverrideForward>
</Definition>

This definition would generate fast travel reachability everywhere, except for front planet face (Fareon kingdom) where fast travel reachability is created based on your texture.

Development reachability

Claimable area size, border highlight, contested timer modding Size of the area and highlight properties are moddable as well.

Area borders highlight

<NeutralColor R="225" G="32" B="0" A="64" /> - Set color of an unowned territory <SelfColor R="0" G="255" B="0" A="64" /> - Sets color of area border owned by you <AliedColor R="65" G="105" B="225" A="64" /> - Sets color of area border that belongs to allies <EnemyColor R="225" G="32" B="0" A="64" /> - Sets color of area border that is hostile <WallSettings Depth="15" Rise="3" SegmentCount"71" End="115" /> - Changes shape of the border. Depth sets how deep is border submerged. Rise sets how tall is the border. <Fade Start="71" End="115" /> - This sets at which point the border starts to fade. Contested timer When players claim area with claimblock, area goes to a “contested” phase for some amount of time, in this phase other players can still attempt to build their own claim block and claim the area. This time is moddable. Content\Data\Game\SessionComponents.sbc contains definition called MyObjectBuilder_AreaOwnershipSystemDefinition. To mod this value, add this definition to your mod with changed value of <ContestedTimeInMinutes> parameter.

Permissions modding - what is/isn’t allowed to do in claimed areas Have you noticed you cannot mine voxels in claimed areas of your enemies? That is because of how we chose to define permission settings for safe area. And yes, this and much more is also moddable :). This time there is no need create any textures, we will only need to edit one text file and add it to your mod. You will find the file with permissions definitions in Data\Permissions.sbc Descriptions of permission nodes:

<Permission Name="Build">
      <Usergroup Groupname="Owner" Allowed="true"/>
      <Usergroup Groupname="Allies" Allowed="true"/>
      <Usergroup Groupname="Neutral" Allowed="false"/>
      <Usergroup Groupname="Enemies" Allowed="false"/>
 </Permission>

Permission definition sets which groups of players are allowed to perform an action. In this example, it is “Build” action.

<Usergroup Groupname=”Owner” Allowed=”true”>

Groupname refers to group of players, for which we are setting the permission(in this example it is player who owns the area). Allowed parameter allows/disallows the action depending on if it is set to “true” or “false”.

<IsDefault>true</IsDefault>

Parameter sets which area permission set is used for player owned territories.

Description of available actions to set permissions for:

1. Name=”Build” -> block placement permissions
2. Name=”Repair” -> Repairing/building already placed blocks
3. Name=”Deconstruct” -> Deconstructing
4. Name=”QuickDeconstruct” -> Faster deconstruction
5. Name=”VoxelEdit” -> Mining or shoveling
6. Name=”Destroy” -> Damage with hand weapons
7. Name=”Interaction” -> Chest opening, door opening
8. Name=”ClaimBlockInteraction” -> ClaimblockGui

List of available Groupnames:

1. Groupname: “Owner” -> Player who owns area
2. roupname: “Allies” -> Mostly faction members of owner of the area
3. Groupname: “Neutral” -> Random players, who are not in an enemy faction (mostly everyone without faction allegiance)
4. Groupname: “Enemies” -> Players in factions that are hostile to your faction