RoomValidationReport

Class in ChivalrousGames.DungeonMaster

Description

Room validation report. This report is normally generated by the LevelGenerator to ensure a level and its rooms are valid.

Properties

Room	Room	ReadOnly Gets the room.
Status	RoomValidationStatus	Gets or sets a value indicating whether this instance is valid.
IsInLevel	bool	ReadOnly Gets a value indicating whether this room is in the level.
HasCoordinate	bool	ReadOnly Determines if Room has a coordinate.
HasValidCoordinate	bool	ReadOnly Gets a value indicating whether this instance has a valid coordinate (aka: within the level limits).
HasTooManyOccurences	bool	ReadOnly Gets a value indicating whether this rooms was instantiated too many times in the level. Based on the room.generationConfig.maxRoomOccurrence.
InvalidConnectorPoints	ListRoomConnectorPoint, string>>	ReadOnly Gets the invalid connector points.
PropertyBag	Dictionary	ReadOnly Gets the property bag. This can be used to add anything.

Constructors

Constructor

public RoomValidationReport(Room room, RoomValidationStatus status, bool isInLevel, bool hasCoordinate, bool hasValidCoordinate, bool hasTooManyOccurences, List> invalidConnectorPoints);

Parameters

room	Room	Room.
status	RoomValidationStatus	Room validation status.
isInLevel	bool	Set to true if is in level.
hasCoordinate	bool	Set to true if has coordinate.
hasValidCoordinate	bool	Set to true if has valid coordinate.
hasTooManyOccurences	bool	Set to true if has too many occurrences.
invalidConnectorPoints	ListRoomConnectorPoint, string>>	Invalid connector points.

Return

A new instance of the RoomValidationReport class.

Description

Initializes a new instance of the RoomValidationReport class.