docs.unity3d.com
    Show / Hide Table of Contents

    Class OnDestinationReached

    Called when the nav mesh agent comes within a certain threshold of its destination.

    Inheritance
    Object
    GraphElement<FlowGraph>
    Unit
    EventUnit<EmptyEventArgs>
    MachineEventUnit<EmptyEventArgs>
    OnDestinationReached
    Inherited Members
    MachineEventUnit<EmptyEventArgs>.register
    MachineEventUnit<EmptyEventArgs>.GetHook(GraphReference)
    EventUnit<EmptyEventArgs>.CreateData()
    EventUnit<EmptyEventArgs>.coroutine
    EventUnit<EmptyEventArgs>.trigger
    EventUnit<EmptyEventArgs>.StartListening(GraphStack)
    EventUnit<EmptyEventArgs>.StopListening(GraphStack)
    EventUnit<EmptyEventArgs>.Uninstantiate(GraphReference)
    EventUnit<EmptyEventArgs>.IsListening(GraphPointer)
    EventUnit<EmptyEventArgs>.Trigger(GraphReference, EmptyEventArgs)
    EventUnit<EmptyEventArgs>.AssignArguments(Flow, EmptyEventArgs)
    EventUnit<EmptyEventArgs>.CompareNames(Flow, ValueInput, String)
    Unit.CreateDebugData()
    Unit.AfterAdd()
    Unit.BeforeRemove()
    Unit.Instantiate(GraphReference)
    Unit.CopyFrom(Unit)
    Unit.canDefine
    Unit.failedToDefine
    Unit.isDefined
    Unit.AfterDefine()
    Unit.BeforeUndefine()
    Unit.EnsureDefined()
    Unit.Define()
    Unit.RemoveUnconnectedInvalidPorts()
    Unit.controlInputs
    Unit.controlOutputs
    Unit.valueInputs
    Unit.valueOutputs
    Unit.invalidInputs
    Unit.invalidOutputs
    Unit.inputs
    Unit.outputs
    Unit.validInputs
    Unit.validOutputs
    Unit.ports
    Unit.invalidPorts
    Unit.validPorts
    Unit.onPortsChanged
    Unit.PortsChanged()
    Unit.defaultValues
    Unit.relations
    Unit.connections
    Unit.Disconnect()
    Unit.isControlRoot
    Unit.EnsureUniqueInput(String)
    Unit.EnsureUniqueOutput(String)
    Unit.ControlInput(String, Func<Flow, ControlOutput>)
    Unit.ControlInputCoroutine(String, Func<Flow, IEnumerator>)
    Unit.ControlInputCoroutine(String, Func<Flow, ControlOutput>, Func<Flow, IEnumerator>)
    Unit.ControlOutput(String)
    Unit.ValueInput(Type, String)
    Unit.ValueInput<T>(String)
    Unit.ValueInput<T>(String, T)
    Unit.ValueOutput(Type, String)
    Unit.ValueOutput(Type, String, Func<Flow, Object>)
    Unit.ValueOutput<T>(String)
    Unit.ValueOutput<T>(String, Func<Flow, T>)
    Unit.Requirement(ValueInput, ControlInput)
    Unit.Requirement(ValueInput, ValueOutput)
    Unit.Assignment(ControlInput, ValueOutput)
    Unit.Succession(ControlInput, ControlOutput)
    Unit.position
    Unit.definitionException
    GraphElement<FlowGraph>.guid
    GraphElement<FlowGraph>.BeforeAdd()
    GraphElement<FlowGraph>.AfterRemove()
    GraphElement<FlowGraph>.Dispose()
    GraphElement<FlowGraph>.InstantiateNest()
    GraphElement<FlowGraph>.UninstantiateNest()
    GraphElement<FlowGraph>.dependencyOrder
    GraphElement<FlowGraph>.HandleDependencies()
    GraphElement<FlowGraph>.graph
    GraphElement<FlowGraph>.IGraphElement.graph
    GraphElement<FlowGraph>.IGraphItem.graph
    GraphElement<FlowGraph>.deserializationDependencies
    GraphElement<FlowGraph>.aotStubs
    GraphElement<FlowGraph>.Prewarm()
    GraphElement<FlowGraph>.CopyFrom(GraphElement<FlowGraph>)
    GraphElement<FlowGraph>.ToString()
    Namespace: Unity.VisualScripting
    Syntax
    [UnitCategory("Events/Navigation")]
    public sealed class OnDestinationReached : MachineEventUnit<EmptyEventArgs>, IEventUnit, IUnit, IGraphElementWithDebugData, IGraphEventListener, IGraphElementWithData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IGraphEventHandler<EmptyEventArgs>

    Properties

    hookName

    Declaration
    protected override string hookName { get; }
    Property Value
    Type Description
    String
    Overrides
    Unity.VisualScripting.MachineEventUnit<Unity.VisualScripting.EmptyEventArgs>.hookName

    requireSuccess

    Whether the event should only trigger when the path is not partial or invalid.

    Declaration
    [DoNotSerialize]
    public ValueInput requireSuccess { get; }
    Property Value
    Type Description
    ValueInput

    threshold

    The threshold for the remaining distance.

    Declaration
    [DoNotSerialize]
    public ValueInput threshold { get; }
    Property Value
    Type Description
    ValueInput

    Methods

    Definition()

    Declaration
    protected override void Definition()
    Overrides
    Unity.VisualScripting.EventUnit<Unity.VisualScripting.EmptyEventArgs>.Definition()

    ShouldTrigger(Flow, EmptyEventArgs)

    Declaration
    protected override bool ShouldTrigger(Flow flow, EmptyEventArgs args)
    Parameters
    Type Name Description
    Flow flow
    EmptyEventArgs args
    Returns
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.EventUnit<Unity.VisualScripting.EmptyEventArgs>.ShouldTrigger(Unity.VisualScripting.Flow, Unity.VisualScripting.EmptyEventArgs)

    Extension Methods

    XAnalyserProvider.Analyser(Object, IGraphContext)
    XAnalyserProvider.Analyser<TAnalyser>(Object, IGraphContext)
    XAnalyserProvider.Analysis(Object, IGraphContext)
    XAnalyserProvider.Analysis<TAnalysis>(Object, IGraphContext)
    XAnalyserProvider.Analyser(Object, GraphReference)
    XAnalyserProvider.Analyser<TAnalyser>(Object, GraphReference)
    XAnalyserProvider.Analysis(Object, GraphReference)
    XAnalyserProvider.Analysis<TAnalysis>(Object, GraphReference)
    XDescriptorProvider.Describe(Object)
    XDescriptorProvider.HasDescriptor(Object)
    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    XDescriptorProvider.Description(Object)
    XDescriptorProvider.Description<TDescription>(Object)
    XUnitOptionProvider.Option(IUnit)
    XUnitOptionProvider.Option<TOption>(IUnit)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.CloneViaFakeSerialization(Object)
    Cloning.CloneViaFakeSerialization<T>(T)
    XGraphEventListener.StartListening(IGraphEventListener, GraphReference)
    XGraphEventListener.StopListening(IGraphEventListener, GraphReference)
    GraphsExceptionUtility.GetException(IGraphElementWithDebugData, GraphPointer)
    GraphsExceptionUtility.SetException(IGraphElementWithDebugData, GraphPointer, Exception)
    GraphsExceptionUtility.HandleException(IGraphElementWithDebugData, GraphPointer, Exception)
    ConversionUtility.IsConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsConvertibleTo<T>(Object, Boolean)
    ConversionUtility.ConvertTo(Object, Type)
    ConversionUtility.ConvertTo<T>(Object)
    TypeUtility.ToShortString(Object, Int32)
    Serialization.CloneViaSerialization<T>(T, Boolean)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, Boolean)
    Serialization.Serialize(Object, Boolean)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.ToSafeString(Object)
    XUnit.CompatibleValueInput(IUnit, Type)
    XUnit.CompatibleValueOutput(IUnit, Type)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023