Class RecorderBindings | Unity Recorder | 2.1.0-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class RecorderBindings

    Helper component mainly used to save Recorder's GameObject references. Some recorders (such as the Animation Recorder) require a GameObject reference from a Scene to record from. In such a case, this component is automatically added to the Scene and binds the selected GameObject to the Recorder Settings.

    Inheritance
    Object
    RecorderBindings
    Namespace: UnityEngine.Recorder
    Syntax
    public class RecorderBindings : MonoBehaviour

    Methods

    DuplicateBinding(String, String)

    Duplicates the binding from an existing key to a new one (makes dst point to the same object as src).

    Declaration
    public void DuplicateBinding(string src, string dst)
    Parameters
    Type Name Description
    String src

    The key to duplicate the binding from.

    String dst

    The new key that points to the same object.

    GetBindingValue(String)

    Retrieves a binding for an unique ID.

    Declaration
    public Object GetBindingValue(string id)
    Parameters
    Type Name Description
    String id

    The binding key.

    Returns
    Type Description
    UnityEngine.Object

    The value corresponding to the key – or null if the key doesn't exist.

    HasBindingValue(String)

    Tests if a value exists for a given key.

    Declaration
    public bool HasBindingValue(string id)
    Parameters
    Type Name Description
    String id

    The key to test.

    Returns
    Type Description
    Boolean

    True if the key value exists, False otherwise.

    IsEmpty()

    Tests if any bindings exist.

    Declaration
    public bool IsEmpty()
    Returns
    Type Description
    Boolean

    True if there are any existing bindings, False otherwise.

    RemoveBinding(String)

    Removes the binding for a key.

    Declaration
    public void RemoveBinding(string id)
    Parameters
    Type Name Description
    String id

    The unique key of the binding to remove.

    SetBindingValue(String, Object)

    Binds a particular ID to an Object value.

    Declaration
    public void SetBindingValue(string id, Object value)
    Parameters
    Type Name Description
    String id

    The unique ID key.

    UnityEngine.Object value

    The value for the key.

    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