TransformComponent - stingray.TransformComponent オブジェクト リファレンス - Stingray Lua API リファレンス

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

説明

エンティティをワールドに配置できるようにするコンポーネントです。

TransformComponent はエンティティのシーン グラフを作成します。エンティティは、他のエンティティ、およびそのエンティティの変更されたローカル位置にリンクすることができます。TransformComponent はすべてのエンティティのワールド位置の計算を行います。

関数

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

parent :

stingray.Entity

子を検索するエンティティを指定します。

戻り値

stingray.Entity[]

親エンティティの子を返します。

[]表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

子が存在しない場合は、空のテーブルが返されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

エンティティです。

id :

any(integer, string)

コンポーネント ID です。

any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
戻り値

integer

コンポーネントのインスタンスです。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

instance :

integer

破棄するコンポーネントのインスタンスです。

戻り値
この関数は値を返しません。
パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

すべてのコンポーネント インスタンスを破棄するエンティティです。

戻り値
この関数は値を返しません。
パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

instance :

integer

コンポーネントのインスタンスです。

key :

any(string, string[])

取得する値を持つプロパティのキーです。

any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
戻り値

any*

キーの値です。

* の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。

値はプロパティシ ステムでサポートされているいずれかの値(nil、ブール、数値、文字列、または float 配列)になります。

float 配列は複数の戻り値として返されます。テーブルまたは Vector3 としてこれらが必要な場合は、ラッパーを使用します。

キーが存在しない場合、nil が返されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

エンティティです。

id :

integer

コンポーネント インスタンスの ID です。

key :

any(string, string[])

取得する値を持つプロパティのキーです。

any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
戻り値

any*

キーの値です。

* の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。

値はプロパティシ ステムでサポートされているいずれかの値(nil、ブール、数値、文字列、または float 配列)になります。

float 配列は複数の戻り値として返されます。テーブルまたは Vector3 としてこれらが必要な場合は、ラッパーを使用します。

キーが存在しない場合、nil が返されます。

この関数を呼び出すと、指定されたコンポーネント ID からコンポーネント インスタンスへの追加ルックアップが実行されます。複数のプロパティを取得する場合は、コンポーネント ID を指定してコンポーネント インスタンスをルックアップしてから、get_property を呼び出すと便利です。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

エンティティです。

戻り値

integer*

すべてのエンティティのコンポーネント インスタンスです。

* の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

このインスタンスはスタック上で返されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

エンティティです。

戻り値

integer*

すべてのエンティティ インスタンスの ID です。

* の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

この ID は、スタック上で返されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

ポーズを検索するエンティティを指定します。

戻り値

stingray.Matrix4x4

エンティティのローカル ポーズを返します。

親が存在しない場合、エンティティのローカル ポーズはワールド ポーズと同じです。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

位置を検索するエンティティを指定します。

戻り値

stingray.Vector3

エンティティのローカル位置を返します。

親が存在しない場合、エンティティのローカル位置はワールド位置と同じです。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

回転を検索するエンティティを指定します。

戻り値

stingray.Quaternion

エンティティのローカル回転を返します。

親が存在しない場合、エンティティのローカル回転はワールド回転と同じです。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

スケールを検索するエンティティを指定します。

戻り値

stingray.Vector3

エンティティのローカル スケールを返します。

親が存在しない場合、エンティティのローカル スケールはワールド スケールと同じです。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

エンティティです。

id :

integer

コンポーネント インスタンスの ID です。

戻り値

integer

コンポーネントのインスタンスです。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

child :

stingray.Entity

親を検索する子を指定します。

戻り値

stingray.Entity?

子の親を返します。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

ポーズを変更するエンティティを指定します。

pose :

stingray.Matrix4x4

エンティティの新しいローカル ポーズを指定します。

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

親が存在しない場合、エンティティのローカル ポーズはワールド ポーズと同じです。

ローカル ポーズを変更すると、新しいポーズ スケールを反映してエンティティのワールド ポーズとすべての子がただちに変更されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

位置を変更するエンティティを指定します。

position :

stingray.Vector3

エンティティの新しいローカル位置を指定します。

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

親が存在しない場合、エンティティのローカル位置はワールド位置と同じです。

ローカル位置を変更すると、新しいローカル位置を反映してエンティティのワールド位置とすべての子がただちに変更されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

回転を変更するエンティティを指定します。

rotation :

stingray.Quaternion

エンティティの新しいローカル回転を指定します。

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

親が存在しない場合は、エンティティのローカル回転はワールド回転と同じです。

ローカル回転を変更すると、新しいローカル回転を反映してエンティティのワールド回転とすべての子がただちに変更されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

スケールを変更するエンティティを指定します。

scale :

stingray.Vector3

エンティティの新しいローカル スケールを指定します。

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

親が存在しない場合、エンティティのローカル スケールはワールド スケールと同じです。

ローカル スケールを変更すると、新しいローカル スケールを反映してエンティティのワールド スケールとすべての子がただちに変更されます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entities :

table

親/子のリレーションシップを設定するエンティティのリストです。

parent_indices :

table

親インデックスのエンティティ リストと同じ長さのリストです。親のないエンティティのインデックスとして false を使用します。

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

この関数は、すべてのコンポーネントを追加および設定してから、spawned を実行するまでの間に呼び出す必要があります。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

instance :

integer

コンポーネントのインスタンスです。

key :

any(string, string[])

設定する値を持つプロパティのキーです。

any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

value :

any

キーに設定する値

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

キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。

値はプロパティシ ステムでサポートされている任意の値(nil、ブール、数値、文字列、または float 配列)にすることができます。

3 つまたは 4 つの float 配列を渡す代わりに、Vector3 または Quaternion を使用することができます。

値を nil に設定すると、プロパティを削除することができます。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

エンティティです。

id :

integer

コンポーネント インスタンスの ID です。

key :

any(string, string[])

設定する値を持つプロパティのキーです。

any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

value :

any

キーに設定する値

戻り値

integer

コンポーネントのインスタンスです。

キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。

値はプロパティシ ステムでサポートされている任意の値(nil、ブール、数値、文字列、または float 配列)にすることができます。

3 つまたは 4 つの float 配列を渡す代わりに、Vector3 または Quaternion を使用することができます。

値を nil に設定すると、プロパティを削除することができます。

この関数を呼び出すと、指定されたコンポーネント ID からコンポーネント インスタンスへの追加ルックアップが実行されます。複数のプロパティを設定する場合は、コンポーネント ID を指定してコンポーネント インスタンスをルックアップしてから、set_property を呼び出すと便利です。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entities :

table

spawned を呼び出すエンティティのリストです。

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

これは、エンティティおよびそのコンポーネントを作成および設定した後に、ワールドへの導入を仕上げる目的で呼び出す必要があります。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

ポーズを検索するエンティティを指定します。

戻り値

stingray.Matrix4x4

エンティティのワールド ポーズを指定します。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

位置を検索するエンティティを指定します。

戻り値

stingray.Vector3

エンティティのワールド位置を返します。

パラメータ

self :

stingray.TransformComponent

この関数を機能させるオブジェクト インスタンスを指定します。

このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

entity :

stingray.Entity

回転を検索するエンティティを指定します。

戻り値

stingray.Quaternion

エンティティのワールド回転を返します。