UEFN Verse言語 メタバース

【UEFN】text_block classとは?メンバーやデータ・機能など解説

【UEFN】text_block classとは?メンバーやデータ・機能など解説
みなみ

text_block classの概要について教えてください!

りゅう

初心者向けにわかりやすく解説してほしいですね!

こんなお悩みを解決します。

 本記事の内容
 本記事の信頼性

この記事を書いている僕は、クリエイター兼ブロガーです。実際にUEFNを使っており、現在進行形で学んでいます。

今回は、text_block classについて解説します。

なお、以下のコードの解説文は、プログラミング初心者の主がなんとか調べて記述したものです。

参考程度にどうぞ。

あすか

誤りがありましたら恐縮ですm(_ _)m

もくじ

text_block classとは

text_block classとは

text_block クラスは、ユーザーにテキストを表示するためのウィジェットです。

これは、ゲームやアプリケーションのユーザーインターフェースにおいて、テキストを表示するための要素です。

例えば、ゲーム内のキャラクターダイアログやチュートリアルメッセージ、またはアプリケーションのユーザーメッセージなどを表示するのに役立ちます。

以下に特徴をまとめてみました↓

 text_blockクラスの特徴
  • テキストの表示と設定
    • text_block クラスでは、画面上にテキストを表示することができます。
    • 表示するテキストを設定することができますし、テキストの色やフォントなどもカスタマイズできます。
  • テキストの配置
    • テキストを画面上でどのように配置するかも制御できます。
    • 左寄せ、中央寄せ、右寄せなどの配置オプションがあります。
  • テキストの制御
    • テキストが画面に収まらない場合の挙動も制御できます。
    • テキストが長すぎる場合には、自動的に改行したり、テキストを省略記号で表示したりすることもできます。
  • 影の追加
    • テキストに影をつけることもできます。
    • 影の色や不透明度、方向を設定することができます。

これらの機能を活用することで、プログラム内で表示されるテキストの外見や配置を細かく制御することができます。

あすか

text_block classの継承階層

text_block classの継承階層

継承階層(派生クラス)は以下のとおりです。

 継承階層一覧
  • widget
    • クラスを継承しており、UI要素を画面上に描画するための基本的な機能を提供します。
  • text_base
    • クラスを継承しており、テキストウィジェットの基本的な機能を提供します。

text_block classのデータメンバー

text_block classのデータメンバー

続いて、データメンバーについて解説していきます。

以下のとおりです。

 データメンバー一覧
  • DefaultJustification(デフォルト配置)
    • テキストの配置を指定する列挙型(text_justification)のデフォルト値。
  • DefaultOverflowPolicy(デフォルトのオーバーフローポリシー)
    • テキストが許容長を超えた場合の挙動を指定する列挙型(text_overflow_policy)のデフォルト値。
  • DefaultShadowColor(デフォルトの影の色)
    • テキストの影の色のデフォルト値。
  • DefaultShadowOffset(デフォルトの影の方向)
    • テキストの影の方向のデフォルト値。
  • DefaultText(デフォルトのテキスト)
    • 表示するテキストのデフォルト値。
  • DefaultTextColor(デフォルトテキストの色)
    • 表示するテキストの色のデフォルト値。
  • DefaultTextOpacity(デフォルトのテキストの不透明度)
    • 表示するテキストの不透明度のデフォルト値。

①:DefaultJustification(デフォルト配置)

②:DefaultOverflowPolicy(デフォルトのオーバーフローポリシー)

③:DefaultShadowColor(デフォルトの影の色)

④:DefaultShadowOffset(デフォルトの影の方向)

⑤:DefaultText(デフォルトのテキスト)

⑥:DefaultTextColor(デフォルトテキストの色)

⑦:DefaultTextOpacity(デフォルトのテキストの不透明度)

これらのデータメンバーは、プログラミングにおいてテキストの表示に関するデフォルト値を指定するために使用されるものです。

これらのデフォルト値を設定することで、テキストの配置、オーバーフローポリシー、影の色や方向、テキスト自体の内容、色、不透明度などをあらかじめ決めることができます。

text_block classの関数

text_block classの関数

最後に、text_block classの関数について解説していきます。

以下のとおりです。

 関数一覧
  • GetJustification:(配置の取得)
    • ウィジェット内のテキストの配置を取得します。
  • GetOverflowPolicy:(オーバーフローポリシーの取得)
    • テキストが許容長を超えた場合の挙動を取得します。
  • GetParentWidget:(親ウィジェットの取得)
    • ウィジェットの親ウィジェットを取得します。
    • 親が存在しない場合(例: プレイヤーUI内にない場合やルートウィジェット自体である場合)は失敗します。
  • GetRootWidget:(ルートウィジェットの取得)
    • このウィジェットをプレイヤーUIに追加したウィジェットを取得します。
    • ルートウィジェットは自身を返します。
    • プレイヤーUIに存在しない場合は失敗します。
  • GetShadowColor:(影の色の取得)
    • テキストの影の色を取得します。
  • GetShadowOffset:(影の方向の取得)
    • テキストの影の方向を取得します。
  • GetShadowOpacity:(影の不透明度の取得)
    • 影の不透明度を取得します。
  • GetText:(テキストの取得)
    • 現在のウィジェット内のテキストを取得します。
  • GetTextColor:(テキストの色の取得)
    • 表示するテキストの色を取得します。
  • GetTextOpacity:(テキストの不透明度の取得)
    • 表示するテキストの不透明度を取得します。
  • GetVisibility:(表示状態の取得)
    • 現在のウィジェットの表示状態を取得します。
  • IsEnabled:(有効状態の確認)
    • ウィジェットがプレイヤーによって対話的に変更可能かどうかを確認します。
  • SetEnabled:(有効状態の設定)
    • ウィジェットがプレイヤーによって対話的に変更可能かどうかを設定します。
  • SetJustification:(配置の設定)
    • ウィジェット内のテキストの配置を設定します。
  • SetOverflowPolicy:(オーバーフローポリシーの設定)
    • テキストが許容長を超えた場合の挙動を設定します。
  • SetShadowColor:(影の色の設定)
    • テキストの影の色を設定します。
  • SetShadowOffset:(影の方向の設定)
    • テキストの影の方向を設定します。
  • SetShadowOpacity:(影の不透明度を設定)
    • 影の不透明度を設定します。
  • SetText:(表示するテキストを設定)
    • ウィジェットに表示するテキストを設定します。
  • SetTextColor:(テキストの色を設定)
    • 表示するテキストの色を設定します。
  • SetTextOpacity:(テキストの不透明度を設定)
    • 表示するテキストの不透明度を設定します。
  • SetVisibility:(ウィジェットの表示状態を設定)
    • ウィジェットを非表示にしたり表示したりします。

①:GetJustification(配置の取得)

②:GetOverflowPolicy(オーバーフローポリシーの取得)

③:GetParentWidget(親ウィジェットの取得)

④:GetRootWidget(ルートウィジェットの取得)

⑤:GetShadowColor(影の色の取得)

⑥:GetShadowOffset(影の方向の取得)

⑦:GetShadowOpacity(影の不透明度の取得)

⑧:GetText(テキストの取得)

⑨:GetTextColor(テキストの色の取得)

⑩:GetTextOpacity(テキストの不透明度の取得)

⑪:GetVisibility(表示状態の取得)

⑫:IsEnabled(有効状態の確認)

⑬:SetEnabled(有効状態の設定)

⑭:SetJustification(配置の設定)

⑮:SetOverflowPolicy(オーバーフローポリシーの設定)

⑯:SetShadowColor(影の色の設定)

⑰:SetShadowOffset(影の方向を設定)

⑱:SetShadowOpacity(影の不透明度を設定する)

⑲:SetText(表示するテキストを設定する)

⑳:SetTextColor(テキストの色を設定する)

㉑:SetTextOpacity(テキストの不透明度を設定する)

㉒:SetVisibility(ウィジェットの表示状態を設定する)

以上が各関数の説明です。これらの関数を使用することで、ウィジェットのテキストに影を追加したり、テキストの色や不透明度を変更したりすることができます。

よくある質問

以下にtext_block classに関するよくある質問をまとめてみました。

データメンバーとは

データと引数の違いは?

IsEnabled(有効状態の確認)とSetEnabled(有効状態の設定)の違いは?

まとめ

text block classのまとめ

今回は、text_block classについて解説しました。

text_block classに関する一覧を以下に再掲しておきます。

 継承階層一覧
  • widget
    • クラスを継承しており、UI要素を画面上に描画するための基本的な機能を提供します。
  • text_base
    • クラスを継承しており、テキストウィジェットの基本的な機能を提供します。
 データメンバー一覧
  • DefaultJustification(デフォルト配置)
    • テキストの配置を指定する列挙型(text_justification)のデフォルト値。
  • DefaultOverflowPolicy(デフォルトのオーバーフローポリシー)
    • テキストが許容長を超えた場合の挙動を指定する列挙型(text_overflow_policy)のデフォルト値。
  • DefaultShadowColor(デフォルトの影の色)
    • テキストの影の色のデフォルト値。
  • DefaultShadowOffset(デフォルトの影の方向)
    • テキストの影の方向のデフォルト値。
  • DefaultText(デフォルトのテキスト)
    • 表示するテキストのデフォルト値。
  • DefaultTextColor(デフォルトテキストの色)
    • 表示するテキストの色のデフォルト値。
  • DefaultTextOpacity(デフォルトのテキストの不透明度)
    • 表示するテキストの不透明度のデフォルト値。
 関数一覧
  • GetJustification:(配置の取得)
    • ウィジェット内のテキストの配置を取得します。
  • GetOverflowPolicy:(オーバーフローポリシーの取得)
    • テキストが許容長を超えた場合の挙動を取得します。
  • GetParentWidget:(親ウィジェットの取得)
    • ウィジェットの親ウィジェットを取得します。
    • 親が存在しない場合(例: プレイヤーUI内にない場合やルートウィジェット自体である場合)は失敗します。
  • GetRootWidget:(ルートウィジェットの取得)
    • このウィジェットをプレイヤーUIに追加したウィジェットを取得します。
    • ルートウィジェットは自身を返します。
    • プレイヤーUIに存在しない場合は失敗します。
  • GetShadowColor:(影の色の取得)
    • テキストの影の色を取得します。
  • GetShadowOffset:(影の方向の取得)
    • テキストの影の方向を取得します。
  • GetShadowOpacity:(影の不透明度の取得)
    • 影の不透明度を取得します。
  • GetText:(テキストの取得)
    • 現在のウィジェット内のテキストを取得します。
  • GetTextColor:(テキストの色の取得)
    • 表示するテキストの色を取得します。
  • GetTextOpacity:(テキストの不透明度の取得)
    • 表示するテキストの不透明度を取得します。
  • GetVisibility:(表示状態の取得)
    • 現在のウィジェットの表示状態を取得します。
  • IsEnabled:(有効状態の確認)
    • ウィジェットがプレイヤーによって対話的に変更可能かどうかを確認します。
  • SetEnabled:(有効状態の設定)
    • ウィジェットがプレイヤーによって対話的に変更可能かどうかを設定します。
  • SetJustification:(配置の設定)
    • ウィジェット内のテキストの配置を設定します。
  • SetOverflowPolicy:(オーバーフローポリシーの設定)
    • テキストが許容長を超えた場合の挙動を設定します。
  • SetShadowColor:(影の色の設定)
    • テキストの影の色を設定します。
  • SetShadowOffset:(影の方向の設定)
    • テキストの影の方向を設定します。
  • SetShadowOpacity:(影の不透明度を設定)
    • 影の不透明度を設定します。
  • SetText:(表示するテキストを設定)
    • ウィジェットに表示するテキストを設定します。
  • SetTextColor:(テキストの色を設定)
    • 表示するテキストの色を設定します。
  • SetTextOpacity:(テキストの不透明度を設定)
    • 表示するテキストの不透明度を設定します。
  • SetVisibility:(ウィジェットの表示状態を設定)
    • ウィジェットを非表示にしたり表示したりします。

以上です。

本日もお疲れさまでした🍵

  • この記事を書いた人
  • 最新記事

あすか(Asuka)

自己紹介:UEFNクリエイター
Verse言語独学中 | UE・プログラミング・3Dモデリング 6月開始 | 備忘録として学習記録をブログに残しています。
■好きな言葉
徳は弧ならず必ず隣あり.
■ひとこと
まだまだ未熟者ですが、
よろしくお願いします。

-UEFN, Verse言語, メタバース
-, ,