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

RoomRoomReadOnly
Gets the room.
StatusRoomValidationStatusGets or sets a value indicating whether this instance is valid.
IsInLevelboolReadOnly
Gets a value indicating whether this room is in the level.
HasCoordinateboolReadOnly
Determines if Room has a coordinate.
HasValidCoordinateboolReadOnly
Gets a value indicating whether this instance has a valid coordinate (aka: within the level limits).
HasTooManyOccurencesboolReadOnly
Gets a value indicating whether this rooms was instantiated too many times in the level. Based on the room.generationConfig.maxRoomOccurrence.
InvalidConnectorPointsListRoomConnectorPoint, string>>ReadOnly
Gets the invalid connector points.
PropertyBagDictionaryReadOnly
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
roomRoomRoom.
statusRoomValidationStatusRoom validation status.
isInLevelboolSet to true if is in level.
hasCoordinateboolSet to true if has coordinate.
hasValidCoordinateboolSet to true if has valid coordinate.
hasTooManyOccurencesboolSet to true if has too many occurrences.
invalidConnectorPointsListRoomConnectorPoint, string>>Invalid connector points.
Return
A new instance of the RoomValidationReport class.
Description
Initializes a new instance of the RoomValidationReport class.