同步

Packages/dev.yarnspinner.unity/Runtime/LineProviders/UnityLocalisedLineProvider.NotInstalled.cs

@@ -0,0 +1,101 @@
+/*
+Yarn Spinner is licensed to you under the terms found in the file LICENSE.md.
+*/
+
+#if !USE_UNITY_LOCALIZATION
+using System.Collections.Generic;
+using System.Threading;
+using UnityEngine;
+
+#nullable enable
+
+namespace Yarn.Unity.UnityLocalization
+{
+    /// <summary>
+    /// A line provider that uses the Unity Localization system to get localized
+    /// content for Yarn lines.
+    /// </summary>
+    public partial class UnityLocalisedLineProvider : LineProviderBehaviour
+    {
+        // When Unity Localization is not installed, types like TableReference
+        // no longer exist, and can't be deserialized into. This causes a loss
+        // of data. To get around this, we declare a new type with the same
+        // shape as TableReference to keep the data in. If and when Unity
+        // Localization is added to the project, the data stored in these fields
+        // is deserialized into actual TableReferences.
+        [System.Serializable]
+        public struct PlaceholderTableReference
+        {
+            [System.Serializable]
+            public struct PlaceholderTableIdentifier
+            {
+                [SerializeField] private string m_TableCollectionName;
+            }
+
+            [SerializeField] private PlaceholderTableIdentifier m_TableReference;
+        }
+
+        [SerializeField] internal PlaceholderTableReference? stringsTable;
+        [SerializeField] internal PlaceholderTableReference? assetTable;
+
+        /// <inheritdoc/>
+        public override string LocaleCode { get => "error"; set { } }
+
+        private const string NotInstalledError = nameof(UnityLocalisedLineProvider) + "requires that the Unity Localization package is installed in the project. To fix this, install Unity Localization.";
+
+        /// <inheritdoc/>
+        public override YarnTask PrepareForLinesAsync(IEnumerable<string> lineIDs, CancellationToken cancellationToken)
+        {
+            Debug.LogError(NotInstalledError);
+            return YarnTask.CompletedTask;
+        }
+
+        /// <inheritdoc/>
+        public override void Start()
+        {
+            Debug.LogError(NotInstalledError);
+        }
+
+        /// <inheritdoc/>
+        public override YarnTask<LocalizedLine> GetLocalizedLineAsync(Yarn.Line line, CancellationToken cancellationToken)
+        {
+            Debug.LogError($"{nameof(UnityLocalisedLineProvider)}: Can't create a localised line for ID {line.ID} because the Unity Localization package is not installed in this project. To fix this, install Unity Localization.");
+
+            return YarnTask.FromResult(new LocalizedLine()
+            {
+                TextID = line.ID,
+                RawText = $"{line.ID}: Unable to create a localised line, because the Unity Localization package is not installed in this project.",
+                Substitutions = line.Substitutions,
+            });
+        }
+
+        /// <inheritdoc/>
+        public override void RegisterMarkerProcessor(string attributeName, Markup.IAttributeMarkerProcessor markerProcessor)
+        {
+            Debug.LogWarning($"Unable to add a marker processor for {attributeName}, as the Unity Localization package is not installed in this project");
+        }
+
+        /// <inheritdoc/>
+        public override void DeregisterMarkerProcessor(string attributeName)
+        {
+            Debug.LogWarning($"Unable to remove a marker processor for {attributeName}, as the Unity Localization package is not installed in this project");
+        }
+    }
+
+#if UNITY_EDITOR
+    namespace Editor
+    {
+        using UnityEditor;
+        [CustomEditor(typeof(UnityLocalisedLineProvider))]
+        public class UnityLocalisedLineProviderPlaceholderEditor : Editor
+        {
+            public override void OnInspectorGUI()
+            {
+                EditorGUILayout.HelpBox("Unity Localization is not installed.", MessageType.Warning);
+            }
+        }
+    }
+#endif
+
+}
+#endif