Class DoorList

A list of rooms and entry/exit points of those rooms, generated/added by map generation components, that tracks what generation step created/recorded which opening.

Inheritance

object

DoorList

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: GoRogue.MapGeneration.ContextComponents

Assembly: GoRogue.dll

Syntax

public class DoorList

Constructors

DoorList()

Creates a new door manager context component.

Declaration

public DoorList()

Properties

DoorsPerRoom

A dictionary associating rooms to their lists of doors.

Declaration

public IReadOnlyDictionary<Rectangle, RoomDoors> DoorsPerRoom { get; }

Property Value

Type	Description
IReadOnlyDictionary<Rectangle, RoomDoors>

Methods

AddDoor(string, Rectangle, Point)

Records a new opening in the given room at the given position.

Declaration

public void AddDoor(string generationStepName, Rectangle room, Point doorPosition)

Parameters

Type	Name	Description
string	generationStepName	The name of the generation step recording the door position.
Rectangle	room	The room the door is a part of.
Point	doorPosition	The location of the door to add.

AddDoors(string, Rectangle, params Point[])

Records new openings in the given room at the given positions.

Declaration

public void AddDoors(string generationStepName, Rectangle room, params Point[] doorPositions)

Parameters

Type	Name	Description
string	generationStepName	The name of the generation step recording the door positions.
Rectangle	room	The room the doors are part of.
Point[]	doorPositions	The locations of the door to add.

AddDoors(string, Rectangle, IEnumerable<Point>)

Records new openings in the given room at the given positions.

Declaration

public void AddDoors(string generationStepName, Rectangle room, IEnumerable<Point> doorPositions)

Parameters

Type	Name	Description
string	generationStepName	The name of the generation step recording the door positions.
Rectangle	room	The room the doors are part of.
IEnumerable<Point>	doorPositions	The locations of the door to add.

Extension Methods

Utility.Yield<T>(T)