An area groups together pieces of data through the navmesh generation process. More...

Inheritance diagram for SharpNav.Area:

Public Member Functions
	Area (byte id)
	Initializes a new instance of the Area struct. More...

bool	Equals (Area other)
	Compares this instance with another instance of Area for equality. More...

bool	Equals (byte other)
	Compares this instance with a byte representing another Area for equality. More...

override bool	Equals (object obj)
	Compares this instance with another object for equality. More...

override int	GetHashCode ()
	Generates a hashcode unique to the Id of this instance. More...

override string	ToString ()
	Converts this instance to a human-readable string. More...

Static Public Member Functions
static implicit	operator Area (byte value)
	Implicitly casts a byte to an Area. This is included since an Area is a very thin wrapper around a byte. More...

static bool	operator== (Area left, Area right)
	Compares two areas for equality. More...

static bool	operator!= (Area left, Area right)
	Compares two areas for inequality. More...

Public Attributes
readonly byte	Id
	The identifier for an area, represented as a byte. More...

Static Public Attributes
static readonly Area	Null = new Area(0)
	The null area is one that is considered unwalkable. More...

static readonly Area	Default = new Area(0xff)
	This is a default Area in the event that the user does not provide one. More...

Properties
bool	IsWalkable `[get]`
	Gets a value indicating whether the area is considered walkable (not Area.Null). More...

Detailed Description

An area groups together pieces of data through the navmesh generation process.

Definition at line 14 of file Area.cs.

Constructor & Destructor Documentation

◆ Area()

SharpNav.Area.Area ( byte id )

Initializes a new instance of the Area struct.

Parameters

id	An identifier for the area.

Definition at line 40 of file Area.cs.

Member Function Documentation

◆ Equals() [1/3]

bool SharpNav.Area.Equals ( Area other )

Compares this instance with another instance of Area for equality.

Parameters

other An Area.

Returns: A value indicating whether the two Areas are equal.

Definition at line 93 of file Area.cs.

◆ Equals() [2/3]

bool SharpNav.Area.Equals ( byte other )

Compares this instance with a byte representing another Area for equality.

Parameters

other A byte.

Returns: A value indicating whether this instance and the specified byte are equal.

Definition at line 103 of file Area.cs.

◆ Equals() [3/3]

override bool SharpNav.Area.Equals ( object obj )

Compares this instance with another object for equality.

Parameters

obj	An object.

Returns: A value indicating whether this instance and the specified object are equal.

Definition at line 113 of file Area.cs.

◆ GetHashCode()

override int SharpNav.Area.GetHashCode ( )

Generates a hashcode unique to the Id of this instance.

Returns: A hash code.

Definition at line 130 of file Area.cs.

◆ operator Area()

static implicit SharpNav.Area.operator Area ( byte value )

static

Implicitly casts a byte to an Area. This is included since an Area is a very thin wrapper around a byte.

Parameters

value The identifier for an area.

Returns: An area with the specified identifier.

Definition at line 61 of file Area.cs.

◆ operator!=()

static bool SharpNav.Area.operator!=	(	Area	left,
		Area	right
	)

static

Compares two areas for inequality.

Parameters

left	An Area.
right	Another Area

Returns: A value indicating whether the two Areas are unequal.

Definition at line 83 of file Area.cs.

◆ operator==()

static bool SharpNav.Area.operator==	(	Area	left,
		Area	right
	)

static

Compares two areas for equality.

Parameters

left	An Area.
right	Another Area

Returns: A value indicating whether the two Areas are equal.

Definition at line 72 of file Area.cs.

◆ ToString()

override string SharpNav.Area.ToString ( )

Converts this instance to a human-readable string.

Returns: A string representing this instance.

Definition at line 139 of file Area.cs.

Member Data Documentation

◆ Default

readonly Area SharpNav.Area.Default = new Area(0xff)

static

This is a default Area in the event that the user does not provide one.

If a user only applies IDs to some parts of a Heightfield, they will most likely choose low integer values. Choosing the maximum value makes it unlikely for the "default" area to collide with any user-defined areas.

Definition at line 29 of file Area.cs.

◆ Id

readonly byte SharpNav.Area.Id

The identifier for an area, represented as a byte.

Definition at line 34 of file Area.cs.

◆ Null

readonly Area SharpNav.Area.Null = new Area(0)

static

The null area is one that is considered unwalkable.

Definition at line 19 of file Area.cs.

Property Documentation

◆ IsWalkable

bool SharpNav.Area.IsWalkable

get

Gets a value indicating whether the area is considered walkable (not Area.Null).

Definition at line 48 of file Area.cs.

The documentation for this struct was generated from the following file:

C:/gamedev/unity/DA20.1X/Assets/CodeRespawn/DungeonArchitect/ThirdParty/SharpNav/Area.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Area()

Member Function Documentation

◆ Equals() [1/3]

◆ Equals() [2/3]

◆ Equals() [3/3]

◆ GetHashCode()

◆ operator Area()

◆ operator!=()

◆ operator==()

◆ ToString()

Member Data Documentation

◆ Default

◆ Id

◆ Null

Property Documentation

◆ IsWalkable