Cluster Creator Kit Script Reference
    Preparing search index...

    Interface SubNodeItem

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

    interface SubNode {
        name: string;
        getEnabled(): boolean | undefined;
        getGlobalPosition(): Vector3 | null;
        getGlobalRotation(): Quaternion | null;
        getPosition(): Vector3 | undefined;
        getRotation(): Quaternion | undefined;
        getTotalEnabled(): boolean | undefined;
        getUnityComponent(type: string): UnityComponent | null;
        setEnabled(v: boolean): void;
        setPosition(pos: Vector3): void;
        setRotation(rot: Quaternion): void;
        setText(text: string): void;
        setTextAlignment(alignment: TextAlignment): void;
        setTextAnchor(anchor: TextAnchor): void;
        setTextColor(r: number, g: number, b: number, a: number): void;
        setTextSize(size: number): void;
    }
    Index

    Properties

    name

    Methods

    getEnabled getGlobalPosition getGlobalRotation getPosition getRotation getTotalEnabled getUnityComponent setEnabled setPosition setRotation setText setTextAlignment setTextAnchor setTextColor setTextSize

    Properties

    name: string

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

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

    Methods

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

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

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

      Returns boolean | undefined

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

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

      Returns Vector3 | null

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

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

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

      Returns Quaternion | null

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

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

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

      Returns Vector3 | undefined

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

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

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

      Returns Quaternion | undefined

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

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

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

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

      Returns boolean | undefined

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

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

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

      Parameters

      • type: string

      Returns UnityComponent | null

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

    • 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の詳細はドキュメントを参照してください。

      Parameters

      Returns void

      subNode.setTextAlignment(TextAlignment.Left);

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

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

      Parameters

      Returns void

      subNode.setTextAnchor(TextAnchor.UpperLeft);

    • SubNodeが描画する文字列の色をRGBA値で指定します。

      このメソッドに渡した値はsRGB色空間の値として解釈されます。 指定されたRGBA値はそれぞれ0以上1以下の範囲内に収められます。 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods