Entity カテゴリ - Stingray Lua API リファレンス
説明
このカテゴリには、エンティティ システムに関連する API 要素が含まれています。
関連サンプル コード 
ネームスペース
オブジェクト
関数
 |
add_instance_to_tags ( self, instance, tags ) インスタンスに多数のタグを使用してタグ付けします。タグを使用することで後で効率的にインスタンスのクエリーを行うことができます。
|
パラメータ
戻り値
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
instance : | integer | コンポーネントのインスタンスです。 |
tags : | string* | このコンポーネント インスタンスに追加するタグを表す可変数の文字列です。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
| この関数は値を返しません。 |
その他の関連リファレンス項目
| |
entities_with_script ( self, script_name ) : stingray.Entity[]指定したスクリプト名にリンクされたすべてのエンティティを返します。
|
パラメータ
戻り値
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
script_name : | string | スクリプトの名前です。 |
|
スクリプト名にリンクされたエンティティの配列です。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
その他の関連リファレンス項目
| |
instance_ids_with_script ( self, entity, script_name, result_table ) : any(stingray.Entity, integer)[], integerinstance_ids_with_script ( self, script_name, result_table ) : any(stingray.Entity, integer)[], integer指定したスクリプト名にリンクされたすべてのスクリプト コンポーネント インスタンスを返します。
|
パラメータ
戻り値
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | スクリプト コンポーネントのクエリー用のオプションのエンティティです。 | |
script_name : | string | スクリプトの名前です。 |
result_table : | table? | 結果用のオプションのテーブル。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
any(stingray.Entity, integer)[] |
エンティティおよびコンポーネントのインスタンス ID のインターリーブされたペアです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
integer |
テーブルに書き込まれる結果の数です。 |
使用例:
-- We can pass a cached table for better performance or we can omit the parameter and have it allocated for us.
local components, num_components = script_component:instances_with_script("myscript_name", self._query_cache)
local arg1 = -- some argument
local arg2 = -- some argument
script_component:call_function(components, "some_function", arg1, arg2)
local entity = -- some entity
local arg1 = -- some argument
local arg2 = -- some argument
local components = script_component:instances_with_script(entity, "myscript_name", self._query_cache)
script_component:call_function(components, "some_function", arg1, arg2)
その他の関連リファレンス項目