docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ScenarioBase

    Derive ScenarioBase to implement a custom scenario

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    ScenarioBase
    Scenario<T>
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    object.MemberwiseClone()
    Namespace: UnityEngine.Experimental.Perception.Randomization.Scenarios
    Assembly: solution.dll
    Syntax
    [DefaultExecutionOrder(-1)]
    public abstract class ScenarioBase : MonoBehaviour

    Fields

    Name Description
    quitOnComplete

    If true, this scenario will quit the Unity application when it's finished executing

    serializedConstantsFileName

    The name of the Json file this scenario's constants are serialized to/from.

    Properties

    Name Description
    activeScenario

    Returns the active parameter scenario in the scene

    currentIteration

    The current iteration index of the scenario

    currentIterationFrame

    The number of frames that have elapsed since the current scenario iteration was Setup

    framesSinceInitialization

    The number of frames that have elapsed since the scenario was initialized

    genericConstants

    Returns this scenario's non-typed serialized constants

    isIterationComplete

    Returns whether the current scenario iteration has completed

    isScenarioComplete

    Returns whether the entire scenario has completed

    randomizers

    Return the list of randomizers attached to this scenario

    serializedConstantsFilePath

    Returns the file location of the JSON serialized constants

    tagManager

    The RandomizerTagManager attached to this scenario

    Methods

    Name Description
    CreateRandomizer<T>()

    Creates a new randomizer and adds it to this scenario

    Deserialize()

    Deserializes constants saved in a JSON file located at serializedConstantsFilePath

    GenerateRandomSeed(uint)

    Generates a random seed by hashing the current scenario iteration with a given base random seed

    GenerateRandomSeedFromIndex(int, uint)

    Generates a random seed by hashing three values together: an arbitrary index value, the current scenario iteration, and a base random seed. This method is useful for deterministically generating random seeds from within a for-loop.

    GetRandomizerIndex<T>()

    Returns the execution order index of a randomizer of the given type

    GetRandomizer<T>()

    Finds and returns a randomizer attached to this scenario of the specified Randomizer type

    IncrementIteration()

    Progresses the current scenario iteration

    OnAwake()

    This method executed directly after this scenario has been registered and initialized

    RemoveRandomizer<T>()

    Removes a randomizer of the specified type from this scenario

    ReorderRandomizer(int, int)

    Moves a randomizer from one index to another

    Serialize()

    Serializes the scenario's constants to a JSON file located at serializedConstantsFilePath

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)