Class BindingsStore | Project Tiny | 0.31.0-preview.24
docs.unity3d.com
    Show / Hide Table of Contents

    Class BindingsStore

    Stores a map between authoring binding names (their "MonoBehaviour" name) and runtime binding names (their "ECS" name).

    Inheritance
    Object
    BindingsStore
    Namespace: Unity.Tiny.Animation.Editor
    Syntax
    public static class BindingsStore

    Methods

    CreateBindingNameRemap(String, String)

    Use this method to create a new authoring to runtime binding name remap.

    Declaration
    public static void CreateBindingNameRemap(string authoringName, string convertedName)
    Parameters
    Type Name Description
    String authoringName

    The name of the binding in the authoring world.

    String convertedName

    The name of the binding in the runtime world.

    Remarks

    It can be very useful to use

    typeof(MyComponentType).Name
    and
    nameof(MyComponentType.myAnimatedField)
    when creating a binding name remap.

    DiscardBinding(String)

    Use this method to tell Tiny Animation that an authoring-time binding is not supported at runtime.

    Declaration
    public static void DiscardBinding(string authoringName)
    Parameters
    Type Name Description
    String authoringName

    The name of the binding in the authoring world.

    Remarks

    All this method does is prevent the system from displaying warnings when a binding is not handled. Useful when an RGBA value becomes RGB in DOTS, for example (you can explicitly drop the A and avoid warnings).

    TryGetConvertedBindingName(String, out String)

    Use this method to retrieve the runtime name of a binding by using its authoring name.

    Declaration
    public static bool TryGetConvertedBindingName(string authoringName, out string convertedName)
    Parameters
    Type Name Description
    String authoringName

    The name of the binding in the authoring world.

    String convertedName

    A string in which to store the name of the binding in the runtime world, if found.

    Returns
    Type Description
    Boolean
    true
    if a mapping exists,
    false
    otherwise.
    In This Article
    • Methods
      • CreateBindingNameRemap(String, String)
      • DiscardBinding(String)
      • TryGetConvertedBindingName(String, out String)
    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