docs.unity3d.com
    Show / Hide Table of Contents

    Class Assignment<T, V>

    Class Assignment.

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    Assignment
    Assignment<T, V>
    GameObjectVisibilityAssignment
    MaterialAssignment
    VisibilityAssignment
    Inherited Members
    Assignment.defaultTargetQueryNodeType
    Assignment.defaultValueQueryNodeType
    Assignment.Apply()
    Assignment.Invert(Variant)
    Assignment.AddDefaultQueries()
    Assignment.RemoveQueries()
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    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, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, 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
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    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, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEngine.Industrial.Configuring.Core
    Syntax
    [Serializable]
    public abstract class Assignment<T, V> : Assignment
    Type Parameters
    Name Description
    T
    V

    Properties

    targetDeferredQuery

    Gets the target deferred query.

    Declaration
    public override DeferredQuery targetDeferredQuery { get; }
    Property Value
    Type Description
    DeferredQuery

    The target deferred query.

    Overrides
    Assignment.targetDeferredQuery

    targetQuery

    Gets the target query.

    Declaration
    public QueryNode<T> targetQuery { get; }
    Property Value
    Type Description
    QueryNode<T>

    The target query.

    targetQueryNode

    Gets the target query node.

    Declaration
    public override QueryNode targetQueryNode { get; }
    Property Value
    Type Description
    QueryNode

    The target query node.

    Overrides
    Assignment.targetQueryNode

    targetQueryNodeType

    Gets the type of the target query node.

    Declaration
    public override Type targetQueryNodeType { get; }
    Property Value
    Type Description
    Type

    The type of the target query node.

    Overrides
    Assignment.targetQueryNodeType

    valueDeferredQuery

    Gets the value deferred query.

    Declaration
    public override DeferredQuery valueDeferredQuery { get; }
    Property Value
    Type Description
    DeferredQuery

    The value deferred query.

    Overrides
    Assignment.valueDeferredQuery

    valueQuery

    Gets the value query.

    Declaration
    public QueryNode<V> valueQuery { get; }
    Property Value
    Type Description
    QueryNode<V>

    The value query.

    valueQueryNode

    Gets the value query node.

    Declaration
    public override QueryNode valueQueryNode { get; }
    Property Value
    Type Description
    QueryNode

    The value query node.

    Overrides
    Assignment.valueQueryNode

    valueQueryNodeType

    Gets the type of the value query node.

    Declaration
    public override Type valueQueryNodeType { get; }
    Property Value
    Type Description
    Type

    The type of the value query node.

    Overrides
    Assignment.valueQueryNodeType

    Methods

    AddDefaultTargetQuery()

    Add DefaultTargetQuery to the Assignment

    Declaration
    public override void AddDefaultTargetQuery()
    Overrides
    Assignment.AddDefaultTargetQuery()

    AddDefaultValueQuery()

    Add DefaultValueQuery to the Assignment

    Declaration
    public override void AddDefaultValueQuery()
    Overrides
    Assignment.AddDefaultValueQuery()

    AddExistingTargetQuery(QueryNode<T>, Boolean)

    Adds the existing target query.

    Declaration
    public void AddExistingTargetQuery(QueryNode<T> targetQuery, bool clearExisting = false)
    Parameters
    Type Name Description
    QueryNode<T> targetQuery

    The target query.

    Boolean clearExisting

    if set to true [clear existing].

    AddExistingValueQuery(QueryNode<V>, Boolean)

    Adds the existing value query.

    Declaration
    public void AddExistingValueQuery(QueryNode<V> valueQ, bool clearExisting = false)
    Parameters
    Type Name Description
    QueryNode<V> valueQ

    The value q.

    Boolean clearExisting

    if set to true [clear existing].

    AddTargetQuery(Type, GameObject)

    Creates a target query node of the given type, sets it to be used and returns it.

    Declaration
    public QueryNode<T> AddTargetQuery(Type targetQueryNodeType, GameObject parent = null)
    Parameters
    Type Name Description
    Type targetQueryNodeType

    Type must be assignable to TQ

    GameObject parent

    The parent.

    Returns
    Type Description
    QueryNode<T>

    QueryNode<T>.

    Exceptions
    Type Condition
    ArgumentNullException

    The target query node type must not be null.

    ArgumentException

    AddTargetQuery<QueryNodeT>(GameObject)

    Creates a target query node of the given type, sets it to be used and returns it.

    Declaration
    public QueryNodeT AddTargetQuery<QueryNodeT>(GameObject parent = null)
        where QueryNodeT : QueryNode<T>
    Parameters
    Type Name Description
    GameObject parent

    The parent.

    Returns
    Type Description
    QueryNodeT

    QueryNodeT.

    Type Parameters
    Name Description
    QueryNodeT

    The type of the query node t.

    AddValueQuery(Type, GameObject)

    Creates a value query node of the given type, sets it to be used and returns it.

    Declaration
    public QueryNode<V> AddValueQuery(Type valueQueryNodeType, GameObject parent = null)
    Parameters
    Type Name Description
    Type valueQueryNodeType

    Type must be assignable to VQ

    GameObject parent

    The parent.

    Returns
    Type Description
    QueryNode<V>

    QueryNode<V>.

    Exceptions
    Type Condition
    ArgumentNullException

    The value query node type must not be null.

    ArgumentException

    AddValueQuery<QueryNodeV>(GameObject)

    Creates a value query node of the given type, sets it to be used and returns it.

    Declaration
    public QueryNodeV AddValueQuery<QueryNodeV>(GameObject parent = null)
        where QueryNodeV : QueryNode<V>
    Parameters
    Type Name Description
    GameObject parent

    The parent.

    Returns
    Type Description
    QueryNodeV

    QueryNodeV.

    Type Parameters
    Name Description
    QueryNodeV

    The type of the query node v.

    IsValid(QueryContext)

    Verify if assignment is valid

    Declaration
    public virtual bool IsValid(QueryContext context = null)
    Parameters
    Type Name Description
    QueryContext context
    Returns
    Type Description
    Boolean

    Returns true if resolving the query finds the target and value, false otherwise

    RemoveTargetQuery()

    Remove the TargetQuery from the Assignment

    Declaration
    public override void RemoveTargetQuery()
    Overrides
    Assignment.RemoveTargetQuery()

    RemoveValueQuery()

    Remove the TargetQuery from the Assignment

    Declaration
    public override void RemoveValueQuery()
    Overrides
    Assignment.RemoveValueQuery()

    ResolveTarget(QueryContext, Boolean)

    Resolve target for the targetQuery

    Declaration
    public T ResolveTarget(QueryContext context = null, bool create = true)
    Parameters
    Type Name Description
    QueryContext context

    The context.

    Boolean create

    if set to true [create].

    Returns
    Type Description
    T

    T.

    ResolveValue(QueryContext, Boolean)

    Resolve value for the valueQuery

    Declaration
    public V ResolveValue(QueryContext context = null, bool create = true)
    Parameters
    Type Name Description
    QueryContext context

    The context.

    Boolean create

    if set to true [create].

    Returns
    Type Description
    V

    V.

    Extension Methods

    Async.StartThrowingCoroutine(MonoBehaviour, IEnumerator, Action<Exception>)
    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