自身のアイテムの子要素のオブジェクトを操作するハンドルです。

Hierarchy

  • SubNode

Properties

name: string

SubNodeのオブジェクトの名前です。 ClusterScript.subNodeで指定するsubNodeNameと同じものです。

Example

let subNode = $.subNode("MySubNode");
$.log(subNode.name); // => MySubNode

Methods

  • SubNodeの現在の有効状態を取得します。

    setEnabledで指定された値ではなく、SubNodeの現在の有効状態が返されることに留意してください。

    値の取得に失敗した場合、undefinedを返します。

    Returns undefined | boolean

  • 現在の位置を取得します。 setPositionで指定された値ではなく、移動中のSubNodeの位置が返されることに留意してください。

    値の取得に失敗した場合、nullを返します。

    Returns

    現在の位置 (グローバル座標)

    Returns null | Vector3

  • 現在の姿勢を取得します。 setRotationで指定された値ではなく、移動中のSubNodeの姿勢が返されることに留意してください。

    値の取得に失敗した場合、nullを返します。

    Returns

    現在の姿勢 (グローバル座標)

    Returns null | Quaternion

  • SubNodeの現在の位置を取得します。 setPositionで指定された値ではなく、移動中のSubNodeの位置が返されることに留意してください。

    値の取得に失敗した場合、undefinedを返します。

    Returns

    現在の位置 (アイテムのローカル座標)

    Returns undefined | Vector3

  • SubNodeの現在の姿勢を取得します。 setRotationで指定された値ではなく、移動中のSubNodeの姿勢が返されることに留意してください。

    値の取得に失敗した場合、undefinedを返します。

    Returns

    現在の姿勢 (アイテムのローカル座標)

    Returns undefined | Quaternion

  • SubNodeが空間上で有効かを取得します。 そのSubNodeと全ての親が有効である時にそのSubNodeは空間上で有効になります。

    setEnabledで指定された値ではなく、SubNodeの現在の有効状態が返されることに留意してください。

    値の取得に失敗した場合、undefinedを返します。

    Returns undefined | boolean

  • このオブジェクトにアタッチされたUnityコンポーネントのハンドルを、型名を指定して取得します。 typeとして指定できるコンポーネント名については UnityComponent の説明を参照してください。

    同じコンポーネントが複数アタッチされている場合、最初に見つかったコンポーネントのハンドルを返します。

    このAPIはCreatorKitからアップロードしたワールドでのみ利用可能です。 クラフトアイテムからはこのAPIは利用できません。

    Returns

    指定したコンポーネントが存在すればそのコンポーネントのハンドル、なければnull

    Parameters

    • type: string

    Returns null | UnityComponent

  • SubNodeの有効状態を変更します。 有効でないSubNodeとその全ての子のSubNodeは空間上で有効でなくなり、描画されず、当たり判定が無いものとして扱われます。

    有効状態はネットワークを介して同期されるため、即座に反映されない場合があることに留意してください。

    Parameters

    • v: boolean

      有効ならtrue

    Returns void

  • SubNodeの移動させたい位置を指定します。 位置はネットワークを介して補間して同期されるため、即座に反映されない場合があることに留意してください。

    Parameters

    • pos: Vector3

      移動先の位置 (アイテムのローカル座標)

    Returns void

  • SubNodeの回転させたい姿勢を指定します。 姿勢はネットワークを介して補間して同期されるため、即座に反映されない場合があることに留意してください。

    Parameters

    • rot: Quaternion

      回転 (アイテムのローカル座標)

    Returns void

  • SubNodeが描画する文字列を指定します。 \nを使用することで改行することが可能です。 文字列のサイズは1kB以下である必要があります。 1kBを超えている場合はClusterScriptError (requestSizeLimitExceeded) が発生し、失敗します。 SubNodeにTextViewがついていない場合、何も起きません。

    TextViewの詳細はドキュメントを参照してください。

    Parameters

    • text: string

    Returns void

  • SubNodeが描画する文字列が改行を含んでいる際の水平方向の配置を指定します。 SubNodeにTextViewがついていない場合、何も起きません。

    TextViewの詳細はドキュメントを参照してください。

    Example

    subNode.setTextAlignment(TextAlignment.Left);
    

    Parameters

    Returns void

  • SubNodeが描画する文字列のアンカーを指定します。 例えば、UpperLeftを指定した場合、文字列の左上の角がSubNodeの位置に一致するようになります。 SubNodeにTextViewがついていない場合、何も起きません。

    TextViewの詳細はドキュメントを参照してください。

    Example

    subNode.setTextAnchor(TextAnchor.UpperLeft);
    

    Parameters

    Returns void

  • SubNodeが描画する文字列の色をRGBA値で指定します。 RGBA値はそれぞれ0以上1以下で、色空間はsRGB(ガンマ)です。範囲外の値を指定した場合は自動的に丸められます。 SubNodeにTextViewがついていない場合、何も起きません。

    TextViewの詳細はドキュメントを参照してください。

    Parameters

    • r: number

      R値

    • g: number

      G値

    • b: number

      B値

    • a: number

      アルファ値(0のとき透明になります)

    Returns void

  • SubNodeが描画する文字列の大きさを指定します。 sizeは0以上5以下の値が指定できます。範囲外の値を指定した場合は自動的に丸められます。 描画される文字列の大きさはsizeとSubNodeのグローバルスケールの両方に比例します。 SubNodeのグローバルスケールが1のとき、sizeに1を指定すると文字の高さ(エックスハイト)はほぼ1mになります。 SubNodeにTextViewがついていない場合、何も起きません。

    TextViewの詳細はドキュメントを参照してください。

    Parameters

    • size: number

    Returns void

Generated using TypeDoc