AnimationBlenderComponent - stingray.AnimationBlenderComponent オブジェクト リファレンス - Stingray Lua API リファレンス
説明
エンティティのアニメーションのブレンドを扱うコンポーネントです。
コンストラクタとアクセサ 
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
関数
 |
bone_mode ( self, entity ) : stingray.AnimationBlenderBoneMode アニメーション ブレンダのボーン モードを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
|
アニメーション ブレンダのボーン モードです。 |
| |
create ( self, entity, id ) : integer指定されたコンポーネント ID を持つエンティティのコンポーネント インスタンスを作成します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | any(integer, string) | コンポーネント ID です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
integer |
コンポーネントのインスタンスです。 |
| |
crossfade ( self, entity, animation, layer, blend_time, loop ) : integerアニメーション ステート マシンを使用せずに、エンティティ上で直接アニメーションを再生します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
animation : | string | 再生する必要がある .animation リソースの名前 |
layer : | integer? | アニメーションを再生する必要があるレイヤです(既定値は 0)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
blend_time : | number? | 指定されたレイヤのアニメーションにブレンドする回数です(既定値は 0)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
loop : | boolean? | アニメーションをループするかどうかを指定します(既定値は true)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
再生するアニメーションの ID です。 |
アニメーションは指定されたレイヤ内で、blend_time に指定した回数でブレンドされます。アニメーションがループするように指定されていない場合、最終ポーズでアニメーションが(別のアニメーションにブレンドするまで)フリーズします。
アニメーション ステート マシンを使用している場合、アニメーション ブレンダ上で直接再生されるアニメーションに干渉します。
アニメーションを制御するために使用できる ID を返します。
その他の関連リファレンス項目
| |
delta_transform ( self, entity ) : stingray.Matrix4x4エンティティに適用されるアニメーションからデルタ トランスフォームを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
|
アニメーションからエンティティ用にデルタをトランスフォームします。 |
AnimationBlenderRootMode.IGNORE モードで実行している場合、この関数はアニメーション ブレンダによってエンティティに適用されるデルタ トランスフォームを返します。これを使用すると、アニメーションの動きをスクリプトから手動で適用したり、他のシステム(たとえば、ムーバなど)を介して渡すことができます。
| |
destroy ( self, instance )エンティティの特定のコンポーネント インスタンスを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
instance : | integer | 破棄するコンポーネントのインスタンスです。 |
| この関数は値を返しません。 |
| |
destroy_all ( self, entity )エンティティのすべてのコンポーネント インスタンスを破棄します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | すべてのコンポーネント インスタンスを破棄するエンティティです。 |
| この関数は値を返しません。 |
| |
get_property ( self, instance, key ) : any*プロパティ キーの値を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この 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 ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
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 ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
integer* |
すべてのエンティティのコンポーネント インスタンスです。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
このインスタンスはスタック上で返されます。
| |
instance_ids ( self, entity ) : integer*すべてのエンティティのコンポーネントの ID を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
integer* |
すべてのエンティティ インスタンスの ID です。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
この ID は、スタック上で返されます。
| |
is_crossfading ( self, entity ) : boolean現在クロスフェードされているアニメーションがある場合は true を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
boolean |
現在クロスフェードされているアニメーションがある場合は true になります。 |
これを使用して、あまりに多くのクロスフェード アニメーションが互いに重なり合うのを避けることができます。
| |
lookup ( self, entity, id ) : integer指定された ID のコンポーネント インスタンスを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | integer | コンポーネント インスタンスの ID です。 |
integer |
コンポーネントのインスタンスです。 |
| |
root_mode ( self, entity ) : stingray.AnimationBlenderRootModeアニメーション ブレンダのルート モードを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
|
アニメーション ブレンダのルート モードです。 |
| |
set_bones_lod ( self, entity, lod )必要な新しいエンティティ トランスフォームを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
lod : | integer | アニメーションの新しいボーン LOD レベルです。 |
| この関数は値を返しません。 |
AnimationBlenderRootMode.IGNORE モードで実行している場合、この関数はアニメーション ブレンダがエンティティを動かすポーズを返します。これを使用すると、アニメーションの動きをスクリプトから手動で適用したり、他のシステム(たとえば、ムーバなど)を介して渡すことができます。
| |
set_bone_mode ( self, entity, bone_mode )アニメーション ブレンダのボーン モードを設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
bone_mode : | アニメーション ブレンダの新しいボーン モードです。 |
| この関数は値を返しません。 |
| |
set_parent ( self, entities, parent_indices )エンティティごとに parent_indices を検索し、親を特定の親インデックスに指定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entities : | table | 親/子のリレーションシップを設定するエンティティのリストです。 |
parent_indices : | table | 親インデックスのエンティティ リストと同じ長さのリストです。親のないエンティティのインデックスとして false を使用します。 |
| この関数は値を返しません。 |
この関数は、すべてのコンポーネントを追加および設定してから、spawned を実行するまでの間に呼び出す必要があります。
| |
set_property ( self, instance, key, value )プロパティ キーに値を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この 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 ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
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 を呼び出すと便利です。
| |
set_root_mode ( self, entity, root_mode )アニメーション ブレンダのルート モードを設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
root_mode : | アニメーション ブレンダの新しいルート モードです。 |
| この関数は値を返しません。 |
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | integer | クロスフェード アニメーションの ID です。 |
speed : | number | アニメーション再生の新しい速度です。 |
| この関数は値を返しません。 |
シードは、ブレンダの速度に対して設定されます。値 1 は、ブレンダと同じ時間ステップを使用することを意味します。値 0 は、フリーズされていることを意味します。速度に負の値は使用できません。
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | integer | クロスフェード アニメーションの ID です。 |
time : | number | アニメーションに設定する時間です。 |
| この関数は値を返しません。 |
| |
spawned ( self, entities )エンティティごとに、このコンポーネント タイプに対して spawned を呼び出します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entities : | table | spawned を呼び出すエンティティのリストです。 |
| この関数は値を返しません。 |
これは、エンティティおよびそのコンポーネントを作成および設定した後に、ワールドへの導入を仕上げる目的で呼び出す必要があります。