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

説明

キーによってアクセスされる任意の値を格納できるコンポーネントです。

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

stingray.EntityManager.actor_component()

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

	stingray.EntityManager.actor_component()
	Entity

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

「プロジェクトでエンティティを使用する > 組み込みコンポーネントについて」

関数

create ( self, entity, id ) : integer 指定されたコンポーネント ID を持つエンティティのコンポーネント インスタンスを作成します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entity :	stingray.Entity	エンティティです。
id :	any(integer, string)	コンポーネント ID です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

戻り値

integer

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

create_capsule ( self, entity, id, pose, radius, height, actor_template, shape_template, material_template ) : integer カプセル シェイプを使用してアクターを作成します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entity :	stingray.Entity	アクターを所有するエンティティです。
id :	any(integer, string)	アクター コンポーネントのインスタンス ID です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
pose :	stingray.Matrix4x4	エンティティに対するアクターのポーズです。
radius :	number	カプセルの半径です。
height :	number	カプセルの高さです。
actor_template :	string	このアクターに使用する .physics_properties ファイルからのアクター テンプレートです。
shape_template :	string	このアクターに使用する .physics_properties ファイルからのシェイプ テンプレートです。
material_template :	string	このアクターに使用する .physics_properties ファイルからのマテリアル テンプレートです。

戻り値

integer

新たに作成されたアクター コンポーネントのインスタンスです。

カプセルは、トランスフォームの Y 軸に沿って方向付けされます。別の回転が必要な場合は、ポーズ行列を回転させて実現します。

create_plane ( self, entity, id, pose, normal, actor_template, shape_template, material_template ) : integer プレーンのシェイプを使用してアクターを作成します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entity :	stingray.Entity	アクターを所有するエンティティです。
id :	any(integer, string)	アクター コンポーネントのインスタンス ID です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
pose :	stingray.Matrix4x4	エンティティに対するアクターのポーズです。
normal :	stingray.Vector3	プレーンの法線です。
actor_template :	string	このアクターに使用する .physics_properties ファイルからのアクター テンプレートです。
shape_template :	string	このアクターに使用する .physics_properties ファイルからのシェイプ テンプレートです。
material_template :	string	このアクターに使用する .physics_properties ファイルからのマテリアル テンプレートです。

戻り値

integer

新たに作成されたアクター コンポーネントのインスタンスです。

プレーンのシェイプは、指定した位置と法線による無限プレーンです。

create_sphere ( self, entity, id, pose, radius, actor_template, shape_template, material_template ) : integer 球体のシェイプを使用してアクターを作成します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entity :	stingray.Entity	アクターを所有するエンティティです。
id :	any(integer, string)	アクター コンポーネントのインスタンス ID です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
pose :	stingray.Matrix4x4	エンティティに対するアクターのポーズです。
radius :	number	球の半径です。
actor_template :	string	このアクターに使用する .physics_properties ファイルからのアクター テンプレートです。
shape_template :	string	このアクターに使用する .physics_properties ファイルからのシェイプ テンプレートです。
material_template :	string	このアクターに使用する .physics_properties ファイルからのマテリアル テンプレートです。

戻り値

integer

新たに作成されたアクター コンポーネントのインスタンスです。

create_sphere ( self, entity, id, pose, radius, actor_template, shape_template, material_template ) : integer ボックスのシェイプを使用してアクターを作成します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entity :	stingray.Entity	アクターを所有するエンティティです。
id :	any(integer, string)	アクター コンポーネントのインスタンス ID です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
pose :	stingray.Matrix4x4	エンティティに対するアクターのポーズです。
radius :	stingray.Vector3	ボックスの「半径」(X、Y、Z 軸の半分の範囲)です。
actor_template :	string	このアクターに使用する .physics_properties ファイルからのアクター テンプレートです。
shape_template :	string	このアクターに使用する .physics_properties ファイルからのシェイプ テンプレートです。
material_template :	string	このアクターに使用する .physics_properties ファイルからのマテリアル テンプレートです。

戻り値

integer

新たに作成されたアクター コンポーネントのインスタンスです。

destroy ( self, instance ) エンティティの特定のコンポーネント インスタンスを破壊します。

パラメータ

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

戻り値

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

destroy_all ( self, entity ) エンティティのすべてのコンポーネント インスタンスを破棄します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entity :	stingray.Entity	すべてのコンポーネント インスタンスを破棄するエンティティです。

戻り値

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

get_property ( self, instance, key ) : any* プロパティ キーの値を取得します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
instance :	integer	コンポーネントのインスタンスです。
key :	any(string, string[])	取得する値を持つプロパティのキーです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

戻り値

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

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

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

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

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

get_property_by_id ( self, entity, id, key ) : any* 指定された ID と一致するコンポーネント インスタンスのプロパティ値を取得します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この 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 を呼び出すと便利です。

instances ( self, entity ) : integer* 指定されたエンティティのすべてのコンポーネント インスタンスを返します。

パラメータ

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

戻り値

integer*

すべてのエンティティのコンポーネント インスタンスです。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

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

instance_ids ( self, entity ) : integer* すべてのエンティティのコンポーネントの ID を返します。

パラメータ

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

戻り値

integer*

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

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

lookup ( self, entity, id ) : integer 指定された ID のコンポーネント インスタンスを返します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entity :	stingray.Entity	エンティティです。
id :	integer	コンポーネント インスタンスの ID です。

戻り値

integer

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

set_parent ( self, entities, parent_indices ) エンティティごとに parent_indices を検索し、親を特定の親インデックスに指定します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
entities :	table	親/子のリレーションシップを設定するエンティティのリストです。
parent_indices :	table	親インデックスのエンティティ リストと同じ長さのリストです。親のないエンティティのインデックスとして false を使用します。

戻り値

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

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

set_property ( self, instance, key, value ) プロパティ キーに値を設定します。

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この 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 に設定すると、プロパティを削除することができます。

set_property_by_id ( self, entity, id, key, value ) : integer プロパティ値を設定し、指定された ID と一致するコンポーネント インスタンスを返します

パラメータ

self :	stingray.ActorComponent	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この 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 を呼び出すと便利です。

spawned ( self, entities ) エンティティごとに、このコンポーネント タイプに対して spawned を呼び出します。

パラメータ

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

戻り値

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

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