Base class for areas in which HyperNav pathfinding can occur. More...

Classes
class	PropNames
	This is used to refer to the names of private fields in this class from a custom Editor. More...

Public Member Functions
void	UpdateTransform ()
	Update the native data of this NavArea. More...

Protected Member Functions
virtual void	OnEnable ()
	Register this area in the Instances dictionary and perform initialization. More...

virtual void	OnDisable ()
	Remove this area from the Instances dictionary. More...

virtual void	Reset ()
	Reset certain properties to the first NavArea on the object. More...

virtual void	OnDestroy ()
	Dispose native-side data for this area. More...

virtual void	Update ()
	Update UniqueID in editor, and check movement. More...

Properties
Bounds	Bounds `[get, set]`
	The boundaries of the area. More...

INavAreaData INavArea.	Data `[get]`

Transform	Transform `[get]`

IReadOnlyList< NavExternalLinkData >	ExternalLinks `[get]`
	The external links for this area. More...

IReadOnlyList< SerializableRange >	ExternalLinkRanges `[get]`
	The ranges of external links for this area (one element per region). More...

ulong	DataVersionForExternalLinks `[get]`
	The version of the data when the external links were last updated. More...

long	InstanceID `[get]`
	The unique ID for this area to identify it in pathfinding jobs and serialized data. More...

bool	RandomInstanceID `[get, set]`
	Whether to generate a random instance ID on awake (use if instantiating dynamically). More...

bool	AutoDetectMovement `[get, set]`
	Whether to automatically update native data if the area moves. More...

abstract NavAreaBaseSettings	BaseSettings `[get]`
	Base settings for the area, whether shared or instance. The returned object, while mutable, should not be modified directly as it may reference a ScriptableObject. More...

abstract Type	SettingsAssetType `[get]`
	Type of settings asset for this area (should inherit from NavAreaBaseSettings). More...

bool	UseStartLocations `[get, set]`
	Whether only regions connected to certain locations are considered valid. More...

IReadOnlyList< Vector3 >	StartLocations `[get, set]`
	If _useStartLocations is true, which start locations to use. More...

int	VisualizationSoloRegion `[get, set]`
	If set, only this region will be included in the visualization mesh. More...

bool	VisualizeNeighbors `[get, set]`
	Whether to show the connections of a selected region in the scene view. More...

int	VisualizeNeighborsRegion `[get, set]`
	If _visualizeNeighbors is true, which region to visualize in the scene view. More...

bool	VisualizeExternalLinks `[get, set]`
	Whether to show the external links. More...

bool	ShowVertexNumbers `[get, set]`
	Whether to show the vertex numbers of the preview mesh in the scene view (for debugging). More...

float	ShowVertexNumbersRange `[get, set]`
	Max distance from the camera at which vertex numbers will be shown. More...

bool	VisualizeRegionBounds `[get, set]`
	Whether to visualize the bounds of each region in the scene view. More...

bool	VisualizeVoxelQueries `[get, set]`
	Whether to visualize the queries that are performed for a voxel when baking. More...

Mesh	PreviewMesh `[get, set]`
	(Editor Only) Preview mesh that is rendered to visualize the area. More...

Material[]	PreviewMaterials `[get, set]`
	(Editor Only) List of materials to use for drawing the preview mesh. More...

abstract bool	IsNativeDataCreated `[get]`
	Returns whether the native data for this area has been created. More...

Detailed Description

Base class for areas in which HyperNav pathfinding can occur.

Member Function Documentation

◆ OnDestroy()

virtual void Infohazard.HyperNav.NavAreaBase.OnDestroy ( )

protectedvirtual

Dispose native-side data for this area.

◆ OnDisable()

virtual void Infohazard.HyperNav.NavAreaBase.OnDisable ( )

protectedvirtual

Remove this area from the Instances dictionary.

◆ OnEnable()

virtual void Infohazard.HyperNav.NavAreaBase.OnEnable ( )

protectedvirtual

Register this area in the Instances dictionary and perform initialization.

◆ Reset()

virtual void Infohazard.HyperNav.NavAreaBase.Reset ( )

protectedvirtual

Reset certain properties to the first NavArea on the object.

Reimplemented in Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.

◆ Update()

virtual void Infohazard.HyperNav.NavAreaBase.Update ( )

protectedvirtual

Update UniqueID in editor, and check movement.

◆ UpdateTransform()

void Infohazard.HyperNav.NavAreaBase.UpdateTransform ( )

Update the native data of this NavArea.

This is called automatically if AutoDetectMovement is enabled.

Property Documentation

◆ AutoDetectMovement

bool Infohazard.HyperNav.NavAreaBase.AutoDetectMovement

getset

Whether to automatically update native data if the area moves.

Note that if this is true and the area moves every frame, pathfinding will never be able to occur.

◆ BaseSettings

abstract NavAreaBaseSettings Infohazard.HyperNav.NavAreaBase.BaseSettings

get

Base settings for the area, whether shared or instance. The returned object, while mutable, should not be modified directly as it may reference a ScriptableObject.

◆ Bounds

Bounds Infohazard.HyperNav.NavAreaBase.Bounds

getset

The boundaries of the area.

This cannot be set while the game is running.

◆ Data

INavAreaData INavArea. Infohazard.HyperNav.NavAreaBase.Data

getprivate

◆ DataVersionForExternalLinks

ulong Infohazard.HyperNav.NavAreaBase.DataVersionForExternalLinks

get

The version of the data when the external links were last updated.

◆ ExternalLinkRanges

IReadOnlyList<SerializableRange> Infohazard.HyperNav.NavAreaBase.ExternalLinkRanges

get

The ranges of external links for this area (one element per region).

◆ ExternalLinks

IReadOnlyList<NavExternalLinkData> Infohazard.HyperNav.NavAreaBase.ExternalLinks

get

The external links for this area.

◆ InstanceID

long Infohazard.HyperNav.NavAreaBase.InstanceID

get

The unique ID for this area to identify it in pathfinding jobs and serialized data.

◆ IsNativeDataCreated

abstract bool Infohazard.HyperNav.NavAreaBase.IsNativeDataCreated

get

Returns whether the native data for this area has been created.

◆ PreviewMaterials

Material [] Infohazard.HyperNav.NavAreaBase.PreviewMaterials

getset

(Editor Only) List of materials to use for drawing the preview mesh.

These should be references to assets so that they don't need to be destroyed.

◆ PreviewMesh

Mesh Infohazard.HyperNav.NavAreaBase.PreviewMesh

getset

(Editor Only) Preview mesh that is rendered to visualize the area.

When set, the old mesh will be destroyed. The supplied mesh will have its HideFlags set to HideAndDontSave, meaning it will not be saved with the scene, but will not be destroyed except manually here. Therefore it is important that this value be set to null when the NavArea is destroyed, in order to avoid leaking memory.

◆ RandomInstanceID

bool Infohazard.HyperNav.NavAreaBase.RandomInstanceID

getset

Whether to generate a random instance ID on awake (use if instantiating dynamically).

◆ SettingsAssetType

abstract Type Infohazard.HyperNav.NavAreaBase.SettingsAssetType

get

Type of settings asset for this area (should inherit from NavAreaBaseSettings).

◆ ShowVertexNumbers

bool Infohazard.HyperNav.NavAreaBase.ShowVertexNumbers

getset

Whether to show the vertex numbers of the preview mesh in the scene view (for debugging).

◆ ShowVertexNumbersRange

float Infohazard.HyperNav.NavAreaBase.ShowVertexNumbersRange

getset

Max distance from the camera at which vertex numbers will be shown.

◆ StartLocations

IReadOnlyList<Vector3> Infohazard.HyperNav.NavAreaBase.StartLocations

getset

If _useStartLocations is true, which start locations to use.

◆ Transform

Transform Infohazard.HyperNav.NavAreaBase.Transform

get

◆ UseStartLocations

bool Infohazard.HyperNav.NavAreaBase.UseStartLocations

getset

Whether only regions connected to certain locations are considered valid.

This can be used to exclude certain regions from an area, such as regions that are outside reachable area.

◆ VisualizationSoloRegion

int Infohazard.HyperNav.NavAreaBase.VisualizationSoloRegion

getset

If set, only this region will be included in the visualization mesh.

◆ VisualizeExternalLinks

bool Infohazard.HyperNav.NavAreaBase.VisualizeExternalLinks

getset

Whether to show the external links.

◆ VisualizeNeighbors

bool Infohazard.HyperNav.NavAreaBase.VisualizeNeighbors

getset

Whether to show the connections of a selected region in the scene view.

◆ VisualizeNeighborsRegion

int Infohazard.HyperNav.NavAreaBase.VisualizeNeighborsRegion

getset

If _visualizeNeighbors is true, which region to visualize in the scene view.

◆ VisualizeRegionBounds

bool Infohazard.HyperNav.NavAreaBase.VisualizeRegionBounds

getset

Whether to visualize the bounds of each region in the scene view.

◆ VisualizeVoxelQueries

bool Infohazard.HyperNav.NavAreaBase.VisualizeVoxelQueries

getset

Whether to visualize the queries that are performed for a voxel when baking.

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

Runtime/NavArea.cs

Classes

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ OnDestroy()

◆ OnDisable()

◆ OnEnable()

◆ Reset()

◆ Update()

◆ UpdateTransform()

Property Documentation

◆ AutoDetectMovement

◆ BaseSettings

◆ Bounds

◆ Data

◆ DataVersionForExternalLinks

◆ ExternalLinkRanges

◆ ExternalLinks

◆ InstanceID

◆ IsNativeDataCreated

◆ PreviewMaterials

◆ PreviewMesh

◆ RandomInstanceID

◆ SettingsAssetType

◆ ShowVertexNumbers

◆ ShowVertexNumbersRange

◆ StartLocations

◆ Transform

◆ UseStartLocations

◆ VisualizationSoloRegion

◆ VisualizeExternalLinks

◆ VisualizeNeighbors

◆ VisualizeNeighborsRegion

◆ VisualizeRegionBounds

◆ VisualizeVoxelQueries