Class Task | Bolt Visual Scripting | 1.4.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class Task

    Inheritance
    Object
    Task
    Namespace: Ludiq
    Syntax
    public sealed class Task

    Constructors

    Task(ITaskRunner, String, Int32, Action<Task>)

    Declaration
    public Task(ITaskRunner runner, string title, int totalSteps, Action<Task> work)
    Parameters
    Type Name Description
    ITaskRunner runner
    String title
    Int32 totalSteps
    Action<Task> work

    Fields

    animatedRatio

    Declaration
    public float animatedRatio
    Field Value
    Type Description
    Single

    Properties

    allowWindowRunner

    Declaration
    public static bool allowWindowRunner { get; set; }
    Property Value
    Type Description
    Boolean

    completedSteps

    Declaration
    public int completedSteps { get; }
    Property Value
    Type Description
    Int32

    currentStepLabel

    Declaration
    public string currentStepLabel { get; set; }
    Property Value
    Type Description
    String

    elapsed

    Declaration
    public TimeSpan elapsed { get; }
    Property Value
    Type Description
    TimeSpan

    parallelOptions

    Declaration
    public ParallelOptions parallelOptions { get; }
    Property Value
    Type Description
    ParallelOptions

    ratio

    Declaration
    public float ratio { get; }
    Property Value
    Type Description
    Single

    runner

    Declaration
    public ITaskRunner runner { get; }
    Property Value
    Type Description
    ITaskRunner

    stepsHaveCompleted

    Declaration
    public bool stepsHaveCompleted { get; }
    Property Value
    Type Description
    Boolean

    stepsHaveStarted

    Declaration
    public bool stepsHaveStarted { get; }
    Property Value
    Type Description
    Boolean

    title

    Declaration
    public string title { get; }
    Property Value
    Type Description
    String

    totalSteps

    Declaration
    public int totalSteps { get; }
    Property Value
    Type Description
    Int32

    Methods

    Abort()

    Declaration
    public void Abort()

    AllowCancellation()

    Declaration
    public void AllowCancellation()

    Begin()

    Declaration
    public void Begin()

    Cancel()

    Declaration
    public void Cancel()

    CompleteStep()

    Declaration
    public void CompleteStep()

    End()

    Declaration
    public void End()

    Run()

    Declaration
    public void Run()

    Run(String, Int32, Action<Task>)

    Declaration
    public static void Run(string title, int steps, Action<Task> work)
    Parameters
    Type Name Description
    String title
    Int32 steps
    Action<Task> work

    StartStep(String)

    Declaration
    public void StartStep(string label = null)
    Parameters
    Type Name Description
    String label

    WaitUntilStepsHaveCompleted()

    Declaration
    public void WaitUntilStepsHaveCompleted()

    Extension Methods

    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    LiteralUtility.ToLiteralString(Object)
    LiteralUtility.ToLiteralStringOrDefault(Object)
    LiteralUtility.TryToLiteralString(Object, out String)
    XFilterProvider.Filter(Object)
    XFilterProvider.Filter<TFilter>(Object)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone(Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy(Object)
    Cloning.CloneViaSerializationPolicy(Object, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy<T>(T)
    Cloning.CloneViaSerializationPolicy<T>(T, out Dictionary<Object, Object>)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneValueType(Object)
    ConversionUtility.ConvertTo<TSource>(TSource, Type)
    ConversionUtility.IsLateConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsLateConvertibleTo<T>(Object, Boolean)
    ConversionUtility.LateConvertTo(Object, Type)
    ConversionUtility.LateConvertTo<T>(Object)
    ConversionUtility.TryLateConvertTo(Object, Type, out Object, Boolean)
    ConversionUtility.TryLateConvertTo<T>(Object, out T, Boolean)
    TypeUtility.ToShortString(Object, Int32)
    TypeUtility.CastTo<T>(Object)
    Serialization.FullSerialize(Object, Boolean)
    Serialization.OdinSerialize<T>(T, DataFormat)
    Serialization.OdinSerialize<T>(T, ref OdinSerializer.SerializationData, DataFormat)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.UnityNullCoalesce(Object, Object)
    UnityObjectUtility.ToSafeString(Object)
    BoltGenerationUtility.GenerateLiteral(Object, IGeneration)
    XGeneratorProvider.Generator(Object, IGeneration)
    XGeneratorProvider.Generator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.HasGenerator(Object, IGeneration)
    XGeneratorProvider.HasGenerator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.TryGetGenerator(Object, out IGenerator, IGeneration)
    XGeneratorProvider.TryGetGenerator<TGenerator>(Object, IGeneration, out TGenerator)
    HybridConversionUtility.ConvertTo(Object, HybridType, HybridType)
    HybridConversionUtility.IsLateConvertibleTo(Object, HybridType, Boolean)
    HybridConversionUtility.LateConvertTo(Object, HybridType)
    HybridConversionUtility.TryLateConvertTo(Object, HybridType, out Object, Boolean)
    HybridTypeUtility.GetHybridType(Object)
    IsUtility.Is<TO, TC>(TO, out TC)
    PrivateReflectionUsingDynamicExtensions.AsDynamic(Object)
    JsonWriter.ToJson(Object)
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX