Class TunnelDeadEndTrimming

Searches for tunnels that don't lead anywhere (eg. are surrounded by 3 walls), and removes them from the map. Context Components Required:

ComponentDefault Tag
ItemList<TItem> "Tunnels"
SadRogue.Primitives.GridViews.ISettableGridView<T> where T is bool"WallFloor"
Context Components Added: - None
Inheritance
System.Object
GenerationStep
TunnelDeadEndTrimming
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: GoRogue.MapGeneration.Steps
Assembly: GoRogue.dll
Syntax
[PublicAPI]
public class TunnelDeadEndTrimming : GenerationStep
Remarks

This algorithm iterates over all map areas in the ItemList<TItem> context component with the given tag. For each area, it scans for dead ends (locations that, according to the "WallFloor" component given, are surrounded by 3 walls). For each dead end, if that dead end is not currently and hasn't previously been selected as "saved", based on percentage checks, it proceeds to fill it in. It will remove the dead end location, from the appropriate area, and set the location in the "WallFloor" map to true. It proceeds in this manner until either no more (non-saved) dead ends are found, or the given maximum iterations is reached, then proceeds to the next area in the ItemList until it has processed all of the areas.

Constructors

| Improve this Doc View Source

TunnelDeadEndTrimming(String, String, String)

Creates a new dead end trimming generation step.

Declaration
public TunnelDeadEndTrimming(string name = null, string wallFloorComponentTag = "WallFloor", string tunnelsComponentTag = "Tunnels")
Parameters
Type Name Description
System.String name

The name of the generation step. Defaults to TunnelDeadEndTrimming.
System.String wallFloorComponentTag

Optional tag that must be associated with the component used to set wall/floor status of tiles changed by this algorithm. Defaults to "WallFloor".
System.String tunnelsComponentTag

Optional tag that must be associated with the component used to record areas representing tunnels that this algorithm will trim dead ends from. Defaults to "Tunnels".

Fields

| Improve this Doc View Source

MaxTrimIterations

Maximum number of passes to make looking for dead ends per area. Defaults to infinity.

Declaration
public int MaxTrimIterations
Field Value
Type Description
System.Int32
| Improve this Doc View Source

RNG

RNG to use for percentage checks. Defaults to DefaultRNG.

Declaration
public IGenerator RNG
Field Value
Type Description
Troschuetz.Random.IGenerator
| Improve this Doc View Source

SaveDeadEndChance

The chance out of 100 that a dead end is left alone. Defaults to 40.

Declaration
public ushort SaveDeadEndChance
Field Value
Type Description
System.UInt16
| Improve this Doc View Source

TunnelsComponentTag

Optional tag that must be associated with the component used to record areas representing tunnels that this algorithm will trim dead ends from.

Declaration
public readonly string TunnelsComponentTag
Field Value
Type Description
System.String
| Improve this Doc View Source

WallFloorComponentTag

Optional tag that must be associated with the component used to set wall/floor status of tiles changed by this algorithm.

Declaration
public readonly string WallFloorComponentTag
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

OnPerform(GenerationContext)

Implement to perform the actual work of the generation step. Use "yield return null" to indicate the end of a "stage", eg. a point where execution can be paused when using GetStageEnumerator().

Declaration
protected override IEnumerator<object> OnPerform(GenerationContext context)
Parameters
Type Name Description
GenerationContext context

Context to perform the generation step on.
Returns
Type Description
System.Collections.Generic.IEnumerator<System.Object>
Overrides

Extension Methods