Struct SurroundingRegionsIterator

Namespace

Uncreated.Warfare.Util.Region

Assembly

Uncreated.Warfare.dll

Iterate through a region list starting at a position and moving outwards.

public struct SurroundingRegionsIterator : IEnumerator<RegionCoord>, IEnumerator, IDisposable, IEnumerable<RegionCoord>, IEnumerable

Implements

IEnumerator<RegionCoord>

IEnumerator

IDisposable

IEnumerable<RegionCoord>

IEnumerable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

CollectionUtility.ToArrayFast<TElement>(IEnumerable<TElement>, bool)

TrackingListExtensions.ToReadOnlyTrackingList<T>(IEnumerable<T>)

TrackingListExtensions.ToTrackingList<T>(IEnumerable<T>)

Remarks

Stolen from DevkitServer.

Constructors

SurroundingRegionsIterator(byte, byte, byte)

public SurroundingRegionsIterator(byte x, byte y, byte maxRegionDistance = 255)

Parameters

x byte

y byte

maxRegionDistance byte

Fields

MaxRegionDistance

public readonly byte MaxRegionDistance

Field Value

byte

StartX

public readonly byte StartX

Field Value

byte

StartY

public readonly byte StartY

Field Value

byte

Properties

Current

Gets the element in the collection at the current position of the enumerator.

public RegionCoord Current { get; }

Property Value

RegionCoord

The element in the collection at the current position of the enumerator.

Methods

GetEnumerator()

public readonly SurroundingRegionsIterator GetEnumerator()

Returns

SurroundingRegionsIterator

MoveNext()

Advances the enumerator to the next element of the collection.

public bool MoveNext()

Returns

bool

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

Reset()

Sets the enumerator to its initial position, which is before the first element in the collection.

public void Reset()

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.