Interface ITunnelCreator
Interface for implementing an algorithm for creating a tunnel between two positions on a walkability map.
Namespace: GoRogue.MapGeneration.TunnelCreators
Assembly: GoRogue.dll
Syntax
public interface ITunnelCreatorMethods
View SourceCreateTunnel(ISettableGridView<bool>, Point, Point)
Implements the algorithm, creating the tunnel between the two points (ensuring there is a path of positions set to true between those two points).
Declaration
Area CreateTunnel(ISettableGridView<bool> map, Point tunnelStart, Point tunnelEnd)Parameters
| Type | Name | Description |
|---|---|---|
| ISettableGridView<bool> | map | _grid to create the tunnel on. |
| Point | tunnelStart | Start position to connect. |
| Point | tunnelEnd | End position to connect. |
Returns
| Type | Description |
|---|---|
| Area | An area containing all points that are part of the tunnel. |
CreateTunnel(ISettableGridView<bool>, int, int, int, int)
Implements the algorithm, creating the tunnel between the two points (ensuring there is a path of positions set to true between those two points).
Declaration
Area CreateTunnel(ISettableGridView<bool> map, int startX, int startY, int endX, int endY)Parameters
| Type | Name | Description |
|---|---|---|
| ISettableGridView<bool> | map | _grid to create the tunnel on. |
| int | startX | X-value of the start position to connect. |
| int | startY | Y-value of the start position to connect. |
| int | endX | X-value of the end position to connect. |
| int | endY | Y-value of the end position to connect. |
Returns
| Type | Description |
|---|---|
| Area | An area containing all points that are part of the tunnel. |