FieldOfViewAppendFov Method

Performs a field-of-view calculation with the specified parameters and appends it any existing field-of-view calculations. Field-of-view (FOV) is basically a calculation of what is observable in the Map from a given Cell with a given light radius.

Namespace: RogueSharp
Assembly:

Syntax

public ReadOnlyCollection<Cell> AppendFov(
    int xOrigin,
    int yOrigin,
    int radius,
    bool lightWalls
)

Parameters

xOrigin

Type: SystemInt32
X location of the Cell to perform the field-of-view calculation with 0 as the farthest left

yOrigin

Type: SystemInt32
Y location of the Cell to perform the field-of-view calculation with 0 as the top

radius

Type: SystemInt32
The number of Cells in which the field-of-view extends from the origin Cell. Think of this as the intensity of the light source.

lightWalls

Type: SystemBoolean
True if walls should be included in the field-of-view when they are within the radius of the light source. False excludes walls even when they are within range.

Return Value

Type: ReadOnlyCollectionCell
List of Cells representing the what is observable in the Map based on the specified parameters

Examples

When a character is holding a light source in a large area that also has several other sources of light such as torches along the walls ComputeFov could first be called for the character and then AppendFov could be called for each torch to give us the final combined FOV given all the light sources

Wiki

RogueSharp / RogueSharp / FieldOfView / AppendFov