BillboardGui

非推奨を表示

*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

BillboardGui は、3D 空間にUIオブジェクトが表示されるコンテナですが、常にカメラに向かっています。コンテナの位置は、親 BasePart または Attachment (または Adornee)に対するものです。For BasePartsPosition プロパティが使用され、For AttachmentsWorldPosition プロパティが使用されます。

BillboardGui with a TextLabel describing the screen console it floats above.

ビルボードの Size プロパティは、GuiObject.Size とは少し異なる動作をします。 オフセット コンポーネントは同じですが、 スケール コンポーネントは 3D 空間でスタッドサイズとして使用されます。

サイズスケールの BillboardGui を作成し、TextLabel を含むとき、カメラ距離が変更されるとビルボードキャンバスのテキストがスケールするように、ラベルの TextScaled プロパティを有効にすると便利です。

対話形式の UI 要素 ( や 内の) は、通常、 内に配置することで親になり、 を通じてユーザーの入力を受け取るだけです。Adornee プロパティを使用して、BillboardGui 自体が PlayerGui に残りながら、3D世界のパーツまたは付属物をターゲットにできます。

体験中の UI を参照して、 コンテナーを使用する方法のガイド を見てください。

キャッシュ行動

パフォーマンスを向上させるために、BillboardGui の外観は、次のいずれかが発生するまでキャッシュされ、次のレンダリングフレームで再計算されます。

  • 子孫が BillboardGui に追加されたり削除されたりします。
  • BillboardGui の子孫のプロパティが変更されます。
  • BillboardGui 自体のプロパティが変更されます。

概要

プロパティ

  • 並列読み取り

    子孫が入力イベントを受信するかどうかを制御します。

  • 並列読み取り

    BillboardGui が位置付けられているターゲットパーツまたは添付ファイルを設定します。

  • 並列読み取り

    BillboardGui が常に他の 3D オブジェクトの上にレンダリングされるかどうかを決定します。

  • 並列読み取り

    Determines the factor by which the BillboardGui コンテナのライトがスケールするときに LightInfluence0 になるようにします。

  • 並列読み取り

    キャンバスボーダーの外にある部分が描かれるかどうか。

  • 読み取り専用
    複製されていません
    並列読み取り

    BillboardGui からプレイヤーのカメラまでの現在の距離(スタッド)。

  • 並列読み取り

    BillboardGui が大きさを拡大するのをやめる距離をスタッドで決定します。

  • 並列読み取り

    プレイヤーのカメラが に近づいたり、遠ざかったりすると、スタッドの増加量と減少量を決定します。

  • 並列読み取り

    BillboardGui がサイズが小さくなるスケーリングを停止する距離をスタッドで決定します。

  • 並列読み取り

    モデルの Camera アラインメントボックスの半分の尺寸のユニットで、Adornee オリエンテーションに対して、Camera から BillboardGui がオフセットされる方法を決定します。

  • モデルの軸に沿ったバウンディングボックスの半分の尺寸のグローバル軸に対して、 がオフセットされる方法を決定します。これは、モデルの軸に沿ったバウンディングボックスの尺寸の半分のユニットです。

  • 並列読み取り

    BillboardGui が環境光にどれほど影響を受けるかを制御します。

  • 並列読み取り

    レンダリングを停止する前に、BillboardGui が表示される距離を制御します。

  • 並列読み取り

    スクリプトによって特定のプレイヤーから BillboardGui を非表示にするために使用されます。

  • 並列読み取り

    BillboardGui が画面上に持つサイズを制御します。

  • 並列読み取り

    サイズ関連のユニットの 2Dオフセットで、アンカーポイントとして機能します。

  • 並列読み取り

    がどのようにスタッドでオフセットされ、 オリエンテーションに対してどのように偏りますかを決定します。

  • 並列読み取り

    BillboardGui がグローバルな軸に対してどのようにオフセットされるかを決定します。スタッドでAdornee から。

LayerCollector から継承した プロパティGuiBase2d から継承した プロパティ

イベント

GuiBase2d から継承した イベント

プロパティ

Active

並列読み取り

子孫が入力イベントを受信するかどうかを制御します。If the に含まれる が、そのボタンをクリックできるようにするには、 が両方の と ボタンに設定されている場合、そのボタンがクリック可能になります。

対話形式の UI 要素 ( や 内の) は、通常、 内に配置することで親になり、 を通じてユーザーの入力を受け取るだけです。Adornee プロパティを使用して、BillboardGui 自体が PlayerGui に残りながら、3D世界のパーツまたは付属物をターゲットにできます。

Adornee

並列読み取り

ターゲット BasePart または Attachment を設定し、BillboardGui が親部品または添付ファイルに対して位置付けられるように、親部品または添付ファイルを上書きします。

AlwaysOnTop

並列読み取り

このプロパティは、BillboardGui が常に他の 3D オブジェクトの上にレンダリングされるかどうかを決定します。

デフォルトの false に設定すると、BillboardGui は他の 3D コンテンツと同じようにレンダリングされ、他の 3D オブジェクトによって隠されます。true に設定すると、BillboardGui は常に 3D コンテンツの上にレンダリングされ、外観が大幅に変更されます:

  • 色は、ScreenGui 内でどのように表示されるかと一致します。
  • テキストは、高DPIデバイスでより鋭く表示される可能性があります。
  • LightInfluence は、0 として扱われます。
  • Brightness は効果がありません。

Brightness

並列読み取り

このプロパティは、BillboardGui コンテナのライトが LightInfluence にスケールするときに、0 による要因を決定します。デフォルトでは、このプロパティは 1 であり、0 から 1000 までの任意の数に設定できます。このプロパティを変更することで、BillboardGui の明らかな明るさが環境により良く一致するようになります。たとえば、ビデオビルボードは、Brightness10 に増加することで、暗い部屋内で明るくすることができます。

Note that は Studio でアクセスできませんであり、 または が であるか、 が であるときに効果がありません。

ClipsDescendants

並列読み取り

デフォルトの に設定すると、 キャンバスボーダーの外にある部分が描かれない。

このプロパティが であっても、キャンバスの外側にある はレンダリングされません。

CurrentDistance

読み取り専用
複製されていません
並列読み取り

BillboardGui からプレイヤーのカメラまでの現在の距離(スタッド)。変更されたイベントは、DistanceStep0 よりも大きい場合、このプロパティに対して発射しません。

DistanceLowerLimit

並列読み取り

BillboardGui がプレイヤーの現在のカメラに対して大きさが大幅に増加するのをやめる距離をスタッドで決定し、デフォルトは 0 です。If the of the がこの値より低い場合、この距離でより大きくスケールすることはありません。

DistanceStep

並列読み取り

プレイヤーのカメラが に近づいたり、遠ざかったりすると、スタッドの増加量と減少量を決定します。プロパティはデフォルトで 0 に設定され、DistanceLowerLimit からラウンドアップします。

DistanceUpperLimit

並列読み取り

BillboardGui がプレイヤーの現在のカメラに対してサイズが小さくなるのをやめる距離をスタッドで決定します。If the of the がこの値より上にある場合、この距離でより小さくスケールすることはありません。

このプロパティは、値が 0 より小さい場合は無視されます。デフォルト値は -1 で、プロパティはデフォルトで無視されます。

ExtentsOffset

並列読み取り

このプロパティは、BillboardGui がモデルの Adornee に対してどのようにオフセットされるかを決定し、Camera オリエンテーションに関連して、モデルの Camera 対応バインディングボックスの半分の尺寸でユニットが決定します。

同様の動作をするが、スタッドユニットを使用する StudsOffset 、またはオフセット方向がグローバルな軸に対して相対的である ExtentsOffsetWorldSpace も参照してください。

ExtentsOffsetWorldSpace

並列読み取り

このプロパティは、 がモデルの軸に一致するバウンディングボックスの半分の尺寸でグローバル軸に対してオフセットされる方法を決定します。

参照してください:StudsOffset は同様に機能しますが、スタッドユニットを使用し、または ExtentsOffset は、オフセット方向が Camera に相対することを除いて、同様に機能します。

LightInfluence

並列読み取り

コントロールは、 から までの範囲で、環境光にどれほど影響を受けるかを決定します。これを 1 に設定すると、周囲の照明が外外見に完全に制御を持っていることになり、 0 に設定すると、照明に効果がないことになります。

MaxDistance

並列読み取り

このプロパティは、レンダリングを停止する前にカメラから BillboardGui が表示される距離を制御します。値 0 または inf (デフォルト)は、制限がないことを意味し、無限遠にレンダリングされます。

屋外に表示される場合は、BillboardGuis が十分に高いことを確認するために、MaxDistance が画面に表示されるときにコンテナの UI が十分に小さくなるようにすることをお勧めします。これにより、突然のポップアウト効果が最小限に抑えられます。

PlayerToHideFrom

並列読み取り

スクリプトによって特定のプレイヤーから BillboardGui を非表示にするために使用されます。

1つ以上のプレイヤーからBillboardGuiを非表示にするには、それをStarterGuiに置き、スクリプトを使用してEnabledプロパティを設定し、LocalPlayerがそれを見ることができるかどうかに応じて設定します。Adornee プロパティを使用して、BillboardGui を親に付けるのではなく、BasePart または AttachmentWorkspace を付けることができます。

Size

並列読み取り

BillboardGui が画面上に持つサイズを制御します。GuiObject.Size とは異なり、このプロパティの スケール コンポーネントは、ビルボードのスタッドサイズを 3D 空間に設定します。

SizeOffset

並列読み取り

サイズ関連のユニットの 2Dオフセットで、アンカーポイントとして機能します。これは GuiObject.AnchorPoint プロパティと同様に使用できますが、値が異なります。


<tbody>
<tr>
<td><code>0, 0</code></td>
<td>UI がその中心に固定されるデフォルト。</td>
</tr>
<tr>
<td><code>0.5, 0.5</code></td>
<td>UI は左下に固定されます。</td>
</tr>
<tr>
<td><code>0.5, -0.5</code></td>
<td>UI は左上に固定されます。</td>
</tr>
<tr>
<td><code>-0.5, 0.5</code></td>
<td>UI は右上に固定されます。</td>
</tr>
<tr>
<td><code>-0.5, -0.5</code></td>
<td>UI は右下に固定されます。</td>
</tr>
</tbody>
サイズオフセット説明

また、StudsOffsetStudsOffsetWorldSpaceExtentsOffset 、およびExtentsOffsetWorldSpace は、3D 空間ではなく、オフセットプロパティで動作するものです。

StudsOffset

並列読み取り

このプロパティは、 がどのようにスタッドでオフセットされ、 オリエンテーションに対してどのようにオフセットされるかを決定します。

また、オフセット方向がグローバルな軸に対して相対的であるのを除いて、同様の動作をする StudsOffsetWorldSpace も参照してください。

StudsOffsetWorldSpace

並列読み取り

このプロパティは、BillboardGui がグローバルな軸に対してどのようにオフセットされるかを決定します。スタッドで、Adornee に対して。

また、オフセット方向が Camera に相対するのを除いて、同様の動作をする StudsOffset も参照してください。

方法

イベント