Cluster Creator Kit Script Reference
    Preparing search index...

    Interface PlayerLocalObjectPlayer

    Player Scriptで参照可能なオブジェクトを操作するハンドルです。

    interface PlayerLocalObject {
        name: string;
        findObject(name: string): PlayerLocalObject | null;
        getEnabled(): boolean;
        getTotalEnabled(): boolean;
        getUnityComponent(type: string): UnityComponent | null;
        setEnabled(v: boolean): void;
    }
    Index

    Properties

    name: string

    このオブジェクトの名前です。

    Methods

    • オブジェクトの名前を指定して、このオブジェクトの子要素のオブジェクトを取得します。

      この関数では Item コンポーネントがアタッチされたオブジェクト、およびその子要素は取得できません。 Item コンポーネントがアタッチされたオブジェクトをスクリプトから制御する場合、 ClusterScript SubNode を使用してください。

      Parameters

      • name: string

      Returns PlayerLocalObject | null

      指定したnameに対応するオブジェクトがあればそのオブジェクト、なければnull

    • このオブジェクトの現在の有効状態を取得します。

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

      Returns boolean

    • オブジェクトが有効かどうかを取得します。 このオブジェクトと全ての親オブジェクトが有効である場合はtrueを返します。

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

      Returns boolean

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

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

      この関数は Item を親要素または子要素に含むオブジェクトに対して呼び出した場合、例外になります。 これは Item のコンポーネントや Scriptable Item のスクリプトとの制御の競合を防ぐための制限事項です。

      Parameters

      • type: string

      Returns UnityComponent | null

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

    • オブジェクトの有効状態を変更します。 オブジェクトを無効にした場合、このオブジェクト、および全ての子のオブジェクトが無効となり、描画されなくなります。

      この関数は Item を親要素または子要素に含むオブジェクトに対して呼び出した場合、例外になります。 これは Item のコンポーネントや Scriptable Item のスクリプトとの制御の競合を防ぐための制限事項です。

      Parameters

      • v: boolean

        有効ならtrue

      Returns void