Show / Hide Table of Contents

Class Region

A region of the map with four sides of arbitrary shape and size

Inheritance
object
Region
Implements
IObjectWithComponents
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: GoRogue.MapGeneration
Assembly: GoRogue.dll
Syntax
public class Region : IObjectWithComponents

Constructors

View Source

Region(PolygonArea, IComponentCollection?)

Returns a new Region using the provided area

Declaration
public Region(PolygonArea area, IComponentCollection? components = null)
Parameters
Type Name Description
PolygonArea area

This region's Area

IComponentCollection components

A component collection for this region

Fields

View Source

AreaChanged

Fired when the Area is changed.

Declaration
public EventHandler<RegionAreaChangedEventArgs>? AreaChanged
Field Value
Type Description
EventHandler<RegionAreaChangedEventArgs>

Properties

View Source

Area

The Area of this region

Declaration
public PolygonArea Area { get; set; }
Property Value
Type Description
PolygonArea
View Source

GoRogueComponents

Collection holding components that GoRogue has recorded as being attached to the implementing object.

Declaration
public IComponentCollection GoRogueComponents { get; }
Property Value
Type Description
IComponentCollection

Methods

View Source

ToString()

Returns a string detailing the region's corner locations.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Implements

IObjectWithComponents

Extension Methods

Utility.Yield<T>(T)
  • View Source
In this article
Back to top Generated by DocFX