UI
クラスリファレンス
Canvas
CanvasScaler
CanvasRenderer
CanvasGroup
RectTransform
RectTransformUtility
EventSystem
StandaloneInputModule
TouchInputModule
GraphicRaycaster
PhysicsRaycaster
Physics2DRaycaster
Image
RawImage
Text
Selectable
Button
Toggle
ToggleGroup
Slider
Scrollbar
ScrollRect
InputField
Canvas
名前空間: UnityEngine
継承: Behaviour
参照: 2-1-2∼2-1-4、6-7-1∼6-7-3
public
プロパティ
プロパティ名 機能 対応するInspectorの項目int cachedSortingLayerValue sortingLayerIDプロパティに基づいて計算されキャッシュされた描画順序の値を返します（読み取り専用）。 -bool isRootCanvas ルートのカンバスかどうかを返します（読み取り専用）。 -bool overridePixelPerfect trueにすると、ネストしたカンバスの親のpixelPerfectプロパティの設定を無視します。
-bool overrideSorting trueにすると、ネストしたカンバスの親の描画順序設定を無視し
ます。 -bool pixelPerfect trueにすると、カンバス内のUI要素がピクセルに合うように描画 されます。renderModeプロパティがScreenSpaceOverlayか ScreenSpaceCameraのときのみ有効です。 Pixel Perfect Rect pixelRect カ ン バ ス の 描 画 領 域 の 矩 形 を 返 し ま す（ 読 み 取 り 専 用 ）。 renderModeプロパティがScreenSpaceOverlayのときは、画面 全体の矩形になります。WorldSpaceのときは、カメラのビュー ポートの矩形になります。
-float planeDistance カンバスのカメラからの距離を設定します。 Plane Distance float referencePixelsPerUnit デフォルトの1単位あたりのピクセル数を設定します。
-RenderMode renderMode カンバスの描画モードを設定します。 Render Mode int renderOrder カンバスが描画される順番を返します（読み取り専用）。
-float scaleFactor カンバス上のすべてのUI要素をスケールする倍率を設定します。CanvasScaler.scaleFactorによって設定されます。
-int sortingLayerID カンバスのソーティングレイヤーをIDで設定します。 Sorting Layer string sortingLayerName カンバスのソーティングレイヤーを名前で設定します。 Sorting Layer
int sortingOrder ソーティングレイヤー内での描画順序を設定します。 Sort Order、Order in Layer Camera worldCamera カンバスを描画するカメラを設定します。 Render Camera、Event Camera
static
メソッド
public static void ForceUpdateCanvases()
すべてのカンバスの内容を強制的に更新します。
通常、カンバスはフレームの終わりとレンダリングの直前に、レイアウトや要素の生成に関する計算をおこないます。
フレーム間に起こったすべての変更を確実に反映させるためです。フレーム間で更新されるレイアウトや要素に依存
するコードの前に、このメソッドを呼ぶことで確実に変更を反映させることが可能です。
public static Material GetDefaultCanvasMaterial()
カンバス上のテキスト以外の要素を描画するのに使用されるデフォルトのマテリアルを返します。
public static Material GetDefaultCanvasTextMaterial()
CanvasScaler
名前空間: UnityEngine.UI
継承: EventSystems.UIBehaviour
参照: 2-1-5
public
プロパティ
プロパティ名 機能 対応するInspectorの項目float defaultSpriteDPI Pixels Per UnitがreferencePixelsPerUnitプロパティの値と同じスプライトに対する、1インチあたりのピクセル数を設定します。 Default Sprite DPI float dynamicPixelsPerUnit 動的に生成されるグラフィックの1単位あたりのピクセル数を設定します。 Dynamic Pixels Per Unit
float fallbackScreenDPI DPIが不明な場合に使用されるDPIの値を設定します。 Fallback Screen DPI float matchWidthOrHeight screenMatchModeプロパティがMatchWidthOrHeightのとき、参
照解像度の幅と高さのどちらに合わせるかを設定します。 Match
CanvasScaler.Unit
physicalUnit UI要素の位置やサイズを設定する物理単位を設定します。 Physical Unit
float referencePixelsPerUnit カンバス上での基準となる1単位あたりのピクセル数を設定します。 Reference Pixels Per Unit Vector2 referenceResolution 作成するUIの基準となる参照解像度を設定します。 Reference Resolution
float scaleFactor カンバス上のすべてのUI要素をスケールする倍率を設定します。 Scale Factor CanvasScaler.
ScreenMatchMode screenMatchMode
画面解像度と参照解像度のアスペクト比が異なるとき、カンバスを
どのようにスケールするかを設定します。 Screen Match Mode
CanvasScaler.ScaleMode
uiScaleMode カンバス内のUI要素がどのようにスケールされるかを設定します。 Ui Scale Mode
protected
メソッド
protected virtual void Handle()
カンバスのスケールに関する計算をおこないます。カンバスのrenderModeプロパティやuiScaleModeプロパティ
の値に応じて、ほかのHandle∼()メソッドを呼びます。
protected virtual void HandleConstantPhysicalSize()
uiScaleModeプロパティがConstantPhysicalSizeのとき、カンバスのスケールに関する計算をおこないます。
protected virtual void HandleConstantPixelSize()
uiScaleModeプロパティがConstantPixelSizeのとき、カンバスのスケールに関する計算をおこないます。
protected virtual void HandleScaleWithScreenSize()
uiScaleModeプロパティがScaleWithScreenSizeのとき、カンバスのスケールに関する計算をおこないます。
protected virtual void HandleWorldCanvas()
カンバスのrenderModeプロパティがWorldSpaceのとき、カンバスのスケールに関する計算をおこないます。
protected void SetReferencePixelsPerUnit(float referencePixelsPerUnit)
protected void SetScaleFactor(float scaleFactor)
スケールする倍率を設定します。カンバスのscaleFactorプロパティにも影響します。
CanvasRenderer
名前空間: UnityEngine
継承: Component
参照: 2-1-7、4-2-1、4-2-5
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 int absoluteDepth ルートのカンバスからの深さを返します（読み取り専用）。 -bool isMask このレンダラーにMaskコンポーネントがアタッチされている場合、trueを返します。 -int relativeDepth 親のカンバスからの相対的な深さを返します（読み取り専用）。-public
メソッド
public void Clear()
頂点のキャッシュをすべて削除します。
public float GetAlpha()
レンダラーの現在のアルファを取得します。
public Color GetColor()
レンダラーの現在の色を取得します。
public Material GetMaterial()
レンダラーに割り当てられた現在のマテリアルを返します。
public void SetAlpha(float alpha)
レンダラーのアルファを設定します。このアルファは頂点のアルファ、カンバスのアルファと乗算されます。
public void SetColor(Color color)
レンダラーの色を設定します。この色は頂点の色、カンバスの色と乗算されます。
public void SetMaterial(Material material, Texture texture)
レンダラーのマテリアルを設定します。テクスチャが指定されている場合、マテリアルのMainTexに設定されている
テクスチャの代わりに使用されます。
public void SetVertices(UIVertex[] vertices, int size)
public void SetVertices(List<UIVertex> vertices)
レンダラーによって描画される頂点を設定します。
CanvasGroup
名前空間: UnityEngine
継承: Component, ICanvasRaycastFilter
参照: 2-1-8、6-2-1∼6-2-3
public
プロパティ
プロパティ名 機能 対応するInspectorの項目float alpha カンバスグループのアルファを設定します。 Alpha bool blocksRaycasts カンバスグループに含まれるUI要素がレイキャストをブロックするかどうか（衝突判定を許可するかどうか）を設定します。 Blocks Raycasts bool ignoreParentGroups 親のカンバスグループで設定されているプロパティを無視するかどうかを設定します。 Ignore Parent Groups
bool interactable します。カンバスグループに含まれるUI要素が操作可能かどうかを設定 Interactable
RectTransform
名前空間: UnityEngine
継承: Transform
参照: 2-2-1∼2-2-4、6-3-3、6-5-4、6-6-3∼6-6-4
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 Vector2 anchoredPosition UI要素の位置を設定します。アンカーからの相対座標でピボットの位置 の座標を示しています。アンカーが開いているときは、各アンカーハン ドル間の中間点からの相対座標になります。 Pos X、Pos Y Vector3 anchoredPosition3D UI要素の3D空間での位置を設定します。アンカーからの相対座標でピ ボットの位置の座標を示しています。アンカーが開いているときは、各 アンカーハンドル間の中間点からの相対座標です。Pos X、Pos Y、Pos Z Vector2 anchorMax 右上のアンカーハンドルの位置を設定します。 Anchors Max Vector2 anchorMin 左下のアンカーハンドルの位置を設定します。 Anchors Min
Vector2 offsetMax 親のRect Transformの右上からUI要素の右上へのオフセットを設定し
ます。アンカーが開いているときに設定可能です。 Right、Top
Vector2 offsetMin 親のRect Transformの左下からUI要素の左下へのオフセットを設定します。アンカーが開いているときに設定可能です。 Left、Bottom Vector2 pivot ピボットの位置を設定します。 Pivot
Rect rect ローカル座標系での矩形を示すRect構造体を返します（読み取り専用）。
public
メソッド
public void GetLocalCorners(Vector3[] fourCornersArray)
ローカル座標系におけるRect Transformの4隅の座標を取得します。
public void GetWorldCorners(Vector3[] fourCornersArray)
ワールド座標系におけるRect Transformの4隅の座標を取得します。
public void SetInsetAndSizeFromParentEdge(RectTransform.Edge edge, float inset, float size)
edgeで指定した辺の親要素からの距離（inset）、および、その方向のサイズ（size）を設定します。このメソッドは
anchorMin、anchorMax、anchoredPosition、sizeDeltaの各プロパティの値を変更します。
public void SetSizeWithCurrentAnchors(RectTransform.Axis axis, float size)
axisで指定した軸の方向のサイズを設定します。
RectTransformUtility
名前空間: UnityEngine
参照: 6-4-3
static
メソッド
public static Bounds CalculateRelativeRectTransformBounds(Transform trans)
指定した要素以下のすべてのRect Transformを含む領域を示すBounds構造体を返します。返されるBounds構造
体の座標は、指定した要素におけるローカル座標系です。
public static Bounds CalculateRelativeRectTransformBounds(Transform root, Transform child)
childで指定した要素以下のすべてのRect Transformを含む領域を示すBounds構造体を返します。返される
Bounds構造体の座標は、rootで指定した要素におけるローカル座標系です。
public static void FlipLayoutAxes(RectTransform rect, bool keepPositioning, bool recursive)
Rect Transformの横方向と縦方向のサイズ、アラインメント（アンカーやピボット）を反転します。表示されている画
像や文字列の向きには影響しません。keepPositioningにtrueを指定するとRect Transformのピボットを中心に、
falseを指定すると親要素の領域を基準に反転します。recursiveにtrueを指定すると子要素も同様に反転します。
public static void FlipLayoutOnAxis(RectTransform rect, int axis, bool keepPositioning, bool recursive)
Rect Transformのアラインメント（アンカー、ピボット）を指定した軸（axis）について反転します。表示されている画
像や文字列の向きには影響しません。keepPositioningにtrueを指定するとRect Transformのピボットを中心に、
falseを指定すると親要素の領域を基準に反転します。recursiveにtrueを指定すると子要素も同様に反転します。
public static Vector2 PixelAdjustPoint(Vector2 point, Transform elementTransform, Canvas canvas)
public static Rect PixelAdjustRect(RectTransform rectTransform, Canvas canvas)
ピクセル精度の座標系でRect Transformの矩形を示すRect構造体を返します。
public static bool RectangleContainsScreenPoint(RectTransform rect, Vector2 screenPoint, Camera cam)
Rect Transformの領域に、指定したカメラにおけるスクリーン座標の点が含まれるかどうかを返します。
public static bool ScreenPointToLocalPointInRectangle(RectTransform rect, Vector2 screenPoint, Camera
cam, out Vector2 localPoint)
指定したカメラにおけるスクリーン座標をRect Transformにおけるローカル座標に変換します。指定したスクリーン
座標をRect Transformの平面に投影できなかった場合、戻り値はfalseになります。描画モードが「Screen Space
- Overlay」のカンバス上にあるRect Transformを指定する場合は、camにはnullを指定します。
public static Ray ScreenPointToRay(Camera cam, Vector2 screenPos)
指定したカメラから指定したスクリーン座標を通るレイを返します。
public static bool ScreenPointToWorldPointInRectangle(RectTransform rect, Vector2 screenPoint,
Camera cam, out Vector3 worldPoint)
指定したカメラにおけるスクリーン座標をRect Transformにおけるワールド座標に変換します。指定したスクリーン
座標をRect Transformの平面に投影できなかった場合、戻り値はfalseになります。描画モードが「Screen Space
- Overlay」のカンバス上にあるRect Transformを指定する場合は、camにはnullを指定します。
public static Vector2 WorldToScreenPoint(Camera cam, Vector3 worldPoint)
ワールド座標を指定したカメラにおけるスクリーン座標に変換します。
EventSystem
名前空間: UnityEngine.EventSystems
継承: UIBehaviour
参照: 2-3-1∼2-3-3
static
プロパティ
プロパティ名 機能 対応するInspectorの項目 EventSystem current 現在のイベントシステムを返します。-public
プロパティ
プロパティ名 機能 対応するInspectorの項目bool alreadySelecting ゲームオブジェクトが選択状態になっている場合にtrueを返します
（読み取り専用）。
-BaseInputModule
-プロパティ名 機能 対応するInspectorの項目
GameObject
currentSelectedGameObject 現在選択されているゲームオブジェクトを返します（読み取り専用）。 -GameObject
firstSelectedGameObject 開始時に選択状態にするゲームオブジェクトを設定します。 First Selected int pixelDragThreshold ドラッグを開始したとみなす移動距離をピクセル単位で設定します。 Drag Threshold bool sendNavigationEvents trueにすると、キーボードやゲームコントローラーを操作したときに
発生するナビゲーションイベントを送信します。 Send Navigation Events
public
メソッド
public bool IsPointerOverGameObject()
public bool IsPointerOverGameObject(int pointerId)
マウスカーソルやタッチポイントがイベントシステムに対応したゲームオブジェクトの上にあるかどうかを返します。
public void RaycastAll(PointerEventData eventData, List<RaycastResult> raycastResults)
すべてのレイキャスターを使って、シーンに対してレイキャストをおこないます。
public void SetSelectedGameObject(GameObject selected)
public void SetSelectedGameObject(GameObject selected, BaseEventData pointer)
ゲームオブジェクトを選択状態にします。前に選択されていたオブジェクトにはOnDeselectイベントが、新しく選
択されたオブジェクトにはOnSelectイベントが送信されます。
public void UpdateModules()
内部のインプットモジュールのリストを更新します。
StandaloneInputModule
名前空間: UnityEngine.EventSystems
継承: PointerInputModule
参照: 2-3-4
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 bool allowActivationOnMobileDevice trueにすると、モバイルデバイスでもアクティブにすることができます。 Allow Activation On Mobile Device string cancelButton キャンセルボタンに対応するインプットマネージャーの設定を指定します。 Cancel Button string horizontalAxis 横方向の軸のボタンに対応するインプットマネージャーの設定を指定します。 Horizontal Axis float inputActionsPerSecond キーボードやゲームコントローラーの入力を1秒間に何回受け付けるかを設定します。
Input Actions Per Second float repeatDelay 連続入力を受け付け始めるまでの遅延を設定します。 Repeat Delay string submitButton 決定ボタンに対応するインプットマネージャーの設定を指定します。 Submit Button
public
メソッド
public override void ActivateModule()
インプットモジュールがアクティブになったときに呼び出されます。
public override void DeactivateModule()
インプットモジュールが非アクティブになったときに呼び出されます。
public override bool IsModuleSupported()
インプットモジュールがサポートされているかどうかを返します。
public override void Process()
現在のフレームでのインプットモジュールの処理をおこないます。イベントシステムのUpdateメソッドから
UpdateModuleメソッドが呼ばれた後に呼び出されます。
public override bool ShouldActivateModule()
インプットモジュールをアクティブにすべきかどうかを返します。
public override void UpdateModule()
インプットモジュールの内部のステートを更新します。イベントシステムのUpdateメソッドが呼ばれるたびに呼び出
されます。
TouchInputModule
名前空間: UnityEngine.EventSystems
継承: PointerInputModule
参照: 2-3-4
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 bool allowActivationOnStandalone trueにすると、スタンドアローン環境でもアクティブにすることができます。 Allow Activation On Standalone
public
メソッド
GraphicRaycaster
名前空間: UnityEngine.UI
継承: BaseRaycaster
参照: 2-1-6
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 GraphicRaycaster. BlockingObjects blockingObjects レイキャストをブロックするオブジェクトのタイプを設定します。 Blocking Objects Camera eventCamera レイを発生するカメラを設定します。-bool ignoreReversedGraphics trueにすると、反転して裏面が表示されている要素は無視されます。 Ignore Reversed Graphics int renderOrderPriority 描画の順序に基づくレイキャスターの優先度を返します（読み取り
専用）。
-int sortOrderPriority ソートの順序に基づくレイキャスターの優先度を返します（読み取
り専用）。
-public
メソッド
public void Raycast(PointerEventData eventData, List<RaycastResult> resultAppendList)
シーンに対してレイキャストをおこないます。
PhysicsRaycaster
名前空間: UnityEngine.EventSystems
継承: BaseRaycaster
参照: 2-3-5
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 int depth このレイキャスターで使用するカメラの深度を返します（読み取り 専用）。 -Camera event-Camera このレイキャスターで使用するカメラを返します（読み取り専用）。 -LayerMask eventMask レイキャストの許可するレイヤーマスクを設定します。int finalEventMask eventMaskプロパティとカメラのマスクの論理積（AND）による
最終的なマスクを返します（読み取り専用）。
-int sortOrderPriority ソートの順序に基づくレイキャスターの優先度を返します（読み取り専用）。
-public
メソッド
public override void Raycast(PointerEventData eventData, List<RaycastResult> resultAppendList)
Physics2DRaycaster
名前空間: UnityEngine.EventSystems
継承: PhysicsRaycaster
参照: 2-3-5
Physics2DRaycasterクラスはPhysicsRaycasterクラスを継承しているため、PhysicsRaycasterクラスと同様のプ
ロパティ、メソッドが定義されています。
Image
名前空間: UnityEngine.UI
継承: MaskableGraphic, ICanvasRaycastFilter, ISerializationCallbackReceiver, ILayoutElement
参照: 3-1-1∼3-1-5、6-4-3∼6-4-4、6-5-5
public
プロパティ
プロパティ名 機能 対応するInspectorの項目
float eventAlphaThreshold イベントを通過させる最小のアルファ（ピクセルのアルファ）を設
定します。デフォルトの値は1.0です。
-float fillAmount 塗りつぶしの量を設定します。typeプロパティがFilledのときの
み有効です。 Fill Amount bool fillCenter trueにすると、スライスが設定されているスプライトのとき、ス ライスの中央部分も描画します。typeプロパティがSlicedか Filledのときのみ有効です。 Fill Center bool fillClockwise 塗りつぶしの方向を設定します。typeプロパティがFilledかつ fillMethodプロパティがRadial90、Radial180、Radial360のい ずれかのときのみ有効です。 Clockwise
Image.FillMethod fillMethod 塗りつぶしの方法を設定します。typeプロパティがFilledのとき
のみ有効です。 Fill Method int fillOrigin 塗りつぶしの基準点を設定します。typeプロパティがFilledのと き の み 有 効 で す。fillMethodに よ っ て 値 の 範 囲 は、Image. OriginHorizontal、Image.OriginVertical、Image.Origin90、 Image.Origin180、Image.Origin360のいずれかのenum値の範 囲になります。 Fill Origin bool hasBorder スプライトにスライスが設定されているかどうかを返します（読み取り専用）。 -Texture main-Texture スプライトのテクスチャを返します（読み取り専用）。 -Sprite override-Sprite 表示をオーバーライドするスプライトを設定します。nullを設定するとspriteプロパティで設定しているスプライトを表示します。 -float pixelsPerUnit 1単位あたりのピクセル数を返します（読み取り専用）。
-bool preserveAspect trueにすると、スプライトの縦横比を保って表示します。 Preserve Aspect Ratio Sprite sprite 表示するスプライトを設定します。 Source Image Image.Type type イメージの種類を設定します。 Image Type
public
メソッド
public override void SetNativeSize()
イメージをスプライトのサイズ（ピクセル等倍）にリサイズします。
RawImage
名前空間: UnityEngine.UI
継承: MaskableGraphic
参照: 3-4-1∼3-4-2、Chapter 6コラム（P.316）
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 Texture mainTexture 表示しているテクスチャを返します（読み取り専用）。 -Texture texture 表示するテクスチャを設定します。 TextureRect uvRect ローイメージの領域内での、テクスチャのオフセットとサイズを
設定します。 UV Rect
public
メソッド
public override void SetNativeSize()
ローイメージをテクスチャのサイズ（ピクセル等倍）にリサイズします。
Text
名前空間
: UnityEngine.UI
継承
: MaskableGraphic, ILayoutElement
参照: 3-5-1∼3-5-3、6-6-4∼6-6-5、6-7-3
public
プロパティ
プロパティ名 機能 対応するInspectorの項目TextAnchor alignment 文字列の配置を設定します。 Alignment TextGenerator cachedTextGenerator テキストを生成するときに使われるTextGeneratorを返します （読み取り専用）。 -TextGenerator cachedTextGeneratorForLayout レイアウトを決定するときに使われるTextGeneratorを返します （読み取り専用）。 -Material default-Material テキストの描画にデフォルトで使用される静的なマテリアルを返 します（読み取り専用）。
-Font font フォントを設定します。 Font int fontSize フォントサイズをピクセル単位で設定します。 Font Size FontStyle fontStyle フォントのスタイルを設定します。 Font Style HorizontalWrapMode
horizontalOverflow
文字列がテキストの幅に収まらないときの折り返し方法を設定し
ます。 Horizontal Overflow
プロパティ名 機能 対応するInspectorの項目
Texture mainTexture フォントのテクスチャを返します（読み取り専用）。 -float pixelsPerUnit 1単位あたりのピクセル数を返します（読み取り専用）。 -bool resizeTextForBestFit trueにすると、文字列がテキストの領域に収まるように、自動的
にフォントサイズを変更して表示します。 Best Fit
int resizeTextMaxSize resizeTextForBestFitプロパティが trueのときの最大のフォント
サイズを設定します。 Max Size
int resizeTextMinSize resizeTextForBestFitプロパティが trueのときの最小のフォント
サイズを設定します。 Min Size
bool supportRichText trueにすると、textプロパティの内容をリッチテキストとして扱います。 Rich Text string text 表示する文字列を設定します。 Text VerticalWrapMode
verticalOverflow
文字列がテキストの高さに収まらないときの表示方法を設定しま
す。 Vertical Overflow
static
メソッド
public static Vector2 GetTextAnchorPivot(TextAnchor anchor)
TextAnchor（alignmentプロパティ）に対応するピボットの座標を返します。
public
メソッド
public TextGenerationSettings GetGenerationSettings(Vector2 extents)
テキストをプロパティをTextGenerationSettings構造体で返します。
Selectable
名前空間: UnityEngine.UI
継承: UIBehaviour, IEventSystemHandler, IPointerEnterHandler, IPointerExitHandler, IPointerDownHandler,
IPointerUpHandler, ISelectHandler, IDeselectHandler, IMoveHandler
参照: 4-9-1∼4-9-3
public
プロパティ
プロパティ名 機能 対応するInspectorの項目 AnimationTriggers animationTriggers 状態によって再生するアニメーションのトリガーを設定します。 transitionプロパティが Animationのときのみ有効です。 Normal Trigger、Highlighted Trigger、Pressed Trigger、 Disabled Trigger Animator animator アタッチされているAnimatorコンポーネントを返します（読み取り専用）。-ColorBlock colors 状 態によってグラフィック 要 素 に 適 用する色を設 定します。transitionプロパティがColorTintのときのみ有効です。
Normal Color、Highlighted Color、Pressed Color、 Disabled Color Image image transitionプロパティがColorTintまたはSpriteSwapのいずれかの とき、色またはスプライトを変更するイメージを設定します。内部 ではtargetGraphicプロパティを設定しています。 Target Graphic bool interactable UI要素が操作可能かどうかを設定します。 Interactable Navigation navigation UI要素のNavigationを設定します。 Navigation
プロパティ名 機能 対応するInspectorの項目
Graphic targetGraphic transitionプロパティがColorTintまたはSpriteSwapのいずれかの
とき、色またはスプライトを変更するグラフィック要素を設定します。 Target Graphic Selectable.Transition
transition UI要素のTransitionを設定します。 Transition
public
メソッド
public Selectable FindSelectable(Vector3 dir)
dirで指定した方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnDown()
下方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnLeft()
左方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnRight()
右方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnUp()
上方向の次の選択可能なオブジェクトを探します。
public virtual bool IsInteractable()
UI要素が操作可能かどうかを返します。
public virtual void Select()
このオブジェクトを選択状態にします。
Button
名前空間: UnityEngine.UI
継承: Selectable, IEventSystemHandler, IPointerClickHandler, ISubmitHandler
参照: 4-2-1、4-2-4、4-3-1∼4-3-2、6-6-4∼6-6-5、6-7-2∼6-7-3
public
プロパティ
プロパティ名 機能 対応するInspectorの項目
Button.ButtonClickedEvent
-Toggle
名前空間: UnityEngine.UI
継承: Selectable, IEventSystemHandler, IPointerClickHandler, ISubmitHandler, ICanvasElement
参照: 4-4-1∼4-4-4、6-1-1∼6-1-5、6-3-4
public
フィールド
プロパティ名 機能 対応するInspectorの項目
Graphic graphic チェックマークとして表示するグラフィック要素を設定します。 Graphic Toggle.ToggleEvent
onValueChanged トグルを押して放したときに発生するイベントを設定します。 -Toggle.ToggleTransition
toggleTransition チェックマークの表示が切り替わるときの効果を設定します。 Toggle Transition
public
プロパティ
プロパティ名 機能 対応するInspectorの項目
ToggleGroup group トグルが所属するToggleGroupを設定します。 Group bool isOn トグルのオン／オフ状態を設定・取得します。 Is On
ToggleGroup
名前空間: UnityEngine.UI
継承: UIBehaviour
参照: 4-4-4、6-1-1∼6-1-5、6-3-4
public
プロパティ
プロパティ名 機能 対応するInspectorの項目bool allowSwitchOff trueにすると、グループ内のすべてのトグルをオフにすることが
可能になります。 Allow Switch Off
Slider
名前空間: UnityEngine.UI
継承: Selectable, IEventSystemHandler, IInitializePotentialDragHandler, IDragHandler, ICanvasElement
参照: 4-5-1∼4-5-3
public
プロパティ
プロパティ名 機能 対応するInspectorの項目
Slider.Direction direction スライダーの向きを設定します。 Direction RectTransform fillRect スライド操作によってハンドルと最小値側の端との間で伸び縮み
するオブジェクトのRect Transformを設定します。 Fill Rect RectTransform handleRect ハンドルとなるオブジェクトのRect Transformを設定します。 Handle Rect
プロパティ名 機能 対応するInspectorの項目
float maxValue スライダーの最大値を設定します。 Max Value float minValue スライダーの最小値を設定します。 Min Value float normalizedValue スライダーの値を正規化された値（0.0∼1.0）で設定します。 -Slider.SliderEvent onValueChanged スライダーの値が変化したときに発生するイベントを設定します。
-float value スライダーの値を設定・取得します。 Value bool wholeNumbers trueにすると、スライダーの値を整数に制限します。 Whole Numbers
public
メソッド
public void SetDirection(Slider.Direction direction, bool includeRectLayouts)
スライダーの向きを変更します。includeRectLayoutsにtrueを指定すると、スライダーのレイアウトも変更します。
Scrollbar
名前空間: UnityEngine.UI
継承: Selectable, IEventSystemHandler, IBeginDragHandler, IInitializePotentialDragHandler,
IDragHandler, ICanvasElement
参照: 4-6-1∼4-6-3、4-7-2
public
プロパティ
プロパティ名 機能 対応するInspectorの項目
Scrollbar.Direction direction スクロールバーの向きを設定します。 Direction RectTransform handleRect ハンドルとなるオブジェクトのRect Transformを設定します。 Handle Rect
int numberOfSteps ハンドルを操作したとき何段階にスナップするかを設定します。 Number Of Steps Scrollbar.ScrollEvent
onValueChanged
スクロールバーの値が変化したときに発生するイベントを設定し
ます。
-float size ハンドルのサイズを設定します。値の範囲は0.0∼1.0です。 Size float value スクロールバーの値を設定します。値の範囲は0.0∼1.0です。 Value
public
メソッド
public void SetDirection(Scrollbar.Direction direction, bool includeRectLayouts)
スクロールバーの向きを変更します。includeRectLayoutsにtrueを指定すると、スライダーのレイアウトも変更します。
ScrollRect
名前空間: UnityEngine.UI
継承: UIBehaviour, IEventSystemHandler, IBeginDragHandler, IInitializePotentialDragHandler,
IDragHandler, IEndDragHandler, IScrollHandler, ICanvasElement
public
プロパティ
プロパティ名 機能 対応するInspectorの項目
RectTransform content スクロールさせる内容のRect Transformを設定します。 Content float decelerationRate inertiaプロパティが trueのとき、慣性による動きの減速度を設定します。 Deceleration Rate
float elasticity したときに元に戻る弾力の強さを設定します。movementTypeプロパティがElasticのとき、端までスクロール Elasticity bool horizontal 横方向のスクロールを有効にします。 Horizontal
float
horizontalNormalizedPosition
横方向のスクロール位置を正規化された値（0.0∼1.0）で設定・
取得します。
-Scrollbar horizontal-Scrollbar 横方向のスクロールバーを設定します。 Horizontal Scrollbar bool inertia trueにすると、スクロールに慣性が働きます。 Inertia
ScrollRect.MovementType
movementType 端までスクロールしたときの挙動を設定します。 Movement Type Vector2 normalizedPosition スクロール位置を(0.0, 0.0)∼(1.0, 1.0)に正規化された座標で設 定・取得します。 -ScrollRect.ScrollRectEvent onValueChanged スクロールしたときに発生するイベントを設定します。 -float scrollSensitivity マウスのスクロールホイールやトラックパッドの操作でスクロー ルさせたときの感度を設定します。 Scroll Sensitivity Vector2 velocity 現在のスクロール速度を設定・取得します。 -bool vertical 縦方向のスクロールを有効にします。 Vertical
float verticalNormalizedPosition
縦方向のスクロール位置を正規化された値（0.0∼1.0）で設定・
取得します。
-Scrollbar vertical-Scrollbar 縦方向のスクロールバーを設定します。 Vertical Scrollbar
public
メソッド
public virtual void StopMovement()
ScrollRectの現在の動きを止めます。
InputField
名前空間: UnityEngine.UI
継承: Selectable, IEventSystemHandler, IPointerClickHandler, IBeginDragHandler, IDragHandler,
IEndDragHandler, IUpdateSelectedHandler, ISubmitHandler, ICanvasElement
参照: 4-8-1∼4-8-3
public
プロパティ
プロパティ名 機能 対応するInspectorの項目
char asteriskChar inputTypeプロパティがPasswordのときに入力された文字の代わりに表示される文字を設定します。
-float caretBlinkRate 入力中に表示されるキャレットの点滅速度を設定します。 Caret Blink Rate int caretPosition 現在のキャレットの位置を設定・取得します。
-int characterLimit 入力可能な最大の文字数を設定します。 Character Limit InputField.
CharacterValidation characterValidation
プロパティ名 機能 対応するInspectorの項目
InputField.ContentType
contentType インプットフィールドのタイプを設定します。 Content Type InputField.InputType
inputType 入力タイプを設定します。 Input Type bool isFocused （読み取り専用）。インプットフィールドがフォーカスされているかどうかを返します -TouchScreenKeyboardType
keyboardType モバイルデバイスで表示されるキーボードのタイプを設定します。 Keyboard Type InputField.LineType lineType 行タイプを設定します。 Line Type
bool multiLine インプットフィールドが複数行の入力に対応しているかどうかを返 します（読み取り専用）。lineTypeプロパティがMultiLineSubmitか MultiLineNewlineのとき、trueを返します。 -InputField.SubmitEvent onEndEdit 入力が終了したときに発生するイベントを設定します。 -InputField.OnValidateInput onValidateInput 文字が入力されたときに呼ばれるバリデーションメソッドを設定し ます。 -InputField.OnChangeEvent onValueChange 入力中の文字列が変更されたときに発生するイベントを設定します。 -Graphic placeholder インプットフィールドに何も入力されていないときに表示されるグラフィック要素を設定します。 Placeholder int selectionAnchorPosition 選択されている文字列の先頭の位置を設定・取得します。
-Color selection-Color 選択されている文字列の背景色を設定します。 Selection Color int selectionFocusPosition 選択されている文字列の末尾の位置を設定・取得します。
-bool shouldHideMobileInput trueにすると、モバイルデバイスでの入力時に表示される補助用の入力フィールドが表示されません。 Hide Mobile Input string text デフォルトの文字列を設定、または入力された文字列を取得します。 Text
Text textComponent 入力された文字列が表示されるテキストを設定します。 Text Component bool wasCanceled 入力がキャンセルされたかどうかを返します（読み取り専用）。
