Cluster Creator Kit Script Reference
    Preparing search index...

    Interface MaterialHandleItem

    マテリアルをスクリプトから操作するためのハンドルです。

    interface MaterialHandle {
        setBaseColor(r: number, g: number, b: number, a: number): void;
        setBaseColor(color: Color): void;
        setColor(
            propertyName: string,
            r: number,
            g: number,
            b: number,
            a: number,
        ): void;
        setColor(propertyName: string, color: Color): void;
        setEmissionColor(r: number, g: number, b: number, a: number): void;
        setEmissionColor(color: Color): void;
        setFloat(propertyName: string, value: number): void;
        setFloat2(propertyName: string, x: number, y: number): void;
        setFloat3(propertyName: string, x: number, y: number, z: number): void;
        setFloat3(propertyName: string, v: Vector3): void;
        setFloat4(
            propertyName: string,
            x: number,
            y: number,
            z: number,
            w: number,
        ): void;
        setFloat4(propertyName: string, v: Vector4): void;
        setMatrix(propertyName: string, matrix: Float32Array): void;
    }
    Index

    Methods

    • マテリアルのベースカラーを設定します。 このメソッドに渡した値はsRGB色空間の値として解釈されます。

      RGBA値はそれぞれ0以上1以下の範囲内に収められます。

      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • r: number
      • g: number
      • b: number
      • a: number

      Returns void

    • マテリアルのベースカラーを設定します。 このメソッドに渡した値はsRGB色空間の値として解釈されます。

      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      Returns void

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

      マテリアルのColorプロパティの値を設定します。

      r, g, bは0以上の値を取ります。 0より小さい値を渡した場合、0が渡されます。

      aは0以上1以下の範囲内に収められます。

      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      • propertyName: string
      • r: number
      • g: number
      • b: number
      • a: number

      Returns void

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

      マテリアルのColorプロパティの値を設定します。

      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      • propertyName: string
      • color: Color

      Returns void

    • マテリアルのEmissiveの色を設定します。 このメソッドに渡した値はLinearの色空間のHDRの値として解釈されます。

      r, g, bは0以上の値を取ります。 0より小さい値を渡した場合、0が渡されます。

      aは0以上1以下の範囲内に収められます。

      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • r: number
      • g: number
      • b: number
      • a: number

      Returns void

    • マテリアルのEmissiveの色を設定します。 このメソッドに渡した値はLinearの色空間のHDRの値として解釈されます。

      いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      Returns void

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

      マテリアルのFloat値のプロパティを設定します。 NaNやInfinity、-Infinityを渡した場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      • propertyName: string
      • value: number

      Returns void

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

      マテリアルのFloat2の値のプロパティを設定します。 いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      • propertyName: string
      • x: number
      • y: number

      Returns void

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

      マテリアルのFloat3の値のプロパティを設定します。 いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      • propertyName: string
      • x: number
      • y: number
      • z: number

      Returns void

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

      マテリアルのFloat3の値のプロパティを設定します。 いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      Returns void

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

      マテリアルのFloat4の値のプロパティを設定します。 いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      • propertyName: string
      • x: number
      • y: number
      • z: number
      • w: number

      Returns void

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

      マテリアルのFloat4の値のプロパティを設定します。 いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      HDRや色空間のGammaはShaderLabのプロパティ指定の[HDR][Gamma]の指定に従います。 propertyNameは最大64文字までに対応しています。

      Parameters

      Returns void

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

      マテリアルの行列のプロパティを設定します。

      16要素のFloat32Arrayを渡します。 要素数が16ではない場合にはエラーになります。 いずれかの要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      propertyNameは最大64文字までに対応しています。

      Parameters

      • propertyName: string
      • matrix: Float32Array

      Returns void