UnityのText【使い方とスクリプト】【UGUI】

Text

表示させる文です。

Font

文字のフォントデータを何にするかです。

FontStyle

・Normal・・・通常のフォント
・Bold・・・太字
・Italic・・・斜体
・Bold and Italic・・・太字かつ斜体

FontSize

文字の大きさです。（上記の注意をよく呼んでください）

LineSpacing

行間の幅です。

何故か文字間の幅の設定はできません。

RichText

リッチテキストという文体の定義を使用するかしないかです。

Alignment

左から「左揃え」「中央揃え」「右揃え」「上揃え」「中央揃え」「下揃え」です。

Align By Geometry

ジオメトリで整列するかどうかです。

詳しくは↓で

Horizontal Overflow

・Wrap・・・横方向にTextの幅(RectTransformのWidth)を超えた時改行します。
　　＞Overflow・・・横方向にTextの幅を超えてもそのまま横に表示します

・Vertical Overflow
　　＞Truncate・・・縦方向にTextの高さを超えた時、越えた分の文書を表示しません。
　　＞Overflow・・・縦方向にTextの高さを超えてもそのまま縦に表示します。

Best Fit

文字の大きさをRectTransformのWidthとHeightに合わせるかどうかです。

一見便利なように見えますが、これはScaleで文字のサイズを変えるのではなく、FontSizeを変えて文字の大きさを変えています。

↑の注意点をよく読んで使用するのかどうか決めましょう。利便性をとるのかメモリをとるのかです。

Min Size

Best Fitにチェックが入っていると出てきます。

Best Fitで変更される最小のFontSizeです。

Max Size

Best Fitにチェックが入っていると出てきます。

Best Fitで変更される最大のFontSizeです。

Color

文字色を決めることができます。

Material

文字にマテリアルを持たせることができます。

何も入れていないとUnityのデフォルトのものが入ります。

RaycastTarget

衝突判定を持つかどうかを決められます。

例えばチェックが入っているときボタンの上にこのテキストが乗っていると、ボタンの判定の前にこのテキストにぶつかるのでボタンは反応しません。　　　　　　　　

alignByGeometry

グリフジオメトリを使用して文字の配置を行います。詳しくは↑で解説しています。

○ 使い方
インスペクターで設定できるため、スクリプトから動的に変更することはあまりないかもしれません。

Text t = GetComponent<Text>();
t.alignByGeometry = true;

alignment

文字の揃え方です。

enum型です。

○ 使い方
文字の揃え方を指定したい時に使用します。インスペクターから設定出来る為、スクリプトから動的に変更することはあまりないかもしれません。エディタ拡張で独自のテキストをワンボタンで生成したい時くらいでしょうか。

Text t = GetComponent<Text>();
t.alignment = TextAnchor.LowerRight;

cachedTextGenerator

テキストを描画する際に必要な情報を入れたTextGeneratorをキャッシュしておいたものです。

読み取り専用です。

○ 使い方
テキストを独自にカスタマイズしたい場合などに使用します。

Text t = GetComponent<Text>();
TextGenerator tg = t.cachedTextGenerator;

cachedTextGeneratorForLayout

テキストを描画する際のレイアウト情報をTextGeneratorをキャッシュしておいたものです。

読み取り専用です。

○ 使い方
テキストを独自にカスタマイズしたい場合などに使用します。

Text t = GetComponent<Text>();
TextGenerator tg = t.cachedTextGeneratorForLayout;

flexibleHeight

利用可能なスペースがある場合、このレイアウト要素が割り当てられる相対的な高さです。

レイアウトシステムによって変更されます。読み取り専用です。

○ 使い方
主に、UIにの大きさや並び等を計算で出したい場合に使用します。

Text t = GetComponent<Text>();
float h = t.flexibleHeight;

flexibleWidth

利用可能なスペースがある場合、このレイアウト要素が割り当てられる相対的な幅です。

レイアウトシステムによって変更されます。読み取り専用です。

○ 使い方
主に、UIにの大きさや並び等を計算で出したい場合に使用します。

Text t = GetComponent<Text>();
float w = t.flexibleWidth;

font

テキストに使用されるフォントです。

○ 使い方
フォントを変更したい場合に使用します。レイアウトや見た目の変更が設定出来るゲームなどで有効です。

Font f = Resources.Load<Font>("ロードするフォントの名前");
Text t = GetComponent<Text>();
t.font = f;

fontSize

フォントを描画する大きさです。

○ 使い方
フォントサイズはゲーム内で極力統一しないとメモリを食うので、あまり動的に変更することはオススメできません。エディタ拡張などで使用するといいと思います。

Text t = GetComponent<Text>();
t.fontSize = 10;

fontStyle

テキストで使用されるフォント様式です。

enum型です。

○ 使い方
フォント様式を変更したい場合に使用します。レイアウトや見た目の変更が設定出来るゲームなどで有効です。

Text t = GetComponent<Text>();
t.fontStyle = FontStyle.Bold;

horizontalOverflow

横方向にTextの幅(RectTransformのWidth)を超えた時どう表示するかです。

enum型です。

○ 使い方
インスペクターから設定出来る為、スクリプトから動的に変更することはあまりないと思います。

Text t = GetComponent<Text>();
t.horizontalOverflow = HorizontalWrapMode.Overflow;

layoutPriority

このコンポーネントのレイアウト優先度です。

レイアウトシステムに関連するコンポーネントが同じゲームオブジェクトに複数ついていた場合、この値が高いものが優先されます。

ですが、0 未満の値は無視されます。レイアウトシステムによって変更されます。読み取り専用です。

○ 使い方
このコンポーネントの優先度を知りたい場合に使用します。

Text t = GetComponent<Text>();
int p = t.layoutPriority;

lineSpacing

行間の大きさです。

○ 使い方
行間の大きさを調整したい時に使用します。

Text t = GetComponent<Text>();
t.lineSpacing = 1.1f;

mainTexture

このフォントを表示するために使っているフォントテクスチャです。

読み取り専用です。

○ 使い方
フォントテクスチャをゲーム上で使用することはほぼないと思うので、主にデバッグ用になるかと思います。文字の使用状況を確認するのに使えます。

Text t = GetComponent<Text>();
Texture tex = t.mainTexture;

minHeight

このレイアウトに割当てられた最小の高さです。

レイアウトシステムによって変更されます。読み取り専用です。

○ 使い方
主に、UIにの大きさや並び等を計算で出したい場合に使用します。

Text t = GetComponent<Text>();
float f = t.minHeight;

minWidth

このレイアウトに割当てられた最小の幅です。

レイアウトシステムによって変更されます。読み取り専用です。

○ 使い方
主に、UIにの大きさや並び等を計算で出したい場合に使用します。

Text t = GetComponent<Text>();
float f = t.minWidth;

pixelsPerUnit

PixelsPerUnitはピクセルに対するゲーム上での大きさです。

UnitはUnity上の距離です。PixelsPerUnitが100で、テキストの大きさが100×100ピクセルの場合、Unity上での大きさは１×1のものと同じ大きさになります。Scaleの値を考慮に入れて計算されます。

ダイナミックフォントについては、値は Canvas の Scale Factor と同等です。ダイナミックフォントではない場合は、要求されたテキストサイズやフォントサイズから計算されます。

読取専用です。

○ 使い方
主に、UIにの大きさや並び等を計算で出したい場合に使用します。

Text t = GetComponent<Text>();
float f = t.pixelsPerUnit;

preferredHeight

このTextに入っている文字列を実際に表示した際の高さです。

レイアウトシステムによって変更されます。読み取り専用です。

Horizontal OverflowがWrapになっている状態でTextのwidthが十分出ないと改行が入って１行分高くなってしまいます。

○ 使い方
主に、UIにの大きさや並び等を計算で出したい場合に使用します。

Text t = GetComponent<Text>();
float f = t.preferredHeight;

preferredWidth

このTextに入っている文字列を実際に表示した際の幅です。

レイアウトシステムによって変更されます。読み取り専用です。

○ 使い方
主に、UIにの大きさや並び等を計算で出したい場合に使用します。

Text t = GetComponent<Text>();
float f = t.preferredHeight;

resizeTextForBestFit

テキストの自動サイズ変更を有効にするかどうかです。

scaleではなくfontsizeが変わります。

○ 使い方
ベストフィットを有効にしたい場合に使用します。フォントサイズを変更するので、メモリ使用量に注意してください。

Text t = GetComponent<Text>();
t.resizeTextForBestFit = true;

resizeTextMaxSize

テキストの自動サイズ変更が有効な場合の最大のfontsizeです。

○ 使い方
ベストフィットが有効な場合の最大の大きさを指定したい場合に使用します。インスペクターから設定出来る為、スクリプトから変える事はあまりないかもしれません。

Text t = GetComponent<Text>();
t.resizeTextMaxSize = 1;

resizeTextMinSize

テキストの自動サイズ変更が有効な場合の最小のfontsizeです。

○ 使い方
ベストフィットが有効な場合の最大の大きさを指定したい場合に使用します。インスペクターから設定出来る為、スクリプトから変える事はあまりないかもしれません。

使い方
Text t = GetComponent<Text>();
t.resizeTextMinSize = 1;

supportRichText

リッチテキストを使用するかどうかです。

○ 使い方
インスペクターから設定出来る為、スクリプトから動的に変更することはあまりないかもしれません。エディタ拡張で独自のテキストをワンボタンで生成したい時くらいでしょうか。

Text t = GetComponent<Text>();
t.supportRichText = true;

text

このコンポーネントが表示する文字列です。

○ 使い方
表示したいテキストを変更する際に使用します。

Text t = GetComponent<Text>();
t.text = "a";

verticalOverflow

縦方向にTextの高さ(RectTransformのHeight)を超えた時どう表示するかです。

enum型です。

○ 使い方
インスペクターから設定出来る為、スクリプトから動的に変更することはあまりないと思います。

Text t = GetComponent<Text>();
t.verticalOverflow = VerticalWrapMode.Overflow;