Class InvalidConfigurationException

Raised by generation steps in OnPerform(GenerationContext) when a parameter has been misconfigured.

Inheritance
object
Exception
InvalidConfigurationException
Implements
Inherited Members
Namespace: GoRogue.MapGeneration
Assembly: GoRogue.dll
Syntax
public class InvalidConfigurationException : Exception, ISerializable

Constructors

View Source

InvalidConfigurationException()

Creates an empty configuration exception.

Declaration
public InvalidConfigurationException()
View Source

InvalidConfigurationException(GenerationStep, string, string)

Creates a configuration exception with a helpful message.

Declaration
public InvalidConfigurationException(GenerationStep step, string parameterName, string message)
Parameters
Type Name Description
GenerationStep step

The generation step that the misconfigured parameter was encountered in.
string parameterName

The name of the misconfigured parameter.
string message

A message explaining the requirements for the parameter's value.
View Source

InvalidConfigurationException(string)

Creates a configuration exception with a customized message.

Declaration
public InvalidConfigurationException(string message)
Parameters
Type Name Description
string message
View Source

InvalidConfigurationException(string, Exception)

Creates a configuration exception with a customized message an inner exception.

Declaration
public InvalidConfigurationException(string message, Exception innerException)
Parameters
Type Name Description
string message
Exception innerException

Properties

View Source

ParameterName

Name of parameter that was misconfigured.

Declaration
public string? ParameterName { get; }
Property Value
Type Description
string
View Source

Step

Generation step that had a misconfigured parameter.

Declaration
public GenerationStep? Step { get; }
Property Value
Type Description
GenerationStep

Implements

Extension Methods