Show / Hide Table of Contents

Class DungeonGeneratorConfiguration<TNode>

Configuration of the dungeon generator.

Inheritance
System.Object
DungeonGeneratorConfiguration<TNode>
GraphBasedGeneratorConfiguration<TNode>
Implements
IChainDecompositionConfiguration<TNode>
ISimulatedAnnealingConfiguration
ISmartCloneable<DungeonGeneratorConfiguration<TNode>>
Namespace: Edgar.Legacy.Core.LayoutGenerators.DungeonGenerator
Assembly: Edgar.dll
Syntax
public class DungeonGeneratorConfiguration<TNode> : Object, IChainDecompositionConfiguration<TNode>, ISimulatedAnnealingConfiguration, ISmartCloneable<DungeonGeneratorConfiguration<TNode>>
Type Parameters
Name Description
TNode

Constructors

DungeonGeneratorConfiguration()

Declaration
public DungeonGeneratorConfiguration()

Properties

ChainDecompositionConfiguration

Chain decomposition configuration that will be used to compute the chains from the input graph.

Declaration
public ChainDecompositionConfiguration ChainDecompositionConfiguration { get; set; }
Property Value
Type Description
ChainDecompositionConfiguration
Remarks

Should not be changed manually.

Chains

Decomposition of the input graph into disjunct subgraphs (chains). In most cases, this property should not be set and the algorithm will use the ChainDecompositionConfiguration to compute the chains.

Declaration
public List<Chain<TNode>> Chains { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Chain<TNode>>
Remarks

Should not be changed manually.

EarlyStopIfIterationsExceeded

The number of iterations after which the algorithm is stopped even if it was not able to generate a layout. Defaults to null - algorithm is not stopped early.

Declaration
public Nullable<int> EarlyStopIfIterationsExceeded { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

EarlyStopIfTimeExceeded

The time interval after which the algorithm is stopped even if it was not able to generate a layout. Defaults to null - algorithm is not stopped early.

Declaration
public Nullable<TimeSpan> EarlyStopIfTimeExceeded { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>

RepeatModeOverride

Whether to override repeat mode of individual room templates. If this property is set, the chosen repeat mode will be used for all room templates no matter what their own repeat mode was.

Declaration
public Nullable<RoomTemplateRepeatMode> RepeatModeOverride { get; set; }
Property Value
Type Description
System.Nullable<RoomTemplateRepeatMode>

RoomsCanTouch

Whether non-neighboring rooms may touch (share walls) or not. The setting is applied only to non-neighboring rooms because all neighbors share walls as they must be connected by doors. It is recommended to allow touching rooms if the dungeon is without corridors.

Declaration
public bool RoomsCanTouch { get; set; }
Property Value
Type Description
System.Boolean

SimulatedAnnealingConfiguration

Simulated annealing configuration.

Declaration
public SimulatedAnnealingConfigurationProvider SimulatedAnnealingConfiguration { get; set; }
Property Value
Type Description
SimulatedAnnealingConfigurationProvider
Remarks

Should not be changed manually.

SimulatedAnnealingMaxBranching

Maximum branching factor of simulated annealing.

Declaration
public int SimulatedAnnealingMaxBranching { get; set; }
Property Value
Type Description
System.Int32
Remarks

Should not be changed manually.

ThrowIfRepeatModeNotSatisfied

Whether to throw an exception when the algorithm is not able to satisfy all the repeat mode requirements. If set to false, the algorithm will try to lower the requirements, e.g. instead of no rooms being repeated, it at least tries to not repeat neighbors.

Declaration
public bool ThrowIfRepeatModeNotSatisfied { get; set; }
Property Value
Type Description
System.Boolean

Methods

Equals(DungeonGeneratorConfiguration<TNode>)

Declaration
protected bool Equals(DungeonGeneratorConfiguration<TNode> other)
Parameters
Type Name Description
DungeonGeneratorConfiguration<TNode> other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

SmartClone()

Declaration
public DungeonGeneratorConfiguration<TNode> SmartClone()
Returns
Type Description
DungeonGeneratorConfiguration<TNode>

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Equality(DungeonGeneratorConfiguration<TNode>, DungeonGeneratorConfiguration<TNode>)

Declaration
public static bool operator ==(DungeonGeneratorConfiguration<TNode> left, DungeonGeneratorConfiguration<TNode> right)
Parameters
Type Name Description
DungeonGeneratorConfiguration<TNode> left
DungeonGeneratorConfiguration<TNode> right
Returns
Type Description
System.Boolean

Inequality(DungeonGeneratorConfiguration<TNode>, DungeonGeneratorConfiguration<TNode>)

Declaration
public static bool operator !=(DungeonGeneratorConfiguration<TNode> left, DungeonGeneratorConfiguration<TNode> right)
Parameters
Type Name Description
DungeonGeneratorConfiguration<TNode> left
DungeonGeneratorConfiguration<TNode> right
Returns
Type Description
System.Boolean

Implements

IChainDecompositionConfiguration<TNode>
ISimulatedAnnealingConfiguration
ISmartCloneable<T>
Back to top Generated by DocFX