docs.unity3d.com
    Show / Hide Table of Contents

    Class FixedLengthScenario

    A scenario that runs for a fixed number of frames during each iteration

    Inheritance
    Object
    ScenarioBase
    Scenario<FixedLengthScenario.Constants>
    PerceptionScenario<FixedLengthScenario.Constants>
    FixedLengthScenario
    Inherited Members
    PerceptionScenario<FixedLengthScenario.Constants>.isScenarioReadyToStart
    PerceptionScenario<FixedLengthScenario.Constants>.OnStart()
    PerceptionScenario<FixedLengthScenario.Constants>.OnIterationStart()
    PerceptionScenario<FixedLengthScenario.Constants>.OnComplete()
    Scenario<FixedLengthScenario.Constants>.constants
    Scenario<FixedLengthScenario.Constants>.genericConstants
    ScenarioBase.activeScenario
    ScenarioBase.state
    ScenarioBase.configuration
    ScenarioBase.activeRandomizers
    ScenarioBase.randomizers
    ScenarioBase.currentIterationFrame
    ScenarioBase.framesSinceInitialization
    ScenarioBase.currentIteration
    ScenarioBase.IncrementIteration()
    ScenarioBase.SerializeToJson()
    ScenarioBase.SerializeToFile(String)
    ScenarioBase.LoadConfigurationFromFile(String)
    ScenarioBase.LoadConfigurationFromCommandLine(String)
    ScenarioBase.DeserializeConfiguration()
    ScenarioBase.ResetRandomStateOnIteration()
    ScenarioBase.OnIterationEnd()
    ScenarioBase.OnIdle()
    ScenarioBase.Restart()
    ScenarioBase.Quit()
    ScenarioBase.OnEnable()
    ScenarioBase.OnDisable()
    ScenarioBase.AddRandomizer(Randomizer)
    ScenarioBase.InsertRandomizer(Int32, Randomizer)
    ScenarioBase.RemoveRandomizerAt(Int32)
    ScenarioBase.GetRandomizer(Int32)
    ScenarioBase.GetRandomizer<T>()
    ScenarioBase.RestartIteration()
    ScenarioBase.DelayIteration()
    Namespace: UnityEngine.Perception.Randomization.Scenarios
    Syntax
    public class FixedLengthScenario : PerceptionScenario<FixedLengthScenario.Constants>

    Properties

    isIterationComplete

    Returns whether the current scenario iteration has completed

    Declaration
    protected override bool isIterationComplete { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    ScenarioBase.isIterationComplete

    isScenarioComplete

    Returns whether the scenario has completed

    Declaration
    protected sealed override bool isScenarioComplete { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    ScenarioBase.isScenarioComplete

    progressPercentage

    The proportion of the scenario iterations that have been completed expressed as a percentage.

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

    Methods

    LoadConfigurationAsset()

    Declaration
    protected override void LoadConfigurationAsset()
    Overrides
    ScenarioBase.LoadConfigurationAsset()

    OnAwake()

    Declaration
    protected override void OnAwake()
    Overrides
    ScenarioBase.OnAwake()

    OnUpdate()

    OnUpdate is called every frame while the scenario is playing

    Declaration
    protected override void OnUpdate()
    Overrides
    ScenarioBase.OnUpdate()
    In This Article
    • Properties
      • isIterationComplete
      • isScenarioComplete
      • progressPercentage
    • Methods
      • LoadConfigurationAsset()
      • OnAwake()
      • OnUpdate()
    Back to top
    Terms of use
    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