Cluster Creator Kit Script Reference
    Preparing search index...

    Interface PolylineHandle

    Polylineは、点列とその太さと色で表現される1本の折れ線です。アイテム、SubNode、PlayerLocalObjectに付き、idで識別されます。 このinterfaceは1本のPolylineを操作するハンドルです。 ClusterScript.polylineなどから取得できます。

    アイテムとSubNodeに付くPolylineの状態は全てのプレイヤーに同期され、後から入室したプレイヤーにも同じ線が表示されます。
    PlayerLocalObjectに付くPolylineは同期されません。

    interface PolylineHandle {
        clear(): void;
        setColor(r: number, g: number, b: number): void;
        setColor(color: Color): void;
        setPoints(points: Vector3[]): void;
        setWidth(width: number): void;
    }
    Index

    Methods

    • Polylineの点列を空にして、線を非表示にします。 clearしたPolylineは、点の数の合計にも本数にも含まれません。

      Returns void

    • Polyline全体の色を設定します。初期値は白です。
      点ごとに異なる色を設定することはできません。
      線は常に不透明で描画されます。
      指定されたRGB値はそれぞれ0以上1以下の範囲内に収められます。
      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Polylineの存在しないidに対して呼び出した場合、新しいPolylineが作られます。 これにより本数が上限を超える場合、ClusterScriptError (polylineCountLimitExceeded)が発生します。上限についてはPolylineHandle.setPointsを参照してください。

      Parameters

      • r: number

        線の色の赤成分

      • g: number

        線の色の緑成分

      • b: number

        線の色の青成分

      Returns void

    • Polyline全体の色を設定します。初期値は白です。
      点ごとに異なる色を設定することはできません。
      アルファ成分は無視され、線は常に不透明で描画されます。
      指定されたRGB値はそれぞれ0以上1以下の範囲内に収められます。
      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Polylineの存在しないidに対して呼び出した場合、新しいPolylineが作られます。 これにより本数が上限を超える場合、ClusterScriptError (polylineCountLimitExceeded)が発生します。上限についてはPolylineHandle.setPointsを参照してください。

      Parameters

      Returns void

    • Polylineの点列を設定します。
      このメソッドを呼び出すたびに、以前設定されていた点列は新しい点列で上書きされます。
      点の位置は、Polylineが付いているノードのローカル座標で指定します。

      1本のPolylineの点の数が2未満の場合、線は表示されません。
      1本のPolylineの点の数が1000を超える場合、ClusterScriptError (polylinePointCountLimitExceeded)が発生します。
      アイテムが持つ全てのPolylineの点の数の合計が上限(ワールドアイテムでは10000点、クラフトアイテムでは1000点)を超える場合、ClusterScriptError (polylineTotalPointCountLimitExceeded)が発生します。
      アイテムが持つPolylineの本数が上限(ワールドアイテムでは10000本、クラフトアイテムでは100本)を超える場合、ClusterScriptError (polylineCountLimitExceeded)が発生します。
      PlayerLocalObject.polylineで取得したPolylineは、これらとは別に数えます(上限はそちらを参照してください)。
      点の位置にNaNやInfinity、-Infinityを含む場合は、エラーになります。

      Parameters

      • points: Vector3[]

        線を構成する点の配列

      Returns void

    • Polylineの線の太さを設定します。太さは線全体に一律に適用されます。初期値は0.01です。
      単位はメートルで、ノードのスケールの影響を受けます。
      0から5の範囲を超える値を指定した場合、この範囲に丸められます。
      NaNやInfinity、-Infinityを指定した場合は、このメソッドの呼び出しは無視されます。

      Polylineの存在しないidに対して呼び出した場合、新しいPolylineが作られます。 これにより本数が上限を超える場合、ClusterScriptError (polylineCountLimitExceeded)が発生します。上限についてはPolylineHandle.setPointsを参照してください。

      Parameters

      • width: number

        線の太さ

      Returns void