stingray.Light オブジェクト リファレンス

説明

ゲームのライトを表現します。

コンストラクタとアクセサ

stingray.Unit.light()

その他の関連リファレンス項目

	stingray.Unit.set_light_material()
	Units

この参照ページは、次の概要トピックと関連付けられています

	「構築レベル > カテゴリでレベル オブジェクトを整理する」
	「ライティングとレンダリング > ライティング > 光源 > 光源を作成する」
	「ライティングとレンダリング > ライティング > 光源 > 光源のプロパティを変更する」

関数

baked ( self ) : boolean ライトがベイク処理用にタグ付けされているかどうか、およびリアルタイムのライティングを行うときに除外すべきかどうかを示します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

boolean

ライトがベイク処理のためにタグ付けされている場合は true、それ以外の場合は false を返します。

casts_shadows ( self ) : boolean ライトがシャドウをキャストするかどうかを示します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

boolean

ライトがシャドウをキャストする場合は true を返し、それ以外の場合は false を返します。

color ( self ) : stingray.Vector3 ライトのカラーを取得します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Vector3

ライトのカラーです。X、Y、Z の各軸の値は、それぞれ赤、緑、青のカラー チャネルを示し、それぞれ 0 ～ 1 の間のリニア スペースでの値です。

falloff_end ( self ) : number ライトの強度がゼロに達する距離を取得します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

number

ライトの強度がゼロになる距離です。

falloff_start ( self ) : number ライトがフォールオフし始める(強度が失われ始める)距離を取得します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

number

ライトの強度が弱まり始める距離です。

intensity ( self ) : number ライトの強度を取得します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

number

ライトの強度です。

set_baked ( self, enabled ) このライトをリアルタイムのレンダリング パスに影響させるかどうかを決定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
enabled :	boolean	リアルタイム レンダリング パスからライトを除去するには true を使用します。

戻り値

この関数は値を返しません。

set_casts_shadows ( self, enabled ) ライトがシャドウをキャストするかどうかを決定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
enabled :	boolean	シャドウのキャストを有効にするには true、無効にするには false を使用します。

戻り値

この関数は値を返しません。

set_color ( self, color ) ライトのカラーを設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector3	ライトに設定する色です。X、Y、Z の各軸の値は、それぞれ赤、緑、青のカラー チャネルを示します。それぞれリニア スペースでの値( 0 ～ 1)にする必要があります。

戻り値

この関数は値を返しません。

set_data ( unit, src, dst ) あるライトのデータをユニット内の別のライトに設定します。

パラメータ

unit :	stingray.Unit	目的のライトが属するゲーム ユニットです。
src :	stingray.Light	データのコピー元のソース ライトです。
dst :	stingray.Light	データの受け取り先のライトです。

戻り値

この関数は値を返しません。

set_enabled ( self, enabled ) ライトのオン/オフを切り替えます。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
enabled :	boolean	ライトを有効にするには true、無効にするには false を使用します。

戻り値

この関数は値を返しません。

set_falloff_end ( self, distance ) ライトの強度がゼロに達する距離を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
distance :	number	ライトの強度がゼロになる距離です。

戻り値

この関数は値を返しません。

set_falloff_start ( self, distance ) ライトがフォールオフし始める(強度が失われ始める)距離を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
distance :	number	ライトの強度が弱まり始める距離です。

戻り値

この関数は値を返しません。

set_intensity ( self, intensity ) ライトの強度を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
intensity :	number	ライトに設定する強度です。

戻り値

この関数は値を返しません。

set_shadow_depth_bias ( self, value ) シャドウ マップをレンダリングする際に使用するシャドウ デプスのバイアス値を設定します(0 ～ 1 の範囲)。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
value :	number	シャドウ マップをレンダリングする際に使用するシャドウ デプスのバイアス値です(0 ～ 1 の範囲)。

戻り値

この関数は値を返しません。

値が小さすぎるとシャドウ アクネが発生し、大きすぎるとピーター パニングが発生します。

set_spot_angle_end ( self, spot_angle_end ) ライトの強度がゼロに達する場所で円錐の角度を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
spot_angle_end :	number	新しい円錐角度(ラジアン単位)です。

戻り値

この関数は値を返しません。

スポット ライトにのみ有効です。

set_spot_angle_start ( self, spot_angle_start ) ライトがフォールオフし始める円錐角度を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
spot_angle_start :	number	新しい円錐角度(ラジアン単位)です。

戻り値

この関数は値を返しません。

スポット ライトにのみ有効です。

set_type ( self, type ) ライト ソースのタイプを設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
type :	string	ライト ソースのタイプです。有効な入力値は次のとおりです。 omni: すべての方向に光を放射します。 spot: 単一の光源からの集束する光線です。 box: ボックス ボリュームの単一の内部面から光を放射します。 directional: 平行光線です。

戻り値

この関数は値を返しません。

shadow_depth_bias ( self ) : number ユーザ制御のシャドウ デプスのバイアス値を取得します(0 ～ 1 の範囲)。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

number

ユーザが指定したシャドウ デプスのバイアスを返します(0 ～ 1 の範囲)。

値が小さすぎるとシャドウ アクネが発生し、大きすぎるとピーター パニングが発生します。

spot_angle_end ( self ) : number ライトの強度がゼロに達する場所で円錐の角度を取得します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

number

円錐角度(ラジアン単位)です。

スポット ライトにのみ有効です。

spot_angle_start ( self ) : number ライトがフォールオフし始める円錐角度を取得します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

number

円錐角度(ラジアン単位)です。

スポット ライトにのみ有効です。

type ( self ) : string ライト ソースのタイプを取得します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

string

ライト ソースのタイプです。次のタイプが可能です: omni、spot、box、directional

シーンの配置

このグループ内の関数は、このタイプのオブジェクトのシーン内での配置を制御します。

local_pose ( self ) : stingray.Matrix4x4 ローカル空間内の指定されたシーン グラフ オブジェクトの(シーン グラフでその親に対する)位置と方向を返します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Matrix4x4

ローカル空間内のオブジェクトの位置と方向です。

local_position ( self ) : stingray.Vector3 ローカル空間内の指定されたシーン グラフ オブジェクトの(シーン グラフでその親に対する)位置を返します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Vector3

ローカル空間内のオブジェクトの位置です。

local_rotation ( self ) : stingray.Quaternion ローカル空間内の指定されたシーン グラフ オブジェクトの(シーン グラフでその親に対する)方向を返します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Quaternion

ローカル空間内のオブジェクトの回転です。

node ( self ) : integer シーン グラフ内の指定されたオブジェクトの ID を返します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

integer

シーン グラフ内の指定されたオブジェクトの ID です。

set_local_pose ( self, parent, pose ) ローカル空間内の指定されたシーン グラフ オブジェクトの(シーン グラフでその親に対する)位置と方向を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
parent :	stingray.Unit	このオブジェクトを所有している親ユニットです。
pose :	stingray.Matrix4x4	ローカル空間内のオブジェクトの新しい位置と方向です。

戻り値

この関数は値を返しません。

set_local_position ( self, parent, position ) ローカル空間内の指定されたシーン グラフ オブジェクトの(シーン グラフでその親に対する)位置を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
parent :	stingray.Unit	このオブジェクトを所有している親ユニットです。
position :	stingray.Vector3	ローカル空間内のオブジェクトの新しい位置です。

戻り値

この関数は値を返しません。

set_local_rotation ( self, parent, rotation ) ローカル空間内の指定されたシーン グラフ オブジェクトの(シーン グラフでその親に対する)方向を設定します。

パラメータ

self :	stingray.Light	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
parent :	stingray.Unit	このオブジェクトを所有している親ユニットです。
rotation :	stingray.Quaternion	ローカル空間内のオブジェクトの新しい回転です。

戻り値

この関数は値を返しません。

world_pose ( self ) : stingray.Matrix4x4 ワールド空間内の指定されたシーン グラフ オブジェクトの位置と方向を返します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Matrix4x4

ワールド空間内のオブジェクトの位置と方向です。

world_position ( self ) : stingray.Vector3 ワールド空間内の指定されたシーン グラフ オブジェクトの位置を返します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Vector3

ワールド空間内のオブジェクトの位置です。

world_rotation ( self ) : stingray.Quaternion ワールド空間内の指定されたシーン グラフ オブジェクトの回転を返します。

パラメータ

self :

stingray.Light

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Quaternion

ワールド空間内のオブジェクトの回転です。