docs.unity3d.com
    Show / Hide Table of Contents

    Class MetadataAttribute

    Provides a hint to the editor on where this metadata can be used. This is only used in the Editor and not considered when adding Metadata through script.

    Inheritance
    Object
    Attribute
    MetadataAttribute
    Namespace: UnityEngine.Localization.Metadata
    Syntax
    [AttributeUsage(AttributeTargets.Class)]
    public class MetadataAttribute : Attribute, _Attribute
    Examples

    This example shows how a Translation Status Metadata could be created. This will only appear in the Metadata menu for String Table Entries.

    [Serializable]
    [Metadata(AllowedTypes = MetadataType.StringTableEntry)]
    public class TranslationStatus : IMetadata
    {
    public enum TranslationState
    {
        Initial,
        Translated,
        Reviewed,
        Final,
    }
    
    public TranslationState translationStatus = TranslationState.Initial;
    }

    Properties

    AllowedTypes

    Describes where the Metadata can be added. This is used when generating the add Metadata menu.

    Declaration
    public MetadataType AllowedTypes { get; set; }
    Property Value
    Type Description
    MetadataType

    AllowMultiple

    Should it be possible to have more than 1 instance?

    Declaration
    public bool AllowMultiple { get; set; }
    Property Value
    Type Description
    Boolean

    MenuItem

    Name to use in the add Metadata menu. If empty then the class name will be used.

    Declaration
    public string MenuItem { get; set; }
    Property Value
    Type Description
    String

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
      • AllowedTypes
      • AllowMultiple
      • MenuItem
    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