Adventure Creator  1.81.2
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2024
AC.NavigationEngine_AStar2D Class Reference
Inheritance diagram for AC.NavigationEngine_AStar2D:
AC.NavigationEngine

Public Member Functions

override void OnReset (NavigationMesh navMesh)
 Called when the scene begins or is reset. More...
 
Grid2D GetGrid (Collider2D collider)
 
override void TurnOn (NavigationMesh navMesh)
 Enables the NavMesh so that it can be used in pathfinding. More...
 
override Vector3[] GetPointsArray (Vector3 startPosition, Vector3 targetPosition, Char _char=null)
 
override string GetPrefabName ()
 Gets the name of a "helper" prefab to list in the Scene Manager. More...
 
override void SceneSettingsGUI ()
 
override void ResetHoles (NavigationMesh navMesh)
 
override NavigationMesh NavigationMeshGUI (NavigationMesh _target)
 
override void DrawGizmos (GameObject navMeshOb)
 Draws gizmos in the Scene/Game window. More...
 
- Public Member Functions inherited from AC.NavigationEngine
virtual Vector3[] GetPointsArray (Vector3 startPosition, Vector3 targetPosition, AC.Char _char=null)
 Calculates a path between two points. More...
 
Vector3[] GetPointsArray (Vector3 startPosition, Vector3[] targetPositions, AC.Char _char=null)
 Calculates a path between multiple points. More...
 
virtual Vector3 GetPointNear (Vector3 point, float minDistance, float maxDistance)
 Finds a random position surrounding a given point on a NavMesh. More...
 

Properties

override bool RequiresNavMeshGameObject [get]
 
- Properties inherited from AC.NavigationEngine
virtual bool RequiresNavMeshGameObject [get]
 

Additional Inherited Members

- Public Attributes inherited from AC.NavigationEngine
bool is2D = false
 
- Protected Attributes inherited from AC.NavigationEngine
Vector2[] vertexData
 

Member Function Documentation

◆ DrawGizmos()

override void AC.NavigationEngine_AStar2D.DrawGizmos ( GameObject  navMeshOb)
virtual

Draws gizmos in the Scene/Game window.

Parameters
navMeshObThe NavigationMesh gameobject to draw gizmos for

Reimplemented from AC.NavigationEngine.

◆ GetPrefabName()

override string AC.NavigationEngine_AStar2D.GetPrefabName ( )
virtual

Gets the name of a "helper" prefab to list in the Scene Manager.

Returns
The name of the prefab to list in SceneManager. The prefab must be placed in the Assets/AdventureCreator/Prefabs/Navigation folder. If nothing is returned, no prefab will be listed.

Reimplemented from AC.NavigationEngine.

◆ NavigationMeshGUI()

override NavigationMesh AC.NavigationEngine_AStar2D.NavigationMeshGUI ( NavigationMesh  _target)
virtual

Provides a space for any custom Editor GUI code that should be displayed in the NavigationMesh inspector.

Reimplemented from AC.NavigationEngine.

◆ OnReset()

override void AC.NavigationEngine_AStar2D.OnReset ( NavigationMesh  navMesh)
virtual

Called when the scene begins or is reset.

Parameters
navMeshThe NavigationMesh that is active in the scene.

Reimplemented from AC.NavigationEngine.

◆ ResetHoles()

override void AC.NavigationEngine_AStar2D.ResetHoles ( NavigationMesh  navMesh)
virtual

Integrates all PolygonCollider2D objects in the polygonColliderHoles List into the base PolygonCollider2D shape. This is called automatically by AddHole() and RemoveHole() once the List has been amended

Reimplemented from AC.NavigationEngine.

◆ SceneSettingsGUI()

override void AC.NavigationEngine_AStar2D.SceneSettingsGUI ( )
virtual

Provides a space for any custom Editor GUI code that should be displayed in SceneManager.

Reimplemented from AC.NavigationEngine.

◆ TurnOn()

override void AC.NavigationEngine_AStar2D.TurnOn ( NavigationMesh  navMesh)
virtual

Enables the NavMesh so that it can be used in pathfinding.

Parameters
navMeshObThe NavigationMesh gameobject to enable

Reimplemented from AC.NavigationEngine.