MetadataCollection

Description

Holds the metadata items attached to a single localization target.

A collection is present on entries, shared keys, tables, and the shared data, so authors can attach comments and custom properties (for example excluding an entry from export). Items are stored by reference, so any IMetadata implementation keeps its own serialized fields. Query items by type with MetadataCollection.GetMetadata, MetadataCollection.GetMetadatas, and MetadataCollection.Contains, and change the contents with MetadataCollection.AddMetadata and MetadataCollection.RemoveMetadata.

Additional resources: IMetadata, Comment, ExcludeEntryFromEditorExport, SharedTableData

<para>Add a comment to a collection, then read it back by type.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class MetadataCollectionOverviewExample
    {
        public void Run()
        {
            var metadata = new MetadataCollection();
            metadata.AddMetadata(new Comment { CommentText = "Shown on the main menu." });

            if (metadata.Contains<Comment>())
                Debug.Log(metadata.GetMetadata<Comment>().CommentText);
        }
    }
}

Properties

Public Methods