docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SystemGraphComponent

    Main monobehaviour component for sytem graph

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    SystemGraphComponent
    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, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    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.FindObjectsOfType(Type, bool)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    object.MemberwiseClone()
    Namespace: Mechatronics.SystemGraph
    Assembly: solution.dll
    Syntax
    [ExecuteInEditMode]
    [Serializable]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.systemgraph@2.0/manual/Architecture.html")]
    public class SystemGraphComponent : MonoBehaviour

    Constructors

    Name Description
    SystemGraphComponent()

    Initializes a new instance of the SystemGraphComponent class.

    Fields

    Name Description
    _bindingsFoldOut

    The bindings fold out for Inspector

    _graphReference

    The graph reference used as an asset

    _propertiesFoldOut

    The properties fold out for Inspector

    Properties

    Name Description
    ComponentManager

    Contains data on all used properties and bindings for the current graph instance.

    DiagnosticsLog

    Diagnostics Log

    ErrorsInTraceLog

    Returns the state of errors in diagnostics log

    GraphDescriptor

    Descriptor that contains information about the current graph and all subgraphs.

    GraphObject

    The current runtime graph asset being used.

    GraphObjectReference

    Reference graph asset, this asset reference is copied and used for runtime. Any changes to this asset will not take place in the graph until a new Update(), upon which this component will replace the current runtime asset with the updated reference.

    InstanceGuid

    GUID unique to every instance of SystemGraphComponent in the scene.

    LinkResult

    Gets the link result.

    Linker

    Gets the linker.

    Scheduler

    Gets the scheduler.

    Upgrading

    Indicator for when the SystemGraph is undergoing an upgrade.

    Methods

    Name Description
    Awake()

    Awake and assign new guid if necessary.

    ClearDiagnosticsLog()

    Clear Diagnostics Log

    ClearPendingGraphAssets()

    Remove all pending graphs in the stack.

    CreateRuntimeDescriptor(bool)

    Creates all nodes and binds properties to nodes.

    ForceValidate()

    Check for reference asset diverging from current runtime asset, if so then update runtime asset.

    GetAllNodeRuntime()

    Get a map of NodeGuid -> NodeDescriptor.

    GetBindingValue<T>(string, out T)

    This method can be used to get the binding value.

    GetBinding<T>(string)

    This method can be used to retrieve the binding object by LynX path.

    GetComponentAttachments()

    Get all the components used by this SystemGraphComponent. Components include properties and bindings.

    GetNodeRuntime(string)

    Find node in the current runtime asset by guid.

    GetPropertyValue<T>(string, out T)

    This method can be used to get the property value.

    GetProperty<T>(string)

    This method can be used to retrieve the property object by name.

    Log(string)

    General debug log. See LogError().

    LogError(string)

    Appends the graph name to the start of msg and logs error to console.

    LogWarning(string)

    Logs warning, see LogError()

    OnDestroy()

    Deregister this component from the manager of all system graphs.

    PushGraphAsset(PendingGraphDescriptor)

    Add graph to the reference graph stack.

    RefreshRuntimeParameters(bool, bool, bool)

    Checks the current graph runtime graph asset against the reference graph asset. If the reference asset has changed, then updates the current runtime asset to match the reference asset. Then, Updates parameters and bindings to match the (possible) new asset.

    SetBindingValue<T>(string, T)

    This method can be used to set the binding value.

    SetPropertyValue<T>(string, T)

    This method can be used to set the property value.

    Start()

    Starts this instance.

    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)