Class LocalizedString

Source/Engine/Localization/LocalizedString.cs:21–149

    }

    partial class LocalizedString : IEquatable<LocalizedString>, IEquatable<string>, IComparable, IComparable<LocalizedString>, IComparable<string>
    {
        /// <summary>
        /// Empty string without localization.
        /// </summary>
        public static readonly LocalizedString Empty = new LocalizedString(null);

        /// <summary>
        /// Initializes a new instance of the <see cref="LocalizedString"/> class.
        /// </summary>
        /// <param name="value">The value.</param>
        public LocalizedString(string value)
        {
            Value = value;
        }

        /// <summary>
        /// Gets the localized plural string for the current language by using string id lookup.
        /// </summary>
        /// <param name="n">The value count for plural message selection.</param>
        /// <returns>The localized text.</returns>
        public string ToStringPlural(int n)
        {
            return string.IsNullOrEmpty(Value) ? Localization.GetPluralString(Id, n) : string.Format(Value, n);
        }

        /// <summary>
        /// Implicit converter of <see cref="LocalizedString"/> into <see cref="string"/>.
        /// </summary>
        /// <param name="str">The localized string.</param>
        /// <returns>The string.</returns>
        public static implicit operator string(LocalizedString str)
        {
            if ((object)str == null)
                return null;
            return string.IsNullOrEmpty(str.Value) ? Localization.GetString(str.Id) : str.Value;
        }

        /// <summary>
        /// Implicit converter of <see cref="string"/> into <see cref="LocalizedString"/>.
        /// </summary>
        /// <param name="str">The string.</param>
        /// <returns>The localized string.</returns>
        public static implicit operator LocalizedString(string str)
        {
            if (str == null)
                return null;
            return new LocalizedString(str);
        }

        /// <summary>
        /// Compares two localized strings.
        /// </summary>
        /// <param name="left">The lft string.</param>
        /// <param name="right">The right string.</param>
        /// <returns>True if both values are equal, otherwise false.</returns>
        public static bool operator ==(LocalizedString left, LocalizedString right)
        {