Search Results for

    Show / Hide Table of Contents

    Struct NavMeshQuerySystem

    System for requesting NavMesh path.

    Implements
    ISystem
    ISystemCompilerGenerated
    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: ProjectDawn.Navigation
    Assembly: ProjectDawn.Navigation.dll
    Syntax
    [BurstCompile]
    [UpdateInGroup(typeof(InitializationSystemGroup))]
    public struct NavMeshQuerySystem : ISystem, ISystemCompilerGenerated

    Methods

    | Improve this Doc View Source

    OnCreate(ref SystemState)

    Called when this system is created.

    Declaration
    public void OnCreate(ref SystemState state)
    Parameters
    Type Name Description
    SystemState state

    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.

    OnCreateForCompiler(ref SystemState)

    Generated by compilation pipeline and used internally.

    Declaration
    public void OnCreateForCompiler(ref SystemState state)
    Parameters
    Type Name Description
    SystemState state

    The Unity.Entities.SystemState backing this system instance

    | Improve this Doc View Source

    OnDestroy(ref SystemState)

    Called when this system is destroyed.

    Declaration
    [BurstCompile]
    public void OnDestroy(ref SystemState state)
    Parameters
    Type Name Description
    SystemState state

    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.

    | Improve this Doc View Source

    OnUpdate(ref SystemState)

    Implement OnUpdate to perform the major work of this system.

    Declaration
    [BurstCompile]
    public void OnUpdate(ref SystemState state)
    Parameters
    Type Name Description
    SystemState state

    The Unity.Entities.SystemState backing this system instance

    Remarks

    By default, the system invokes `OnUpdate` once every frame on the main thread. To skip OnUpdate if all of the system's [EntityQueries] are empty, use the [RequireMatchingQueriesForUpdateAttribute]. To limit when OnUpdate is invoked, you can specify components that must exist, or queries that match specific Entities. To do this, call Unity.Entities.SystemState.RequireForUpdate<T>() or Unity.Entities.SystemState.RequireForUpdate(Unity.Entities.EntityQuery) in the system's OnCreate method. For more information, see Unity.Entities.SystemState.ShouldRunSystem().

    You can instantiate and schedule an Unity.Entities.IJobChunk instance; you can use the [C# Job System] or you can perform work on the main thread. If you call Unity.Entities.EntityManager methods that perform structural changes on the main thread, be sure to arrange the system order to minimize the performance impact of the resulting [sync points].

    Implements

    Unity.Entities.ISystem
    Unity.Entities.ISystemCompilerGenerated
    In This Article
    Back to top Copyright © ProjectDawn.
    Generated by DocFX