fungus/Assets/Fungus/Narrative/Scripts/SayDialog.cs

/**
 * This code is part of the Fungus library (http://fungusgames.com) maintained by Chris Gregan (http://twitter.com/gofungus).
 * It is released for free under the MIT open source license (https://github.com/snozbot/fungus/blob/master/LICENSE)
 */

using UnityEngine;
using UnityEngine.UI;
using System;
using System.Collections;
using System.Collections.Generic;

namespace Fungus
{

	public class SayDialog : MonoBehaviour
	{
		// Currently active Say Dialog used to display Say text
		public static SayDialog activeSayDialog;

		// Most recent speaking character
		public static Character speakingCharacter;

		public float fadeDuration = 0.25f;
		
		public Button continueButton;
		public Canvas dialogCanvas;
		public Text nameText;
		public Text storyText;
		public Image characterImage;
	
		[Tooltip("Adjust width of story text when Character Image is displayed (to avoid overlapping)")]
		public bool fitTextWithImage = true;

		protected float startStoryTextWidth; 
		protected float startStoryTextInset;

		protected WriterAudio writerAudio;
		protected Writer writer;
		protected CanvasGroup canvasGroup;

		protected bool fadeWhenDone = true;
		protected float targetAlpha = 0f;
		protected float fadeCoolDownTimer = 0f;

        protected Sprite currentCharacterImage;

		public static SayDialog GetSayDialog()
		{
			if (activeSayDialog == null)
			{
				// Use first Say Dialog found in the scene (if any)
				SayDialog sd = GameObject.FindObjectOfType<SayDialog>();
				if (sd != null)
				{
					activeSayDialog = sd;
				}
				
				if (activeSayDialog == null)
				{
					// Auto spawn a say dialog object from the prefab
					GameObject prefab = Resources.Load<GameObject>("SayDialog");
					if (prefab != null)
					{
						GameObject go = Instantiate(prefab) as GameObject;
						go.SetActive(false);
						go.name = "SayDialog";
						activeSayDialog = go.GetComponent<SayDialog>();
					}
				}
			}
			
			return activeSayDialog;
		}

		protected Writer GetWriter()
		{
			if (writer != null)
			{
				return writer;
			}

			writer = GetComponent<Writer>();
			if (writer == null)
			{
				writer = gameObject.AddComponent<Writer>();
			}

			return writer;
		}

		protected CanvasGroup GetCanvasGroup()
		{
			if (canvasGroup != null)
			{
				return canvasGroup;
			}
			
			canvasGroup = GetComponent<CanvasGroup>();
			if (canvasGroup == null)
			{
				canvasGroup = gameObject.AddComponent<CanvasGroup>();
			}
			
			return canvasGroup;
		}

		protected WriterAudio GetWriterAudio()
		{
			if (writerAudio != null)
			{
				return writerAudio;
			}
			
			writerAudio = GetComponent<WriterAudio>();
			if (writerAudio == null)
			{
				writerAudio = gameObject.AddComponent<WriterAudio>();
			}
			
			return writerAudio;
		}

		protected void Start()
		{
			// Dialog always starts invisible, will be faded in when writing starts
			GetCanvasGroup().alpha = 0f;

			// Add a raycaster if none already exists so we can handle dialog input
			GraphicRaycaster raycaster = GetComponent<GraphicRaycaster>();
			if (raycaster == null)
			{
				gameObject.AddComponent<GraphicRaycaster>();	
			}

            // It's possible that SetCharacterImage() has already been called from the
            // Start method of another component, so check that no image has been set yet.
            // Same for nameText.

            if (nameText != null && nameText.text == "")
            {
                SetCharacterName("", Color.white);
            }
            if (currentCharacterImage == null)
            {                
                // Character image is hidden by default.
                SetCharacterImage(null);
            }
		}

        public virtual void Say(string text, bool clearPrevious, bool waitForInput, bool fadeWhenDone, bool stopVoiceover, AudioClip voiceOverClip, Action onComplete)
		{
            StartCoroutine(SayInternal(text, clearPrevious, waitForInput, fadeWhenDone, stopVoiceover, voiceOverClip, onComplete));
		}

        public virtual IEnumerator SayInternal(string text, bool clearPrevious, bool waitForInput, bool fadeWhenDone, bool stopVoiceover, AudioClip voiceOverClip, Action onComplete)
		{
			Writer writer = GetWriter();

			if (writer.isWriting || writer.isWaitingForInput)
			{
				writer.Stop();
				while (writer.isWriting || writer.isWaitingForInput)
				{
					yield return null;
				}
			}

            gameObject.SetActive(true);

			this.fadeWhenDone = fadeWhenDone;

			// Voice over clip takes precedence over a character sound effect if provided

			AudioClip soundEffectClip = null;
			if (voiceOverClip != null)
			{
				WriterAudio writerAudio = GetWriterAudio();
				writerAudio.PlayVoiceover(voiceOverClip);
			}
			else if (speakingCharacter != null)
			{
				soundEffectClip = speakingCharacter.soundEffect;
			}

			yield return StartCoroutine(writer.Write(text, clearPrevious, waitForInput, stopVoiceover, soundEffectClip, onComplete));
		}

		protected virtual void LateUpdate()
		{
			UpdateAlpha();

			if (continueButton != null)
			{
				continueButton.gameObject.SetActive( GetWriter().isWaitingForInput );
			}
		}

		/**
		 * Tell dialog to fade out if it's finished writing.
		 */
		public virtual void FadeOut()
		{
			fadeWhenDone = true;
		}

		/**
		 * Stop a Say Dialog while its writing text.
		 */
		public virtual void Stop()
		{
			fadeWhenDone = true;
			GetWriter().Stop();
		}

		protected virtual void UpdateAlpha()
		{
			if (GetWriter().isWriting)
			{
				targetAlpha = 1f;
				fadeCoolDownTimer = 0.1f;
			}
			else if (fadeWhenDone && fadeCoolDownTimer == 0f)
			{
				targetAlpha = 0f;
			}
			else
			{
				// Add a short delay before we start fading in case there's another Say command in the next frame or two.
				// This avoids a noticeable flicker between consecutive Say commands.
				fadeCoolDownTimer = Mathf.Max(0f, fadeCoolDownTimer - Time.deltaTime);
			}

			CanvasGroup canvasGroup = GetCanvasGroup();
			float fadeDuration = GetSayDialog().fadeDuration;
			if (fadeDuration <= 0f)
			{
				canvasGroup.alpha = targetAlpha;
			}
			else
			{
				float delta = (1f / fadeDuration) * Time.deltaTime;
				float alpha = Mathf.MoveTowards(canvasGroup.alpha, targetAlpha, delta);
				canvasGroup.alpha = alpha;

				if (alpha <= 0f)
				{					
					// Deactivate dialog object once invisible
					gameObject.SetActive(false);
				}
			}
		}

		public virtual void SetCharacter(Character character, Flowchart flowchart = null)
		{
			if (character == null)
			{
				if (characterImage != null)
				{
					characterImage.gameObject.SetActive(false);
				}
				if (nameText != null)
				{
					nameText.text = "";
				}
				speakingCharacter = null;
			}
			else
			{
				Character prevSpeakingCharacter = speakingCharacter;
				speakingCharacter = character;
				
				// Dim portraits of non-speaking characters
				foreach (Stage stage in Stage.activeStages)
				{

					if (stage.dimPortraits)
					{
						foreach (Character c in stage.charactersOnStage)
						{
							if (prevSpeakingCharacter != speakingCharacter)
							{
								if (c != speakingCharacter)
								{
									stage.SetDimmed(c, true);
								}
								else
								{
									stage.SetDimmed(c, false);
								}
							}
						}
					}
				}
				
				string characterName = character.nameText;
				
				if (characterName == "")
				{
					// Use game object name as default
					characterName = character.name;
				}
				
				if (flowchart != null)
				{
					characterName = flowchart.SubstituteVariables(characterName);
				}
				
				SetCharacterName(characterName, character.nameColor);
			}
		}
		
		public virtual void SetCharacterImage(Sprite image)
		{
			if (characterImage == null)
			{
				return;
			}

			if (image != null)
			{
				characterImage.sprite = image;
				characterImage.gameObject.SetActive(true);
                currentCharacterImage = image;
			}
			else
			{
				characterImage.gameObject.SetActive(false);

				if (startStoryTextWidth != 0)
				{
					storyText.rectTransform.SetInsetAndSizeFromParentEdge(RectTransform.Edge.Left, 
					                                                      startStoryTextInset, 
					                                                      startStoryTextWidth);
				}
			}

			// Adjust story text box to not overlap image rect
			if (fitTextWithImage && 
			    storyText != null &&
			    characterImage.gameObject.activeSelf)
			{
				if (startStoryTextWidth == 0)
				{
					startStoryTextWidth = storyText.rectTransform.rect.width;
					startStoryTextInset = storyText.rectTransform.offsetMin.x; 
				}

				// Clamp story text to left or right depending on relative position of the character image
				if (storyText.rectTransform.position.x < characterImage.rectTransform.position.x)
				{
					storyText.rectTransform.SetInsetAndSizeFromParentEdge(RectTransform.Edge.Left, 
					                                                      startStoryTextInset, 
					                                                      startStoryTextWidth - characterImage.rectTransform.rect.width);
				}
				else
				{
					storyText.rectTransform.SetInsetAndSizeFromParentEdge(RectTransform.Edge.Right, 
					                                                      startStoryTextInset, 
					                                                      startStoryTextWidth - characterImage.rectTransform.rect.width);
				}
			}
		}
		
		public virtual void SetCharacterName(string name, Color color)
		{
			if (nameText != null)
			{
				nameText.text = name;
				nameText.color = color;
			}
		}
		
		public virtual void Clear()
		{
			ClearStoryText();
			
			// Kill any active write coroutine
			StopAllCoroutines();
		}
		
		protected virtual void ClearStoryText()
		{
			if (storyText != null)
			{
				storyText.text = "";
			}
		}
		
		public static void StopPortraitTweens()
		{
			// Stop all tweening portraits
			foreach( Character c in Character.activeCharacters )
			{
				if (c.state.portraitImage != null)
				{
					if (LeanTween.isTweening(c.state.portraitImage.gameObject))
					{
						LeanTween.cancel(c.state.portraitImage.gameObject, true);
						
						PortraitController.SetRectTransform(c.state.portraitImage.rectTransform, c.state.position);
						if (c.state.dimmed == true)
						{
							c.state.portraitImage.color = new Color(0.5f, 0.5f, 0.5f, 1f);
						}
						else
						{
							c.state.portraitImage.color = Color.white;
						}
					}
				}
			}
		}
	}

}