UnityのuGUIでTextがはみでた時に「...」を付ける方法です。
Unity2019.4.1f1
はじめに
この記事ではuGUIでテキストがはみでた時に「...」という省略記号を付ける方法についてまとめます。
前提として、Text Mesh ProのTextには同等の機能があります(OverflowをEllipsisに設定する)。
そしてこれからの時代は基本的にText Mesh Proを使ったほうがいいです。
ただライブラリの中で使うにはText Mesh Proだと管理しづらい関係で本コンポーネントを作りました。
何かの役に立つかもしれないので公開しておきます。
実装
実装は以下の通りです。
[ExecuteAlways] [RequireComponent(typeof(Text))] public class UITextEllipsisOverflow : UIBehaviour { private const string Ellipsis = "..."; [SerializeField] [HideInInspector] private Text _text; [SerializeField] [Tooltip("If set to true, the text will be overwritten in EditMode.")] private bool _applyInEditMode = true; protected override void Awake() { base.Awake(); if (!Application.isPlaying) { // Get If this component is attached. _text = GetComponent<Text>(); } } protected override void OnRectTransformDimensionsChange() { base.OnRectTransformDimensionsChange(); Apply(); } protected override void OnValidate() { base.OnValidate(); if (!Application.isPlaying) { Apply(); } } private void Apply() { if (!_applyInEditMode && !Application.isPlaying) { return; } if (!IsActive() || _text == null) { return; } var rectTransform = _text.rectTransform; var generator = _text.cachedTextGenerator; var settings = _text.GetGenerationSettings(rectTransform.rect.size); generator.Populate(_text.text, settings); var text = _text.text; if (rectTransform.rect.width == 0 || rectTransform.rect.height == 0) { // Do nothing because the layout seems not to have been built yet. return; } if (text.Length == 0) { return; } if (_text.horizontalOverflow == HorizontalWrapMode.Wrap) { var height = generator.GetPreferredHeight(text, settings) / settings.scaleFactor; if (rectTransform.rect.size.y >= height) { return; } while (true) { text = text.Remove(text.Length - 1); height = generator.GetPreferredHeight(text + Ellipsis, settings) / settings.scaleFactor; if (text.Length == 0) { break; } if (rectTransform.rect.size.y >= height) { text += Ellipsis; break; } } } if (_text.horizontalOverflow == HorizontalWrapMode.Overflow) { var width = generator.GetPreferredWidth(text, settings) / settings.scaleFactor; if (rectTransform.rect.size.x >= width) { return; } while (true) { text = text.Remove(text.Length - 1); width = generator.GetPreferredWidth(text + Ellipsis, settings) / settings.scaleFactor; if (text.Length == 0) { break; } if (rectTransform.rect.size.x >= width) { text += Ellipsis; break; } } } _text.text = text; } }
使い方
使い方としてはTextコンポーネントがアタッチされているGameObjectにアタッチするだけです。
実装の都合上、入力した文字列は(長かった場合に)省略された形で上書きされてしまうのと、
基本的にランタイムで使うことが想定されるため、Edit Modeで適用するかどうかはオプションにしています。