### Create SonarAvoidance Instance Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/manual/sonar-avoidance.html Instantiate the SonarAvoidance struct with its position, direction, up vector, and radii. This is the initial setup for the avoidance system. ```csharp var sonar = new SonarAvoidance(position, direction, up, innerRadius, outerRadius, speed); ``` -------------------------------- ### FlockGroupSystem.OnCreate Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.FlockGroupSystem.html Called when the FlockGroupSystem is created. This method is used to set up system resources upon initialization. It is invoked before the system starts running or updating. ```APIDOC ## FlockGroupSystem.OnCreate ### Description Called when this system is created. Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. ### Method void ### Parameters #### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### Line Constructor Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.LocalAvoidance.Line.html Initializes a new instance of the Line struct with specified start and end points. ```APIDOC ## Line(float from, float to) ### Description Initializes a new one-dimensional line segment. ### Parameters #### Parameters - **from** (float) - The starting position of the line segment. - **to** (float) - The ending position of the line segment. ``` -------------------------------- ### Get() Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentsNavigationSettings.html Retrieves an instance of a sub-setting. If the project does not have settings asset set, it returns an instance with default values. This method is generic and requires a type parameter T that must implement ISubSettings. ```APIDOC ## Get() ### Description Returns instance of sub setting. In case project does not have settings asset set, it will return instance with default values. ### Method Signature `public static T Get() where T : ISubSettings` ### Type Parameters * **T**: The type of the sub-setting to retrieve. This type must implement the `ISubSettings` interface. ``` -------------------------------- ### AgentForceSystem.OnCreateForCompiler Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentForceSystem.html Generated by the compilation pipeline and used internally. This method is part of the system's internal setup and not intended for direct user invocation. ```APIDOC ## OnCreateForCompiler(ref SystemState) ### Description Generated by compilation pipeline and used internally. ### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### Range.Length Property Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Range.html Gets the length of the range. ```APIDOC ## Length ### Description Gets the length of the range. ### Declaration public float Length { get; } ### Property Value Type: [float](https://learn.microsoft.com/dotnet/api/system.single) Description: The length of the range. ``` -------------------------------- ### OnCreate Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.WriteAgentRectTransformSystem.html Called when this system is created. Implement an OnCreate function to set up system resources when it is created. OnCreate is invoked before the the first time ISystemStartStop.OnStartRunning and ISystem.OnUpdate are invoked. ```APIDOC ## OnCreate(ref SystemState) ### Description Called when this system is created. Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. ### Method void ### Parameters #### Parameters - **state** (SystemState) - Description: The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### Object.GetHashCode Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Editor.AgentsNavigationSettingsEditor.html Gets the hash code for the Object. ```APIDOC ## Object.GetHashCode() ### Description Returns the hash code for this object, which is suitable for use in hashing algorithms and data structures such as a hash table. ### Method (Not specified, likely a method call within an SDK) ### Endpoint (Not applicable for SDK methods) ### Parameters (None) ### Response (int) - A hash code for the current object. ``` -------------------------------- ### Create and Configure Agent Entity Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/manual/entities.html Demonstrates how to create a new entity and add essential agent components using their default properties. Ensure the Agent tag is added for the agent to function correctly. ```csharp var entity = EntityManager.CreateEntity(); // Agent tag is required for agent to work EntityManager.AddComponentData(entity, Agent.Default); // AgentBody for dynamic agents EntityManager.AddComponentData(entity, AgentBody.Default); // AgentLocomotion for moving EntityManager.AddComponentData(entity, AgentLocomotion.Default); // AgentShape for default cylinder shape EntityManager.AddComponentData(entity, AgentShape.Default); ``` -------------------------------- ### AgentSmartStopSystem.OnCreate Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentSmartStopSystem.html Called when the AgentSmartStopSystem is created. Used to set up system resources. ```APIDOC ## OnCreate(ref SystemState) ### Description Called when this system is created. Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. ### Method void ### Parameters #### Path Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### Editor.GetInfoString Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Editor.AgentsNavigationSettingsEditor.html Gets an informational string about the editor. ```APIDOC ## Editor.GetInfoString() ### Description Returns a string containing information about the editor. ### Method (Not specified, likely a method call within an SDK) ### Endpoint (Not applicable for SDK methods) ### Parameters (None) ### Response (string) - An informational string about the editor. ``` -------------------------------- ### AgentAvoidGizmosSystem.OnCreate Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Editor.AgentAvoidGizmosSystem.html Called when the AgentAvoidGizmosSystem is created. Used to set up system resources. ```APIDOC ## OnCreate(ref SystemState) ### Description Called when this system is created. ### Method `public void OnCreate(ref SystemState state)` ### Parameters #### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ### Remarks Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. ``` -------------------------------- ### Type Property Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.CrowdObstacleAuthoring.html Gets or sets the shape of the obstacle. ```APIDOC ## Type Property ### Description The shape of the obstacle. ### Declaration ```csharp public CrowdObstacleType Type { get; set; } ``` ### Property Value Type Description [CrowdObstacleType](ProjectDawn.Navigation.CrowdObstacleType.html) ``` -------------------------------- ### Object Instantiation Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.CrowdObstacleAuthoring.html Methods for instantiating objects, including asynchronous operations. ```APIDOC ## Object Instantiation ### Description Methods for creating new instances of objects, with support for asynchronous instantiation and various positioning/parenting options. ### Methods #### Asynchronous Instantiation - `InstantiateAsync(T original)` - `InstantiateAsync(T original, Transform parent)` - `InstantiateAsync(T original, Vector3 position, Quaternion rotation)` - `InstantiateAsync(T original, Transform parent, Vector3 position, Quaternion rotation)` - `InstantiateAsync(T original, int group, ...)` (various overloads with group, position, rotation, and parent) #### Synchronous Instantiation - `Instantiate(Object original)` - `Instantiate(Object original, Vector3 position, Quaternion rotation)` - `Instantiate(Object original, Vector3 position, Quaternion rotation, Transform parent)` - `Instantiate(Object original, Scene scene)` - `Instantiate(Object original, Transform parent)` - `Instantiate(Object original, Transform parent, bool instantiateInWorldSpace)` - `Instantiate(T original)` - `Instantiate(T original, Vector3 position, Quaternion rotation)` - `Instantiate(T original, Vector3 position, Quaternion rotation, Transform parent)` - `Instantiate(T original, Transform parent)` - `Instantiate(T original, Transform parent, bool instantiateInWorldSpace)` ``` -------------------------------- ### Size Property Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.CrowdObstacleAuthoring.html Gets or sets the size of the obstacle. ```APIDOC ## Size Property ### Description The size of the obstacle. ### Declaration ```csharp public float3 Size { get; set; } ``` ### Property Value Type Description float3 ``` -------------------------------- ### Object.GetInstanceID Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Editor.AgentsNavigationSettingsEditor.html Gets the unique instance ID of an Object. ```APIDOC ## Object.GetInstanceID() ### Description Returns the unique instance identifier of this object. ### Method (Not specified, likely a method call within an SDK) ### Endpoint (Not applicable for SDK methods) ### Parameters (None) ### Response (int) - The instance ID of the object. ``` -------------------------------- ### Object Instantiation Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentCylinderShapeAuthoring.html Methods for instantiating objects, including asynchronous and synchronous operations with various overloads. ```APIDOC ## InstantiateAsync ### Description Asynchronously instantiates an object with optional position, rotation, and parent. ### Method POST ### Endpoint `/InstantiateAsync` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **original** (T) - Required - The original object to instantiate. - **parent** (Transform) - Optional - The parent transform. - **position** (Vector3) - Optional - The position for the new object. - **rotation** (Quaternion) - Optional - The rotation for the new object. - **instantiateInWorldSpace** (bool) - Optional - Whether to instantiate in world space. ``` ```APIDOC ## Instantiate ### Description Instantiates an object, optionally with position, rotation, parent, and scene. ### Method POST ### Endpoint `/Instantiate` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **original** (Object) - Required - The original object to instantiate. - **position** (Vector3) - Optional - The position for the new object. - **rotation** (Quaternion) - Optional - The rotation for the new object. - **parent** (Transform) - Optional - The parent transform. - **instantiateInWorldSpace** (bool) - Optional - Whether to instantiate in world space. - **scene** (Scene) - Optional - The scene to instantiate the object in. ``` -------------------------------- ### Coroutine Methods Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.EntityBehaviour.html Methods for starting and stopping coroutines. ```APIDOC ## MonoBehaviour.StartCoroutine(string methodName, object value) ### Description Starts a coroutine. ### Method StartCoroutine ### Parameters #### Path Parameters - **methodName** (string) - Required - The name of the coroutine method to start. - **value** (object) - Optional - An argument to pass to the coroutine. ### Response #### Success Response (200) N/A ## MonoBehaviour.StartCoroutine(IEnumerator routine) ### Description Starts a coroutine. ### Method StartCoroutine ### Parameters #### Path Parameters - **routine** (IEnumerator) - Required - The coroutine to start. ### Response #### Success Response (200) N/A ## MonoBehaviour.StopCoroutine(string methodName) ### Description Stops a coroutine. ### Method StopCoroutine ### Parameters #### Path Parameters - **methodName** (string) - Required - The name of the coroutine method to stop. ### Response #### Success Response (200) N/A ## MonoBehaviour.StopCoroutine(Coroutine routine) ### Description Stops a coroutine. ### Method StopCoroutine ### Parameters #### Path Parameters - **routine** (Coroutine) - Required - The coroutine to stop. ### Response #### Success Response (200) N/A ## MonoBehaviour.StopAllCoroutines() ### Description Stops all coroutines running on this behaviour. ### Method StopAllCoroutines ### Response #### Success Response (200) N/A ``` -------------------------------- ### Object Instantiation Methods Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.DepthSurfaceAuthoring.html Methods for creating new instances of objects, including asynchronous instantiation. ```APIDOC ## Object Instantiation ### Description Provides methods for instantiating objects, both synchronously and asynchronously, with various options for position, rotation, and parent. ### Methods `Object.InstantiateAsync(T original)` `Object.InstantiateAsync(T original, Transform parent)` `Object.InstantiateAsync(T original, Vector3 position, Quaternion rotation)` `Object.InstantiateAsync(T original, Transform parent, Vector3 position, Quaternion rotation)` `Object.Instantiate(Object original)` `Object.Instantiate(Object original, Vector3 position, Quaternion rotation)` `Object.Instantiate(Object original, Vector3 position, Quaternion rotation, Transform parent)` `Object.Instantiate(Object original, Transform parent)` `Object.Instantiate(Object original, Scene scene)` `Object.Instantiate(T original)` `Object.Instantiate(T original, Vector3 position, Quaternion rotation)` `Object.Instantiate(T original, Vector3 position, Quaternion rotation, Transform parent)` `Object.Instantiate(T original, Transform parent)` ### Parameters - **original** (T or Object) - The object to instantiate. - **parent** (Transform) - The parent transform for the new instance. - **position** (Vector3) - The world position for the new instance. - **rotation** (Quaternion) - The world rotation for the new instance. - **scene** (Scene) - The scene to instantiate the object into. ``` -------------------------------- ### AgentSetDestinationDeferredSystem Methods Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentSetDestinationDeferredSystem.html Provides documentation for the core methods of the AgentSetDestinationDeferredSystem, including OnCreate, OnCreateForCompiler, OnDestroy, and OnUpdate. ```APIDOC ## AgentSetDestinationDeferredSystem ### Description Represents a system that handles deferred agent destination setting. ### Methods #### OnCreate(ref SystemState) ##### Description Called when this system is created. Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. ##### Declaration ```csharp public void OnCreate(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance #### OnCreateForCompiler(ref SystemState) ##### Description Generated by compilation pipeline and used internally. ##### Declaration ```csharp public void OnCreateForCompiler(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance #### OnDestroy(ref SystemState) ##### Description Called when this system is destroyed. Systems are destroyed when the application shuts down, the World is destroyed, or you call Unity.Entities.World.DestroySystem(Unity.Entities.SystemHandle). In the Unity Editor, system destruction occurs when you exit Play Mode and when scripts are reloaded. ##### Declaration ```csharp public void OnDestroy(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance #### OnUpdate(ref SystemState) ##### Description Implement `OnUpdate` to perform the major work of this system. ##### Declaration ```csharp public void OnUpdate(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### Length Property Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.LowLevel.Unsafe.UnsafeHeap-2.html Gets or sets the number of elements in the heap. ```APIDOC ## Length Property ### Description The number of elements. ### Declaration ```csharp public int Length { get; set; } ``` ### Property Value Type: `int` Description: The number of elements. ``` -------------------------------- ### AgentSonarAvoidSystem.OnCreate Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentSonarAvoidSystem.html Called when the AgentSonarAvoidSystem is created. Implement this method to set up system resources. ```APIDOC ## OnCreate(ref SystemState) ### Description Called when this system is created. Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. ### Method void ### Parameters #### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### CrowdGroupAuthoring.Surface Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.CrowdGroupAuthoring.html Gets the crowd surface authoring associated with this group. ```APIDOC ## CrowdGroupAuthoring.Surface ### Description Gets the crowd surface authoring associated with this group. ### Property Value Type: [CrowdSurfaceAuthoring](ProjectDawn.Navigation.Hybrid.CrowdSurfaceAuthoring.html) Description: A surface which will be used by this group. ``` -------------------------------- ### Editor.GetPreviewTitle Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Editor.AgentsNavigationSettingsEditor.html Gets the title for the editor's preview GUI. ```APIDOC ## Editor.GetPreviewTitle() ### Description Returns the title string for the editor's preview GUI. ### Method (Not specified, likely a method call within an SDK) ### Endpoint (Not applicable for SDK methods) ### Parameters (None) ### Response (string) - The title of the preview GUI. ``` -------------------------------- ### NavMeshPathSystem Methods Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshPathSystem.html Details the methods available within the NavMeshPathSystem. Currently, only the compiler-generated OnCreateForCompiler method is documented. ```APIDOC ## OnCreateForCompiler(ref SystemState) ### Description This method is generated by the compilation pipeline and used internally by the system. It is not intended for direct invocation by users. ### Method `void` ### Parameters #### Path Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance. ### Implements - Unity.Entities.ISystem - Unity.Entities.ISystemCompilerGenerated ``` -------------------------------- ### NavMeshQuerySystem Methods Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshQuerySystem.html Details the core methods of the NavMeshQuerySystem, including lifecycle management functions like OnCreate, OnDestroy, and OnUpdate. ```APIDOC ## NavMeshQuerySystem System for requesting NavMesh path. ### Methods #### OnCreate(ref SystemState) Called when this system is created. ##### Declaration ```csharp public void OnCreate(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ##### Remarks Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. #### OnDestroy(ref SystemState) Called when this system is destroyed. ##### Declaration ```csharp [BurstCompile] public void OnDestroy(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ##### Remarks Systems are destroyed when the application shuts down, the World is destroyed, or you call Unity.Entities.World.DestroySystem(Unity.Entities.SystemHandle). In the Unity Editor, system destruction occurs when you exit Play Mode and when scripts are reloaded. #### OnUpdate(ref SystemState) Implement `OnUpdate` to perform the major work of this system. ##### Declaration ```csharp [BurstCompile] public void OnUpdate(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### AgentSpatialPartitioningSystem.Singleton.QueryCapacity Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentSpatialPartitioningSystem.Singleton.html Gets the maximum number of agents that can be queried at once. This property is read-only. ```APIDOC ## AgentSpatialPartitioningSystem.Singleton.QueryCapacity ### Description Gets the maximum number of agents that can be queried at once. ### Property Value - **int**: The query capacity. ``` -------------------------------- ### Range Fields Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Range.html Provides access to the start and end values of the Range. ```APIDOC ## Fields ### Start #### Declaration public float Start #### Field Value Type: [float](https://learn.microsoft.com/dotnet/api/system.single) Description: The starting value of the range. ### End #### Declaration public float End #### Field Value Type: [float](https://learn.microsoft.com/dotnet/api/system.single) Description: The ending value of the range. ``` -------------------------------- ### ReadAgentRectTransformSystem Methods Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.ReadAgentRectTransformSystem.html Provides documentation for the core methods of the ReadAgentRectTransformSystem, including OnCreate, OnCreateForCompiler, OnDestroy, and OnUpdate. ```APIDOC ## ReadAgentRectTransformSystem ### Description Represents a system that reads agent rect transforms. It implements ISystem and is part of the ProjectDawn.Navigation.Hybrid namespace. ### Methods #### OnCreate(ref SystemState) ##### Description Called when this system is created. Implement an `OnCreate` function to set up system resources when it is created. `OnCreate` is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked. ##### Declaration ```csharp public void OnCreate(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance #### OnCreateForCompiler(ref SystemState) ##### Description Generated by compilation pipeline and used internally. ##### Declaration ```csharp public void OnCreateForCompiler(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance #### OnDestroy(ref SystemState) ##### Description Called when this system is destroyed. Systems are destroyed when the application shuts down, the World is destroyed, or you call Unity.Entities.World.DestroySystem(Unity.Entities.SystemHandle). In the Unity Editor, system destruction occurs when you exit Play Mode and when scripts are reloaded. ##### Declaration ```csharp public void OnDestroy(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance #### OnUpdate(ref SystemState) ##### Description Implement `OnUpdate` to perform the major work of this system. ##### Declaration ```csharp public void OnUpdate(ref SystemState state) ``` ##### Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### Line Fields Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.LocalAvoidance.Line.html Exposes the start and end positions of the line segment. ```APIDOC ## Line Fields ### Description Represents the start and end points of the line segment. ### Fields #### From - **Type**: float - **Description**: Position where segment starts. Must be lower than [To]. #### To - **Type**: float - **Description**: Position where segment ends. Must be greater than [From]. ``` -------------------------------- ### Instantiate Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.SettingsBehaviour.html Instantiates a new object. This method supports various overloads for specifying instantiation parameters. ```APIDOC ## Instantiate Object, Vector3, Quaternion ### Description Instantiates an object at the specified position and rotation. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (Object) - Required - The original object to instantiate. - **position** (Vector3) - Required - The position to instantiate the object at. - **rotation** (Quaternion) - Required - The rotation to instantiate the object with. ### Response #### Success Response (Object) The newly instantiated object. ``` ```APIDOC ## Instantiate Object, Vector3, Quaternion, Transform ### Description Instantiates an object at the specified position and rotation, as a child of the given transform. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (Object) - Required - The original object to instantiate. - **position** (Vector3) - Required - The position to instantiate the object at. - **rotation** (Quaternion) - Required - The rotation to instantiate the object with. - **parent** (Transform) - Required - The parent transform for the new object. ### Response #### Success Response (Object) The newly instantiated object. ``` ```APIDOC ## Instantiate Object ### Description Instantiates a new object. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (Object) - Required - The original object to instantiate. ### Response #### Success Response (Object) The newly instantiated object. ``` ```APIDOC ## Instantiate Object, Scene ### Description Instantiates an object into the specified scene. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (Object) - Required - The original object to instantiate. - **scene** (Scene) - Required - The scene to instantiate the object into. ### Response #### Success Response (Object) The newly instantiated object. ``` ```APIDOC ## Instantiate Object, Transform ### Description Instantiates an object as a child of the specified transform. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (Object) - Required - The original object to instantiate. - **parent** (Transform) - Required - The parent transform for the new object. ### Response #### Success Response (Object) The newly instantiated object. ``` ```APIDOC ## Instantiate Object, Transform, bool ### Description Instantiates an object as a child of the specified transform, with an option to position it. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (Object) - Required - The original object to instantiate. - **parent** (Transform) - Required - The parent transform for the new object. - **instantiateInWorldSpace** (bool) - Required - Whether to instantiate in world space. ### Response #### Success Response (Object) The newly instantiated object. ``` ```APIDOC ## Instantiate T ### Description Instantiates a new object of type T. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (T) - Required - The original object to instantiate. ### Response #### Success Response (T) The newly instantiated object of type T. ``` ```APIDOC ## Instantiate T, Vector3, Quaternion ### Description Instantiates a new object of type T at the specified position and rotation. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (T) - Required - The original object to instantiate. - **position** (Vector3) - Required - The position to instantiate the object at. - **rotation** (Quaternion) - Required - The rotation to instantiate the object with. ### Response #### Success Response (T) The newly instantiated object of type T. ``` ```APIDOC ## Instantiate T, Vector3, Quaternion, Transform ### Description Instantiates a new object of type T at the specified position and rotation, as a child of the given transform. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (T) - Required - The original object to instantiate. - **position** (Vector3) - Required - The position to instantiate the object at. - **rotation** (Quaternion) - Required - The rotation to instantiate the object with. - **parent** (Transform) - Required - The parent transform for the new object. ### Response #### Success Response (T) The newly instantiated object of type T. ``` ```APIDOC ## Instantiate T, Transform ### Description Instantiates a new object of type T as a child of the specified transform. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (T) - Required - The original object to instantiate. - **parent** (Transform) - Required - The parent transform for the new object. ### Response #### Success Response (T) The newly instantiated object of type T. ``` ```APIDOC ## Instantiate T, Transform, bool ### Description Instantiates a new object of type T as a child of the specified transform, with an option to position it. ### Method Object.Instantiate ### Parameters #### Path Parameters - **original** (T) - Required - The original object to instantiate. - **parent** (Transform) - Required - The parent transform for the new object. - **instantiateInWorldSpace** (bool) - Required - Whether to instantiate in world space. ### Response #### Success Response (T) The newly instantiated object of type T. ``` -------------------------------- ### EntityBehaviour.IsEntityCreated Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.EntityBehaviour.html Gets a value indicating whether the entity has been created. This is a read-only property. ```APIDOC ## EntityBehaviour.IsEntityCreated ### Description Gets a value indicating whether the entity has been created. This is a read-only property. ### Property Value - **bool** - Indicates if the entity has been created. ``` -------------------------------- ### Create Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.LowLevel.Unsafe.UnsafeBHVTree-2.html Creates a new UnsafeBHVTree with a specified initial capacity and memory allocator. ```APIDOC ## Create ### Description Creates a new container with the specified initial capacity and type of memory allocation. ### Method public static UnsafeBHVTree* Create(int initialCapacity, AllocatorManager.AllocatorHandle allocator) ### Parameters #### Path Parameters * **initialCapacity** (int) - Required - The initial capacity of the tree. * **allocator** (AllocatorManager.AllocatorHandle) - Required - The memory allocator to use. ``` -------------------------------- ### Capacity Property Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.LowLevel.Unsafe.UnsafeHeap-2.html Gets or sets the number of elements that can fit in the internal buffer of the heap. ```APIDOC ## Capacity ### Description The number of elements that can fit in the internal buffer. ### Property Value - **Capacity** (int) - Description: The number of elements that can fit in the internal buffer. ``` -------------------------------- ### NavMeshWall Fields Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshWall.html Provides access to the start and end points of the navigation mesh wall. ```APIDOC ## NavMeshWall Fields ### Start #### Declaration ```csharp public float3 Start ``` ### Description The start point of the wall. ### End #### Declaration ```csharp public float3 End ``` ### Description The end point of the wall. ``` -------------------------------- ### AgentGroundingSystem Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.html N/A ```APIDOC ## AgentGroundingSystem ### Description N/A ### Endpoint N/A ### Method N/A ``` -------------------------------- ### Default Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshPath.html Returns default configuration. ```APIDOC ## Default ### Description Returns default configuration. ### Declaration ```csharp public static NavMeshPath Default { get; } ``` ``` -------------------------------- ### Component Interaction Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentGroundingAuthoring.html Methods for interacting with components attached to the agent, including getting and setting properties. ```APIDOC ## Component Interaction ### Description Provides methods for accessing and manipulating components and their properties. ### Methods - **GetComponent()** Gets a component of type T attached to this GameObject. - **GetComponent(Type type)** Gets a component of the specified type attached to this GameObject. - **TryGetComponent(out T component)** Tries to get a component of type T, returning true if successful. - **TryGetComponent(Type type, out Component component)** Tries to get a component of the specified type, returning true if successful. - **GetComponent(string name)** Gets a component of type T by its name. - **GetComponentInChildren()** Gets a component of type T in any child of this GameObject. - **GetComponentInChildren(bool includeInactive)** Gets a component of type T in any child of this GameObject, optionally including inactive ones. - **GetComponentInChildren(Type type)** Gets a component of the specified type in any child of this GameObject. - **GetComponentInChildren(Type type, bool includeInactive)** Gets a component of the specified type in any child of this GameObject, optionally including inactive ones. - **GetComponentsInChildren()** Gets all components of type T in any child of this GameObject. - **GetComponentsInChildren(bool includeInactive)** Gets all components of type T in any child of this GameObject, optionally including inactive ones. - **GetComponentsInChildren(Type type)** Gets all components of the specified type in any child of this GameObject. - **GetComponentsInChildren(Type type, bool includeInactive)** Gets all components of the specified type in any child of this GameObject, optionally including inactive ones. - **GetComponentInParent()** Gets a component of type T in any parent of this GameObject. - **GetComponentInParent(bool includeInactive)** Gets a component of type T in any parent of this GameObject, optionally including inactive ones. - **GetComponentInParent(Type type)** Gets a component of the specified type in any parent of this GameObject. - **GetComponentInParent(Type type, bool includeInactive)** Gets a component of the specified type in any parent of this GameObject, optionally including inactive ones. - **GetComponentsInParent()** Gets all components of type T in any parent of this GameObject. - **GetComponentsInParent(bool includeInactive)** Gets all components of type T in any parent of this GameObject, optionally including inactive ones. - **GetComponentsInParent(Type type)** Gets all components of the specified type in any parent of this GameObject. - **GetComponentsInParent(Type type, bool includeInactive)** Gets all components of the specified type in any parent of this GameObject, optionally including inactive ones. - **GetComponents()** Gets all components of type T on this GameObject. - **GetComponents(List results)** Gets all components of type T on this GameObject and adds them to the provided list. - **GetComponents(Type type)** Gets all components of the specified type on this GameObject. - **GetComponents(Type type, List results)** Gets all components of the specified type on this GameObject and adds them to the provided list. - **CompareTag(string tag)** Checks if the GameObject is tagged with the specified tag. - **SendMessageUpwards(string methodName, object value, SendMessageOptions options)** Calls a method on this GameObject and all parents. - **SendMessageUpwards(string methodName, object value)** Calls a method on this GameObject and all parents with a parameter. - **SendMessageUpwards(string methodName)** Calls a method on this GameObject and all parents. - **SendMessageUpwards(string methodName, SendMessageOptions options)** Calls a method on this GameObject and all parents with options. - **SendMessage(string methodName, object value, SendMessageOptions options)** Calls a method on this GameObject. - **SendMessage(string methodName, object value)** Calls a method on this GameObject with a parameter. - **SendMessage(string methodName)** Calls a method on this GameObject. - **SendMessage(string methodName, SendMessageOptions options)** Calls a method on this GameObject with options. - **BroadcastMessage(string methodName, object value, SendMessageOptions options)** Calls a method on this GameObject and all children. - **BroadcastMessage(string methodName, object value)** Calls a method on this GameObject and all children with a parameter. - **BroadcastMessage(string methodName)** Calls a method on this GameObject and all children. ``` -------------------------------- ### GiveUpStop.Default Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.GiveUpStop.html Returns the default configuration for GiveUpStop. This is a static property that provides a pre-configured instance of GiveUpStop. ```APIDOC ## GiveUpStop.Default ### Description Returns the default configuration. ### Property Value Type: [GiveUpStop](ProjectDawn.Navigation.GiveUpStop.html) Description: Provides the default configuration instance. ``` -------------------------------- ### Range Constructor Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Range.html Initializes a new instance of the Range struct with specified start and end values. ```APIDOC ## Range(float start, float end) ### Description Initializes a new instance of the Range struct with specified start and end values. ### Parameters #### Parameters - **start** (float) - The starting value of the range. - **end** (float) - The ending value of the range. ``` -------------------------------- ### AgentSteeringSystem.OnCreateForCompiler Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentSteeringSystem.html This method is generated by the compilation pipeline and used internally by the system. It initializes the system's state. ```APIDOC ## AgentSteeringSystem.OnCreateForCompiler ### Description Generated by compilation pipeline and used internally. ### Method `public void OnCreateForCompiler(ref SystemState state)` ### Parameters #### Path Parameters - **state** (SystemState) - Required - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### NavMeshWall Constructor Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshWall.html Constructs a new instance of the NavMeshWall struct with specified start and end points. ```APIDOC ## NavMeshWall(float3, float3) ### Description Constructs a new instance of the NavMeshWall struct. ### Parameters #### Path Parameters - **from** (float3) - Required - The start point of the wall. - **to** (float3) - Required - The end point of the wall. ``` -------------------------------- ### Coroutine Management Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentCrowdPathingAuthoring.html Provides methods for starting, stopping, and managing coroutines within the AgentCrowdPathingAuthoring system. ```APIDOC ## Coroutine Management ### Description Methods for controlling coroutine execution. ### Methods - **StartCoroutine(string methodName, object value)**: Starts a coroutine. - **StartCoroutine(string methodName)**: Starts a coroutine. - **StartCoroutine(IEnumerator routine)**: Starts a coroutine from an IEnumerator. - **StartCoroutine_Auto(IEnumerator routine)**: Starts a coroutine automatically. - **StopCoroutine(IEnumerator routine)**: Stops a specific coroutine. - **StopCoroutine(string methodName)**: Stops a coroutine by its method name. - **StopAllCoroutines()**: Stops all currently running coroutines. ``` -------------------------------- ### NavMeshQuerySystem.Singleton Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshQuerySystem.Singleton.html Details about the NavMeshQuerySystem.Singleton component, which is part of the navigation system and implements specific interfaces for querying. ```APIDOC ## NavMeshQuerySystem.Singleton ### Description Represents a singleton component within the NavMeshQuerySystem. It implements `Unity.Entities.IComponentData` and `Unity.Entities.IQueryTypeParameter`, signifying its role in defining queryable aspects of the navigation mesh system. ### Implements * `Unity.Entities.IComponentData` * `Unity.Entities.IQueryTypeParameter` ### Returns Type: `bool` Description: Indicates the status or result of operations related to the singleton, though specific usage is not detailed here. ``` -------------------------------- ### Component.BroadcastMessage Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentFlockAuthoring.html Broadcasts a message to all components in this GameObject or any parent GameObject, starting from this GameObject and moving up the hierarchy. ```APIDOC ## Component.BroadcastMessage ### Description Broadcasts a message to all components in this GameObject or any parent GameObject, starting from this GameObject and moving up the hierarchy. ### Method - BroadcastMessage(string) - BroadcastMessage(string, SendMessageOptions) ``` -------------------------------- ### NavMeshFunnel Constructor Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshFunnel.html Initializes a new instance of the NavMeshFunnel struct with a specified capacity and allocator. ```APIDOC ## NavMeshFunnel(int capacity, Allocator allocator) ### Description Used for creating optimal path from navmesh polygons. ### Method Constructor ### Parameters #### Path Parameters - **capacity** (int) - Description: The maximum number of points the funnel can hold. - **allocator** (Allocator) - Description: The memory allocator to use for the funnel. ### Returns - None ``` -------------------------------- ### AgentFlockingSystem OnCreateForCompiler Method Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentFlockingSystem.html The OnCreateForCompiler method is generated by the compilation pipeline and used internally for system initialization. ```csharp public void OnCreateForCompiler(ref SystemState state) ``` -------------------------------- ### AgentMotionType Enum Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentMotionType.html Defines the possible motion types for an agent, influencing its component setup and behavior. ```APIDOC ## Enum AgentMotionType ### Description Defines the possible motion types for an agent, influencing its component setup and behavior. ### Namespace ProjectDawn.Navigation.Hybrid ### Assembly ProjectDawn.Navigation.Hybrid.dll ### Syntax ```csharp public enum AgentMotionType ``` ### Fields | Name | Description | |-------------------|------------------------------------------------------------------------------------------------------------| | DefaultLocomotion | Agent is dynamic. It's entity will have have AgentBody and AgentLocomotion components. | | Dynamic | Agent is dynamic. It's entity will not have AgentSteering component. | | Static | Agent is static. It's entity will not have AgentBody and AgentSteering components. | ``` -------------------------------- ### CrowdSteeringSystem.OnCreateForCompiler Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.CrowdSteeringSystem.html This method is generated by the compilation pipeline and is used internally by the system. It initializes the system's state. ```APIDOC ## CrowdSteeringSystem.OnCreateForCompiler ### Description Generated by compilation pipeline and used internally. ### Method public void OnCreateForCompiler(ref SystemState state) ### Parameters #### Parameters - **state** (SystemState) - The Unity.Entities.SystemState backing this system instance ``` -------------------------------- ### GetHashCode() Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.CrowdDiscomfortSplat.html Gets the hash code for the current CrowdDiscomfortSplat object. This method overrides the base ValueType.GetHashCode method. ```APIDOC ## GetHashCode() ### Description Gets the hash code for the current CrowdDiscomfortSplat object. ### Method `override int GetHashCode()` ### Returns - **int** - A hash code for the current object. ### Overrides [ValueType.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode) ``` -------------------------------- ### Coroutine Management Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentSeparationAuthoring.html Methods for starting, stopping, and checking the status of coroutines within the agent navigation system. ```APIDOC ## Coroutine Management ### Description Provides methods to control and manage coroutines, which are essential for asynchronous operations in agent navigation. ### Methods - **StartCoroutine(string methodName, object value) Starts a coroutine by its method name and an optional object value. - **StartCoroutine(string methodName) Starts a coroutine by its method name. - **StartCoroutine(IEnumerator routine) Starts a coroutine from an IEnumerator object. - **StartCoroutine_Auto(IEnumerator routine) Starts a coroutine automatically from an IEnumerator object. - **StopCoroutine(IEnumerator routine) Stops a running coroutine specified by its IEnumerator object. - **StopCoroutine(string methodName) Stops a coroutine by its method name. - **StopAllCoroutines() Stops all coroutines currently running on this agent. ``` -------------------------------- ### Create Method Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.LowLevel.Unsafe.UnsafeHeap-2.html Creates and initializes a new UnsafeHeap with a specified initial capacity and memory allocator. ```APIDOC ## Create(int initialCapacity, AllocatorManager.AllocatorHandle allocator) Method ### Description Creates a new container with the specified initial capacity and type of memory allocation. ### Declaration ```csharp public static UnsafeHeap* Create(int initialCapacity, AllocatorManager.AllocatorHandle allocator) ``` ### Parameters - **initialCapacity** (`int`) - Required - The initial capacity of the list. If the list grows larger than its capacity, the internal array is copied to a new, larger array. - **allocator** (`AllocatorManager.AllocatorHandle`) - Required - A member of the [Unity.Collections.Allocator](https://docs.unity3d.com/ScriptReference/Unity.Collections.Allocator.html) enumeration. ### Returns Type: `UnsafeHeap*` Description: A pointer to the newly created UnsafeHeap. ``` -------------------------------- ### NavMeshQuerySystem.Singleton.World Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.NavMeshQuerySystem.Singleton.html Gets the NavMeshWorld associated with this singleton. This property provides access to the underlying navigation mesh data and systems. ```APIDOC ## NavMeshQuerySystem.Singleton.World ### Description Gets the NavMeshWorld associated with this singleton. This property provides access to the underlying navigation mesh data and systems. ### Property - **World** (NavMeshWorld) - The NavMeshWorld instance. ``` -------------------------------- ### Object.InstantiateAsync Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.CrowdGroupAuthoring.html Asynchronously creates an instance of a GameObject. ```APIDOC ## Object.InstantiateAsync ### Description Asynchronously creates an instance of a GameObject. This method is useful for scenarios where immediate instantiation might cause performance issues. ### Method - `InstantiateAsync(T original)` - `InstantiateAsync(T original, Transform parent)` - `InstantiateAsync(T original, Vector3 position, Quaternion rotation)` - `InstantiateAsync(T original, Transform parent, Vector3 position, Quaternion rotation)` - `InstantiateAsync(T original, int instanceId)` - `InstantiateAsync(T original, int instanceId, Transform parent)` - `InstantiateAsync(T original, int instanceId, Vector3 position, Quaternion rotation)` - `InstantiateAsync(T original, int instanceId, ReadOnlySpan positions, ReadOnlySpan rotations)` - `InstantiateAsync(T original, int instanceId, Transform parent, Vector3 position, Quaternion rotation)` - `InstantiateAsync(T original, int instanceId, Transform parent, ReadOnlySpan positions, ReadOnlySpan rotations)` ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Request Example None provided in source. ### Response #### Success Response - Returns a Task that completes when the object has been instantiated. #### Response Example None provided in source. ``` -------------------------------- ### MonoBehaviour Coroutine Management Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.Hybrid.AgentNavMeshAuthoring.html Provides methods for starting, stopping, and checking the status of coroutines within the AgentNavMeshAuthoring class. ```APIDOC ## Coroutine Management ### Description Methods for managing coroutines, including starting, stopping, and checking if a coroutine is currently running. ### Methods - **StartCoroutine(string methodName)** - **StartCoroutine(string methodName, object value)** - **StartCoroutine(IEnumerator routine)** - **StartCoroutine_Auto(IEnumerator routine)** - **StopCoroutine(IEnumerator routine)** - **StopCoroutine(string methodName)** - **StopAllCoroutines()** - **IsInvoking()** - **CancelInvoke()** - **Invoke(string methodName, float time)** - **InvokeRepeating(string methodName, float time, float repeatRate)** - **CancelInvoke(string methodName)** - **IsInvoking(string methodName)** ``` -------------------------------- ### AgentsNavigationSettings Constructor Source: https://github.com/lukaschod/agents-navigation-docs/blob/main/api/ProjectDawn.Navigation.AgentsNavigationSettings.html Initializes a new instance of the AgentsNavigationSettings class. This constructor is used to create the settings asset. ```csharp public AgentsNavigationSettings() ```