docs.unity.cn
    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
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on Wednesday, June 21, 2023