Wiki

Clone wiki

RogueSharp / RogueSharp / IMap / IsExplored

IMapIsExplored Method

Check if the Cell is flagged as ever having been explored by the player

Namespace: RogueSharp
Assembly:

Syntax

bool IsExplored(
    int x,
    int y
)

Parameters

x

Type: SystemInt32
X location of the Cell to check starting with 0 as the farthest left

y

Type: SystemInt32
Y location of the Cell to check, starting with 0 as the top

Return Value

Type: Boolean
True if the Cell has been flagged as being explored by the player, false otherwise

Remarks

The explored property of a Cell can be used to track if the Cell has ever been in the field-of-view of a character controlled by the player This property will not automatically be updated based on FOV calculations or any other built-in functions of the RogueSharp library.

Examples

As the player moves characters around a Map, Cells will enter and exit the currently computed field-of-view This property can be used to keep track of those Cells that have been "seen" and could be used to show fog-of-war type effects when rendering the map

See Also

Reference

IMap Interface
RogueSharp Namespace

[3]: 2014-2016 Faron Bracy

Updated