Wiki

Clone wiki

RogueSharp / RogueSharp / Path / README

Path Class

A class representing an ordered list of Cells from Start to End The path can be traversed by the StepForward and StepBackward methods Implemented by a doubly linked list

Inheritance Hierarchy

SystemObject
RogueSharpPath

Namespace: RogueSharp
Assembly:

Syntax

publicclassPath

The Path type exposes the following members.

Constructors

Name Description
Path Construct a new Path from the specified ordered list of Cells

Properties

Name Description
CurrentStep The Cell represeting the step that is currently occupied in this Path
End The Cell representing the last step or End of this Path
Length The number of steps in this Path
Start The Cell representing the first step or Start of this Path
Steps All of the Cells representing the Steps in this Path from Start to End as an IEnumerable

Methods

Name Description
Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
StepBackward Move backwards along this Path and rewind the CurrentStep to the previous Step in the Path
StepForward Move forward along this Path and advance the CurrentStep to the next Step in the Path
ToString Returns a string that represents the current object. (Inherited from Object.)

See Also

Reference

RogueSharp Namespace

[10]: 2014-2016 Faron Bracy

Updated