NavigationProcessor Class

    Namespace: Stride.Navigation.Processors
    Assembly: Stride.Navigation.dll

    Manages the loading of the native side navigation meshes. Will only load one version of the navigation mesh if it is referenced by multiple components

    System.Object → EntityProcessor → EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData> → NavigationProcessor
    Derived from NavigationProcessor: 

    public class NavigationProcessor : EntityProcessor<NavigationComponent, NavigationProcessor.AssociatedData>
    Name Description
    Methods
    GenerateComponentData(Entity, NavigationComponent)

    Generates associated data to the given entity.
    IsAssociatedDataValid(Entity, NavigationComponent, NavigationProcessor.AssociatedData)

    Checks if the current associated data is valid, or if readding the entity is required.
    OnEntityComponentAdding(Entity, NavigationComponent, NavigationProcessor.AssociatedData)

    Run when a matching entity is added to this entity processor.
    OnEntityComponentRemoved(Entity, NavigationComponent, NavigationProcessor.AssociatedData)

    Run when a matching entity is removed from this entity processor.
    OnSystemAdd()

    Run when this EntityProcessor is added to an EntityManager.
    OnSystemRemove()

    Run when this EntityProcessor is removed from an EntityManager.
    Update(GameTime)

    Performs work related to this processor.
    | Improve this Doc View Source

    Methods

    GenerateComponentData(Entity, NavigationComponent)

    Generates associated data to the given entity.

    protected override NavigationProcessor.AssociatedData GenerateComponentData(Entity entity, NavigationComponent component)
    Parameters
    Type Name Description
    Entity entity

    The entity.
    NavigationComponent component
    Returns
    Type Description
    NavigationProcessor.AssociatedData

    The associated data.
    Overrides
    Stride.Engine.EntityProcessor<Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData>.GenerateComponentData(Stride.Engine.Entity, Stride.Navigation.NavigationComponent)

    IsAssociatedDataValid(Entity, NavigationComponent, NavigationProcessor.AssociatedData)

    Checks if the current associated data is valid, or if readding the entity is required.

    protected override bool IsAssociatedDataValid(Entity entity, NavigationComponent component, NavigationProcessor.AssociatedData associatedData)
    Parameters
    Type Name Description
    Entity entity

    The entity.
    NavigationComponent component
    NavigationProcessor.AssociatedData associatedData
    Returns
    Type Description
    System.Boolean

    True if the change in associated data requires the entity to be readded, false otherwise.
    Overrides
    Stride.Engine.EntityProcessor<Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData>.IsAssociatedDataValid(Stride.Engine.Entity, Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData)

    OnEntityComponentAdding(Entity, NavigationComponent, NavigationProcessor.AssociatedData)

    Run when a matching entity is added to this entity processor.

    protected override void OnEntityComponentAdding(Entity entity, NavigationComponent component, NavigationProcessor.AssociatedData data)
    Parameters
    Type Name Description
    Entity entity

    The entity.
    NavigationComponent component
    NavigationProcessor.AssociatedData data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData>.OnEntityComponentAdding(Stride.Engine.Entity, Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData)

    OnEntityComponentRemoved(Entity, NavigationComponent, NavigationProcessor.AssociatedData)

    Run when a matching entity is removed from this entity processor.

    protected override void OnEntityComponentRemoved(Entity entity, NavigationComponent component, NavigationProcessor.AssociatedData data)
    Parameters
    Type Name Description
    Entity entity

    The entity.
    NavigationComponent component
    NavigationProcessor.AssociatedData data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData>.OnEntityComponentRemoved(Stride.Engine.Entity, Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData)

    OnSystemAdd()

    Run when this EntityProcessor is added to an EntityManager.

    protected override void OnSystemAdd()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData>.OnSystemAdd()

    OnSystemRemove()

    Run when this EntityProcessor is removed from an EntityManager.

    protected override void OnSystemRemove()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Navigation.NavigationComponent, Stride.Navigation.Processors.NavigationProcessor.AssociatedData>.OnSystemRemove()

    Update(GameTime)

    Performs work related to this processor.

    public override void Update(GameTime time)
    Parameters
    Type Name Description
    GameTime time
    Overrides

    Inherited Members

    Extension Methods