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

stingray.Unit オブジェクト リファレンス
アニメーション | バウンディング ボックス | カメラ | ダイナミック データ | フロー | ライト | LOD オブジェクト | マテリアル | メッシュ | その他 | 物理 | プロパティ | シーン グラフ | 地表 | ユニット オブジェクト | 可視性グループ | 廃止予定
すべて展開 | すべて折りたたむ

説明

各 Unit オブジェクトは、キャラクタ、建物、ゲーム レベル内の別のオブジェクトなど、単一のゲーム ユニットを表します。

Unit はゲーム レベル内で中心的な役割を果たす組成オブジェクトです。

アニメーション

stingray.Unit.animation_event()
パラメータ

self :

stingray.Unit

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

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

string

現在のアニメーション ボーン モードを返します。ignore、transform、position、rotation、scale、position_and_rotation、position_and_scale、rotation_and_scale のいずれかが返されます。 これらのモードに関する詳細は set_animation_bone_mode() を参照してください。

パラメータ

self :

stingray.Unit

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

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

event :

string

アニメーション イベントの名前です。

parameters :

any?

キーと値のシーケンスとして指定できます。現在サポートされているパラメータは 1 つのみです。

  • Unit.ANIMATION_OVERRIDE_PERCENT_SYNC: このパラメータを指定した場合、トランジション同期率のパーセント値がオーバーライドされます。スクリプトでこのパラメータを使用すると、対象となるアニメーションに特定の割合でトランジションを適用できます。このパラメータを指定する場合は、パーセンテージを指定する 0 から 1 の間の数値も続けて指定する必要があります。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値
この関数は値を返しません。

この関数はアニメーション ステート マシンが存在するユニットに対してのみ呼び出すようにしてください。

注: この機能はまだ実験段階のものです。

パラメータ

self :

stingray.Unit

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

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

name :

string

コンストレイント ターゲット名です。

戻り値

integer

コンストレイント ターゲットのインデックスです。

パラメータ

self :

stingray.Unit

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

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

name :

string

変数の名前です。

戻り値

integer

指定された変数のインデックスを返します。

パラメータ

self :

stingray.Unit

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

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

index :

integer

取得するコンストレイント ターゲットのインデックスを指定します。

戻り値

stingray.Matrix4x4

コンストレイント ターゲットの値を返します。

パラメータ

self :

stingray.Unit

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

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

object :

string

アニメートされたノードの名前です。

parameter :

string

アニメートされたパラメータの名前です。

float_index :

number

(オプション) 返されるチャネル浮動小数点数の範囲内(0 ～ 3)で、ゼロベースの浮動小数点数インデックスを指定します。既定値は 0 です。

戻り値

boolean

カーブが存在するかどうかを示します。

number

カーブの評価値を返します。

パラメータ

animation :

string

アニメーションの名前です。

戻り値

number

アニメーションの長さです。

パラメータ

self :

stingray.Unit

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

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

any(integer)+

ユニットのアニメーション ステート マシンの現在のシードです。シードは、各レイヤの乱数ジェネレータで使用される現在のシードを表す一連の数字として返されます。

+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
パラメータ

self :

stingray.Unit

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

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

any(integer, nil)+

ユニットの現在のアニメーション状態を返します。状態は、各レイヤの現在の状態を示す一連の数値として返されます。特定の状態を再生していないレイヤに関しては nil が返されます。

+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

animation_set_state() を呼び出す際に一連の同じ値を渡すと、後で同じ状態を復元できます。返される状態にはステート マシンの状態のみが含まれ、再生先頭のオフセット、アニメーション変数、およびコンストレイント ターゲットは含まれません。

パラメータ

self :

stingray.Unit

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

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

index :

integer

変数のインデックスです。

戻り値

number

ユニットのアニメーション ステート マシンの変数の値を返します。

パラメータ

self :

stingray.Unit

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

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

name :

string

コンストレイント ターゲット名です。

戻り値

boolean

ユニットのコンストレイント ターゲットが定義されている場合は true を返し、そうでない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

name :

string

変数の名前です。

戻り値

boolean

指定されたユニットのアニメーション ステート マシンに指定された変数が存在する場合は true 返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

layer :

integer

アニメーション レイヤのインデックスを指定します。

戻り値

number

アニメーションの現在の時間を返します。

number

アニメーション全体の長さを返します。

返された時間の値を返された長さの値で割ることにより(時間÷長さ)、アニメーションの再生が何パーセントまで進行しているかを確認できます。

注: この機能はまだ実験段階のものです。

パラメータ

self :

stingray.Unit

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

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

string

現在のアニメーション ルート モードを返します。ignore、delta_transform、delta_position、delta_rotation、delta_scale、delta_position_and_rotation、delta_position_and_scale、delta_rotation_and_scale のいずれかが返されます。これらのモードに関する詳細は set_animation_root_mode() を参照してください。

パラメータ

self :

stingray.Unit

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

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

index :

integer

設定するコンストレイント ターゲットのインデックスを指定します。

value :

any(stingray.Matrix4x4, stingray.Quaternion, stingray.Vector3)

コンストレイント ターゲットに新しく設定する値を指定します。位置と回転の両方を設定するか、いずれか一方を設定するかに応じて、Matrix4x4、Quaternion、または Vector3 を指定できます。

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

self :

stingray.Unit

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

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

seeds :

integer+

ユニットのアニメーション ステート マシンのレイヤ乱数ジェネレータに設定されたシードです。

+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
戻り値
この関数は値を返しません。
パラメータ

self :

stingray.Unit

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

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

state :

integer+

ユニットに設定するアニメーション状態を指定します。

+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
戻り値
この関数は値を返しません。
パラメータ

self :

stingray.Unit

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

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

index :

integer

値を設定する変数のインデックスを指定します。

value :

number

ユニットのアニメーション ステート マシンの変数に新しく設定する値を指定します。

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

self :

stingray.Unit

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

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

stingray.Matrix4x4

ルート ノードのポーズを返します。

この値は、スクリプトから手動でアニメーションの動きを適用する場合や、他のシステム(ユニットのムーバなど)を通じてアニメーションの動きを渡す場合に使用できます。

パラメータ

self :

stingray.Unit

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

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

animation :

string

アニメーションの名前です。

layer :

integer?

使用するアニメーション レイヤのインデックスを使用します。(オプション) 既定値は 1 です。

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

blend_time :

number?

クロスフェードの時間を指定します。(オプション) 既定値は 0 です。

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

loop :

boolean?

true の場合は指定された時間にわたりアニメーションがループし、false の場合はユニットが最後のポーズのままとどまります。(オプション) 既定値は true です。

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

blend_type :

string?

アニメーションを他のアニメーションとブレンドする方法を指定します。有効な値は normal または offset です。(オプション) 既定値は normal です。

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

integer

アニメーションの制御に使用できる ID を返します。

この関数を呼び出せるのは、アニメーション ブレンダが存在し、アニメーション ステート マシンが存在しないユニット(つまり、スクリプトによって制御されるブレンダが存在するユニット)に対してのみです。

パラメータ

self :

stingray.Unit

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

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

id :

integer

クロスフェードするアニメーションの ID を指定します。

speed :

number

アニメーションの再生速度を指定します。

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

値 1 は、ブレンダと同じ時間ステップを使用することを意味します。値 0 は、フリーズされていることを意味します。速度に負の値は使用できません。

パラメータ

self :

stingray.Unit

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

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

id :

integer

クロスフェードするアニメーションの ID を指定します。

time :

number

アニメーションに設定する時間を指定します。

cap_to_range :

boolean

true の場合、設定される時間はアニメーションの時間範囲内に制限されます。(オプション) 既定値は false です。

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

self :

stingray.Unit

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

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

通常、この関数はデバッグを目的として、または編集ツールで使用されます。

パラメータ

self :

stingray.Unit

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

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

self :

stingray.Unit

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

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

event :

string

アニメーション イベントの名前です。

戻り値

boolean

指定されたユニットに指定されたアニメーション イベントがある場合は true を返し、ない場合は false を返します。

この関数はアニメーション ステート マシンが存在するユニットに対してのみ呼び出すようにしてください。

パラメータ

self :

stingray.Unit

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

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

boolean

指定されたユニットにアニメーション ステート マシンが存在する場合は true を返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

boolean

ユニットでアニメーションのクロスフェードが進行中の場合は true を返し、そうでない場合は false を返します。

この関数を使用すると、クロスフェードするアニメーションの数が増えすぎることを防止できます。

パラメータ

self :

stingray.Unit

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

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

mode :

string

設定するアニメーション ボーン モードを指定します。有効な値は次のとおりです。

  • ignore: ボーン アニメーションを無視します。この場合、ユニットのボーン ノードはボーン アニメーションの影響を受けません。
  • transform: 既定のモードです。アニメーションによって生じたボーンの位置、回転、およびスケールの変更がユニットのボーン ノードに反映されます。
  • position: ボーンの位置のみがボーン ノードに反映されます。
  • rotation: ボーンの回転のみがボーン ノードに反映されます。
  • scale: ボーンのスケールのみがボーン ノードに反映されます。
  • position_and_rotation: ボーンの位置と回転のみがボーン ノードに反映されます。
  • position_and_scale: ボーンの位置とスケールのみがボーン ノードに反映されます。
  • rotation_and_scale: ボーンの回転とスケールのみがボーン ノードに反映されます。
戻り値
この関数は値を返しません。

ルート ノードを除くすべてのボーンに同じ更新モードが適用されます。ルート ノードのモードは別途設定します(set_animation_root_mode() を参照してください)。

パラメータ

self :

stingray.Unit

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

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

enabled :

boolean

ステート マシンのイベント ログを有効にするには true を使用し、無効にするには false を使用します。

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

このメソッドは開発モードでのみ使用できます。

パラメータ

self :

stingray.Unit

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

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

parameters :

any(string, number)+

アニメーション再生の合成オプションを指定します。有効なパラメータは以下のとおりです。

  • "max_start_time": アニメーションの開始時間のずれをどの程度まで許容するかを秒単位で設定します。値を 0.2 に設定した場合、このアニメーションを 0 ～ 0.2 秒の位置まで再生しているプレイヤーが既に存在する場合は、新しいプレイヤーを作成せずにそのプレイヤーを再利用します。その場合、アニメーションは t=0 の位置からは開始せず、既存のプレイヤーの現在の位置にジャンプします。このパラメータを指定する場合は、秒単位で時間値を指定する数値パラメータも続けて指定する必要があります。既定値は 0 で、同じフレーム内で開始された場合にのみアニメーションの評価が合成されます。
  • "max_drift": 表示されているアニメーションの時間と実際のアニメーションの時間のずれをどの程度まで許容するかを制御します。同じプレイヤーを共有する 2 つのアニメーションが異なる速度で再生されると、徐々に時間がずれていきます。ある時点で 2 つのアニメーションは別のものと見なされ、エバリュエータが 2 つに分割されます。このパラメータは、それがどの時点で発生するかを制御します。値を 0.2 に設定した場合、アニメーションのずれが 0.2 秒以上になると、エバリュエータが分割されます。このパラメータを指定する場合は、秒単位で時間値を指定する数値パラメータも続けて指定する必要があります。既定値は 0 です。
  • "clock_fidelity": 設定されたアニメーション再生速度をどの程度尊重するかを制御します。アニメーション プレイヤーでは、アニメーション再生速度をわずかに変更することにより、再生されている 2 つのアニメーションのずれが拡大してエバリュエータが分割されることを回避できます。クロック忠実度を 0.9 に設定した場合の再生速度は要求された値の 90% 以内に収まるようになります。つまり、10% までの変更が許容されます。 このパラメータを指定する場合は、0 から 1 までの間の割合で忠実度を指定する数値パラメータも続けて指定する必要があります。既定値は 1.0 で、要求されたとおりの速度になります。
+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
戻り値
この関数は値を返しません。

Stingray エンジンには、短い間隔で再生された同じアニメーションの評価を合成できる最適化システムが用意されています。このシステムを利用すると、同じアニメーションのインスタンスが複数存在する場合のパフォーマンスを向上させることができます。この関数では合成の設定を制御できます。

注: この機能はまだ実験段階のものであり、今後変更される可能性があります。

パラメータ

self :

stingray.Unit

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

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

mode :

string

設定するアニメーション ルート モードを指定します。有効な値は次のとおりです。

  • ignore: 既定のモードです。ルート アニメーションを無視します。この場合、ユニットのルート ノードはルート アニメーションの影響を受けません。このモードを使用する場合は、animation_wanted_root_pose() を使用してアニメーションによるルートの移動先を抽出し、プログラムを通じてその位置を適用します。
  • delta_transform: アニメーション内で生じたルートの位置、回転、およびスケールの変更の差分がユニットのルート ノードに適用されます。ユニットのルートはアニメーションに従って移動されます。
  • delta_position: delta_transform と同じですが、位置の更新情報のみがルート ノードに反映されます。
  • delta_rotation: delta_transform と同じですが、回転の更新情報のみがルート ノードに反映されます。
  • delta_scale: delta_transform と同じですが、スケールの更新情報のみがルート ノードに反映されます。
  • delta_position_and_rotation: delta_transform と同じですが、位置と回転の更新情報のみがルート ノードに反映されます。
  • delta_position_and_scale: delta_transform と同じですが、位置とスケールの更新情報のみがルート ノードに反映されます。
  • delta_position_and_scale: delta_transform と同じですが、回転とスケールの更新情報のみがルート ノードに反映されます。
戻り値
この関数は値を返しません。
パラメータ

self :

stingray.Unit

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

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

machine :

string

使用するステート マシンのリソースの名前です。

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

self :

stingray.Unit

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

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

lod_level :

integer

ボーンに新しく設定する LOD レベルを指定します。

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

アニメーション内で評価されるボーンは LOD レベルに基いてを決定されます。評価されないボーンはローカル スペース内でフリーズします。この関数を使用すると、カメラから遠く離れているユニットのアニメーション再生に必要な負荷を削減できます。

ボーンの LOD レベルの定義は Unit Editor で行います。

バウンディング ボックス

パラメータ

self :

stingray.Unit

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

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

ignore_invisble_meshes :

boolean?

true の場合、ボックス計算で非表示のメッシュは破棄されます。既定は false です。

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

stingray.Matrix4x4

バウンディング ボックスの中心の位置と回転を返します。

stingray.Vector3

バウンディング ボックスの幅、高さ、奥行きをそれぞれ半分にした値を返します。

カメラ

パラメータ

self :

stingray.Unit

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

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

camera :

any(integer, string)

取得するカメラのインデックスまたは名前です。

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

stingray.Camera

指定されたカメラです。

パラメータ

self :

stingray.Unit

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

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

camera :

string

カメラの名前です。

戻り値

boolean

ユニットに指定されたカメラが存在する場合は true を返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

integer

ユニット内のカメラの数を返します。

ダイナミック データ

パラメータ

self :

stingray.Unit

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

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

indices :

any(integer, string)+

整数または文字列のデータの 1 つまたは複数のインデックスです。

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

any

指定されたインデックスのシーケンスで以前に設定した値です。

パラメータ

self :

stingray.Unit

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

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

indices :

any(integer, string)+

整数または文字列のデータの 1 つまたは複数のインデックスです。

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

boolean

データ値が指定されたインデックスのシーケンスで格納されている場合は true を返し、それ以外の場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

indices :

any(integer, string)

整数または文字列のデータの 1 つまたは複数のインデックスです。

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

value :

any

格納する値です。

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

get_data()の呼び出しで同じインデックスを渡すことにより、後でそのデータを取得できます。

フロー

パラメータ

self :

stingray.Unit

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

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

name :

string

トリガするフロー イベントの名前です。

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

self :

stingray.Unit

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

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

name :

string

取得する外部フロー変数の名前です。

戻り値

any

フロー変数の値です。 この値のタイプは、指定した名前と一致する外部出力変数のタイプによって異なります。

この関数は、**External > Output** カテゴリの下にある外部変数フロー ノードを使用することに注意してください。これは、フロー グラフでしか設定および取得できない Variables カテゴリ下のノードとは関係ありません。

注: エディタ内で「My Unit」として表示されている変数の実際の名前は my_unit です。

パラメータ

self :

stingray.Unit

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

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

name :

string

設定する外部フロー変数の名前です。

value :

any

フロー変数に格納する新しい値を指定します。 この値のタイプは、指定した名前と一致する外部入力変数のタイプによって異なります。

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

この関数は、**External > Input** カテゴリの下にある外部変数フロー ノードを使用することに注意してください。これは、フロー グラフでしか設定および取得できない Variables カテゴリ下のノードとは関係ありません。

ライト

パラメータ

self :

stingray.Unit

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

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

light :

string

ライトの名前です。

戻り値

boolean

ユニットに指定されたライトが存在する場合は true を返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

light :

any(string, integer)

取得するライトの名前またはインデックスを指定します。

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

stingray.Light

指定されたライトを返します。

パラメータ

self :

stingray.Unit

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

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

integer

ユニット内のライトの数を返します。

LOD オブジェクト

パラメータ

self :

stingray.Unit

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

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

lod :

string

LOD オブジェクトの名前です。

戻り値

boolean

ユニットに指定された LOD オブジェクトが存在する場合は true を返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

lod :

any(string, integer)

取得する LOD オブジェクトの名前またはインデックスを指定します。

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

stingray.LODObject

指定された LOD オブジェクトを返します。

パラメータ

self :

stingray.Unit

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

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

integer

ユニット内の LOD オブジェクトの数を返します。

マテリアル

パラメータ

self :

stingray.Unit

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

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

light :

stingray.Light

マテリアルを変更する stingray.Light です。このユニットに所有されている必要があります。

material_resource :

string

ライトに割り当てる .material リソースの名前です。

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

指定されたマテリアルのシェーダ グラフでは、ライトを投影するカラーを生成するために **Output > Light Base** ノードを使用する必要があることに注意してください。

パラメータ

self :

stingray.Unit

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

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

slot_name :

string

マテリアルを設定するスロットの名前です。

material_resource :

string?

スロットに割り当てる .material リソースの名前です。この値が nil にすると、スロットがクリアされます。

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

stingray.IdString64

スロットに割り当てられたマテリアルのリソース ID を返します。

メッシュ

パラメータ

self :

stingray.Unit

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

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

mesh :

string

メッシュの名前です。

戻り値

boolean

ユニットに指定されたメッシュが存在する場合は true を返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

mesh :

any(string, integer)

取得するメッシュの名前またはインデックスを指定します。

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

stingray.Mesh

指定されたメッシュです。

パラメータ

self :

stingray.Unit

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

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

integer

ユニット内のメッシュの数を返します。

その他

パラメータ

self :

stingray.Unit

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

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

boolean

ユニットが削除されている場合、またはユニットが nil の場合には false を返します。

ユニットは常に弱参照として保持されます。ユニットに対して Unit.alive() を呼び出すと、参照がまだ有効かどうかを確認できます。削除されたユニットに対して alive() 以外の関数を呼び出すと、スクリプト エラーが発生します。

注: 弱参照として保持されるのはユニットのみです。他のオブジェクトに対して alive() を呼び出しても、そのオブジェクトが削除されているかどうかは確認できません。

パラメータ

self :

stingray.Unit

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

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

string

ユニットの名前です。

この関数はデバッグ時に名前を出力する必要がある場合にのみ使用してください。リリース バージョンでは実際の名前を使用できないため、この関数は名前ではなく 16 進数文字列を返します。

パラメータ

self :

stingray.Unit

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

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

stingray.IdString64

ユニットがエディタを使用してレベル内に配置された場合はそのレベル内におけるユニットの数値 ID を返し、ユニットが動的にスポーンされた場合は nil を返します。

レベル ファイルが修正されても、この ID は変わりません。この ID はレベル ファイルにおけるユニットのオブジェクト ID にほぼ対応しています。ユニットがネストされたレベルを通じてスポーンされた場合、この ID はネストされたレベルのインスタンス ID とその下にあるユニット オブジェクト ID の関数になります。したがって、特定のレベルを通じてスポーンされた各ユニットには、ワールド内で一意の ID が割り当てられます。

パラメータ

self :

stingray.Unit

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

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

name :

string

ユニット リソース タイプの名前です。

戻り値

boolean

ユニットのリソース タイプが name パラメータで指定されたタイプと一致する場合は true を返し、一致しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

from :

stingray.Vector3

レイキャストの開始位置です。

direction :

stingray.Vector3

レイが開始点からユニット ベクトルとしてキャストされる方向です。

length :

number

レイの長さです。

include_hidden_meshes :

boolean

レイキャストが非表示のメッシュをヒットするかどうかを指定します。

戻り値

number?

衝突テストの開始点からの衝突点の距離です。

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

stingray.Vector3?

衝突したサーフェスの法線です。

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

integer?

メッシュのインデックスです。

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

integer?

三角形のインデックスです。

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

メッシュの三角形がヒットされると、この関数はメッシュ インデックスと、交差する三角形のインデックスを、三角形のヒットのワールド法線とともに返します。ヒットされた三角形がない場合、この関数は何も返しません。

注: 高密度メッシュを含むユニットは非常に高価になります。

パラメータ

self :

stingray.Unit

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

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

string

ユニット名のハッシュ表現を返します。

返される表現は意味を持ちませんが、World.spawn_unit () に引数として渡すと同じタイプの新しいユニットを作成できます。

物理

パラメータ

self :

stingray.Unit

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

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

wake_sleeping_actors :

boolean

効果が適用されたときに眠っているアクターが目を覚ますかどうかを決定します。(オプション) 既定値は true です。false に設定した場合、速度は眠っているアクターにも適用されますが、外部イベントによってアクターが目を覚ますまで効果は発現しません。

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

現在、初期速度は、モデリング パッケージから書き出された物理シーンオブジェクトに対してのみ設定できます。

パラメータ

self :

stingray.Unit

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

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

通常、この関数はデバッグを目的として、または編集ツールで使用されます。

パラメータ

self :

stingray.Unit

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

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

プロパティ

パラメータ

self :

stingray.Unit

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

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

properties :

any(string)

プロパティへのパスを構成する文字列のシーケンスを指定します。詳細は set_Property() を参照してください。

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

number

プロパティに現在設定されている値を返します。

パラメータ

self :

stingray.Unit

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

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

properties :

string

プロパティへのパスを構成する文字列のシーケンスを指定します。

value :

number

プロパティに設定する値を指定します。

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

properties では複数の文字列引数を指定でき、これらの引数が一緒になってプロパティへのパスを構成します。たとえば、次のように記述します。

stingray.Unit.set_property(myUnit, "meshes", "my_unit_mesh_name", "materials", "slot_name", "albedo", "x", 0.25)

この例では、ユニットに存在するマテリアルのアルベド カラーの赤の成分を設定しています。

これらのパスは、StoryTeller のカーブ エディタのツリー ビューで使用されるパスと同じです。

シーン グラフ

パラメータ

self :

stingray.Unit

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

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

string[]

ユニットのステート マシンにあるボーンの名前のリストを返します。

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

dest_unit :

stingray.Unit

シーン グラフ ノードのコピー先ユニットを指定します。

src_unit :

stingray.Unit

ノードのコピー元ユニットを指定します。

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

この関数を使用して「インスタンス化」を行うと、計算負荷の高いユニットをシミュレートしてそのトランスフォームをよりシンプルなユニットにコピーすることが可能になります。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Matrix4x4

グローバル座標におけるノードの位置と向きを返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Vector3

グローバル座標におけるノードの位置を返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Quaternion

グローバル座標におけるノードの回転を返します。

パラメータ

self :

stingray.Unit

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

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

name :

string

検索するノードの名前です。

戻り値

boolean

一致するノードがユニットに存在する場合は true を返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

stingray.World

ユニットが存在するワールドを返します。

パラメータ

self :

stingray.Unit

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

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

stingray.Level?

ユニットをスポーンしたレベルを返し、ユニットが特定のレベルに属していない場合は nil を返します。

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

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Matrix4x4

ノードの位置と向きを返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Vector3

ノードの位置を返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Quaternion

ノードの回転を返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Vector3

ノードのスケールを返します。

パラメータ

self :

stingray.Unit

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

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

name :

string

取得するノードの名前です。

戻り値

integer

オブジェクト ノードのインデックスを返します。

パラメータ

self :

stingray.Unit

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

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

integer

ユニットのシーン グラフ内のノードの数を返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

新しい親にリンクするシーン グラフ ノードのインデックスを指定します。

parent :

integer?

新しい親シーン グラフ ノードを指定します。i が既に親にリンクされている場合、リンクを解除するには nil を指定します。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値
この関数は値を返しません。

オブジェクトのリンク先として指定できるのはシーン グラフ内で前にあるオブジェクト(つまり、より小さいインデックスを持つオブジェクト)のみです。

パラメータ

self :

stingray.Unit

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

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

i :

integer

親ノードを取得するシーン グラフ内のノードのインデックスを指定します。

戻り値

integer

親ノードのインデックスを指定します。そのノードがルート ノードの場合は nil を指定します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

pose :

stingray.Matrix4x4

ノードに設定する新しい位置と向きを指定します。

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

ノードの回転またはスケールのみを変更する場合は、set_local_rotation() または set_local_scale() を使用します。local_pose() を使用して現在のポーズを取得する場合は、その行列の回転またはスケールを変更し、変更後の行列を set_local_pose() に渡します。この場合、浮動小数点の精度が多少失われます。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

position :

stingray.Vector3

ノードに設定する新しい位置を指定します。

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

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

rotation :

stingray.Quaternion

ノードに設定する新しい回転を指定します。

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

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

scale :

stingray.Vector3

ノードに設定する新しいスケールを指定します。

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

ユニットにアクティブな物理アクターが存在する場合は、ユニットのスケールを変更しても、そのユニットのアクターのスケールは変更されません。アクターのスケールも変更する場合は、アクターのタイプによって方法が異なります: 1. ラグドールの場合は、一度ラグドールを非アクティブ化し、ユニットのスケールを設定した後、このラグドール再度アクティブにします。2. その他のタイプ(車両など)の場合は、ユニットのスポーンを解除し、ポーズ行列内でスケールを指定する新しいユニットを再度スポーンする必要があります。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

pose :

stingray.Matrix4x4

ノードに設定する位置と向きを指定します。

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

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

position :

stingray.Vector3

ノードに設定する新しい位置を指定します。

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

この関数はキーフレーム設定された物理オブジェクトの動作に影響します。オブジェクトを「移動」する場合、そのオブジェクトは現在の位置と移動先の位置の間にあるすべてのオブジェクトと衝突します。オブジェクトを「テレポート」する場合、そのオブジェクトは他のオブジェクトとは衝突せずに移動先に出現します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

rotation :

stingray.Quaternion

ノードに設定する新しい回転を指定します。

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

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

scale :

stingray.Vector3

ノードに設定する新しいスケールを指定します。

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

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Matrix4x4

グローバル座標におけるノードの位置と向きを返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Vector3

グローバル座標におけるノードの位置を返します。

パラメータ

self :

stingray.Unit

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

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

i :

integer

ノードのインデックスを指定します。

戻り値

stingray.Quaternion

グローバル座標におけるノードの回転を返します。

地表

パラメータ

self :

stingray.Unit

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

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

terrain :

string

地表の名前です。

戻り値

boolean

ユニットに指定された地表が存在する場合は true を返し、存在しない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

integer

ユニット内の地表の数を返します。

パラメータ

self :

stingray.Unit

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

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

terrain :

any(string, integer)

取得する地表の名前またはインデックスを指定します。

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

stingray.Terrain

指定された地表を返します。

ユニット オブジェクト

パラメータ

self :

stingray.Unit

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

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

actor :

any(string, integer)

取得するアクターの名前またはインデックスを指定します。

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

stingray.Actor

指定されたアクターです。

パラメータ

self :

stingray.Unit

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

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

cloth :

any(string, integer)

布地の名前またはインデックスを指定します。

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

stingray.Cloth

指定された布地を返します。

パラメータ

self :

stingray.Unit

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

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

id :

any(string, integer)

アクターの名前またはインデックスを指定します。

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

inherit_velocity :

number?

(オプション) 接続されているアニメーション オブジェクトの速度を物理アクターにどの程度継承するかを指定します。値を 1.0 に設定すると、アニメーション オブジェクトの速度が完全に継承されます。既定値は 0.0 です。

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

stingray.Actor

作成されたアクターを返します。

パラメータ

self :

stingray.Unit

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

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

id :

any(string, integer)

新しい布地の名前またはインデックスを指定します。

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

stingray.Cloth

新しく作成された布地を返します。

パラメータ

self :

stingray.Unit

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

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

name :

string

作成するジョイントの名前です。

params :

any(string, stingray.Vector3)+

ジョイントの設定パラメータのリストを指定します。このパラメータ リストは文字列とそれに続く引数のシーケンスです。次の引数がサポートされています。

  • "actor_1": コンストレイントによって結合される 1 つ目のアクターを指定します。アクターの名前を指定する文字列パラメータを続けて指定する必要があります。
  • "actor_2": コンストレイントによって結合される 2 つ目のアクターを指定します。アクターの名前を指定する文字列パラメータを続けて指定する必要があります。
  • "anchor_1": 1 つ目のアンカー ポイントを 1 つ目のアクターのローカル座標で指定します。Vector3 パラメータを続けて指定する必要があります。
  • "anchor_2": 2 つ目のアンカー ポイントを 2 つ目のアクターのローカル座標で指定します。Vector3 パラメータを続けて指定する必要があります。
  • "global_anchor": 結合される両方のアクターで使用するアンカー ポイントをグローバル座標で指定します。Vector3 パラメータを続けて指定する必要があります。
  • "global_axis": 結合される両方のアクターで使用するコンストレイント軸をグローバル座標で指定します。Vector3 パラメータを続けて指定する必要があります。
+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
戻り値

stingray.Joint

新しく作成されたジョイントを返します。

パラメータ

self :

stingray.Unit

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

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

name :

string

作成するジョイントの名前です。

戻り値

stingray.Joint

新しく作成されたジョイントを返します。

パラメータ

self :

stingray.Unit

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

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

stingray.Vehicle

新しく作成された車両を返します。

パラメータ

self :

stingray.Unit

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

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

actor :

any(string, integer)

アクターの名前またはインデックスを指定します。

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

self :

stingray.Unit

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

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

id :

any(string, integer)

破壊する布地の名前またはインデックスを指定します。

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

self :

stingray.Unit

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

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

name :

string

破壊するジョイントの名前です。

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

self :

stingray.Unit

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

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

self :

stingray.Unit

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

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

name :

string

検索するアクターの名前です。

戻り値

integer?

アクターのインデックスを返し、一致するアクターが存在しない場合は nil を返します。

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

self :

stingray.Unit

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

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

name :

string

検索する布地の名前です。

戻り値

integer?

ユニット内の布地のインデックスを返し、一致する布地が存在しない場合は nil を返します。

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

self :

stingray.Unit

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

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

name :

string

検索するムーバの名前です。

戻り値

integer?

ムーバのインデックスを返し、一致するムーバが存在しない場合は nil を返します。

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

self :

stingray.Unit

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

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

stingray.Mover?

ユニットの現在のムーバを返し、ユニットにアクティブなムーバが存在しない場合は nil を返します。

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

self :

stingray.Unit

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

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

id :

any(string, integer)

ムーバの名前またはインデックスを指定します。

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

position :

stingray.Vector3

ムーバを配置する位置です。

allow_move :

number?

ゼロ以外の場合、衝突しない位置を検索する距離を指定します。

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

boolean

ムーバがその位置に適合する場合は true を返し、それ以外の場合は false を返します。

stingray.Vector3?

衝突しない位置が見つかった場合は、2 番目のパラメータとして返されます。

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

self :

stingray.Unit

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

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

integer

ユニット内のアクターの数です。

パラメータ

self :

stingray.Unit

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

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

integer

ユニット内の布地の数を返します。

パラメータ

self :

stingray.Unit

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

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

integer

ユニット内のムーバの数を返します。

パラメータ

self :

stingray.Unit

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

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

id :

any(string, integer)

布地の名前またはインデックスを指定します。

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

visibility :

boolean

布地を可視にするには true を使用し、不可視にするには false を使用します。

context :

string?

(オプション) カリング コンテキストごとに可視性を切り替える場合に使用できます。有効なコンテキスト値は、default、shadow_caster、または occluder です。

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

self :

stingray.Unit

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

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

mover :

any(string, integer)?

ムーバの名前またはインデックスを指定します。nil に設定した場合、ユニットの現在のムーバが無効になります。

any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値

stingray.Mover?

現在ユニットに設定されているムーバを返し、ムーバが無効になっている場合は nil を返します。

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

self :

stingray.Unit

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

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

frames :

integer

アニメーション内のフレーム数を指定します。

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

ユニットに対していずれかの set_local...() 関数を呼び出す場合は、移動中のマークが自動的にユニットに付けられるため、明示的に移動中のマークを付ける必要はありません。ただし、ユニットに対してその他の特殊な処理を行う場合は、この関数を呼び出す必要があります。

注 : 現在、この関数は必須ではありません。ユニットに変更を加える操作を行う際に自動的にユニットに移動中のマークを付ける必要がある場合、またはゲームプレイ プログラマが明示的にマーク付けを行う必要がある場合、速度と利便性はトレードオフの関係に置かれます。

パラメータ

self :

stingray.Unit

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

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

stingray.Vehicle?

ユニットの車両は返し、ユニットに車両が存在しない場合は nil を返します。

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

可視性グループ

パラメータ

self :

stingray.Unit

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

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

group :

string

可視性グループの名前です。

戻り値

boolean

ユニットの可視性グループが定義されている場合は true を返し、定義されていない場合は false を返します。

パラメータ

self :

stingray.Unit

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

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

mesh :

any(string, integer)

メッシュの名前またはインデックスを指定します。

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

visibility :

boolean

オブジェクトを可視にするには true を使用し、不可視にするには false を使用します。

context :

string?

(オプション)このパラメータはカリング コンテキストごとに可視性を設定する場合に使用できます。有効な値は、default、shadow_caster、および occluder です。

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

self :

stingray.Unit

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

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

visibility :

boolean

ユニットを可視にするには true を使用し、不可視にするには false を使用します。

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

self :

stingray.Unit

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

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

group :

string

変更する可視性グループの名前です。

visibility :

boolean

オブジェクトを可視にするには true を使用し、不可視にするには false を使用します。

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

可視性グループの宣言はユニットのデータ リソース ファイルで行います。

廃止予定

このセクションの関数は廃止予定とされています。

これらは関数は古いプロジェクトとの下位互換性を維持することのみを目的としてエンジンに残されています。

パラメータ

name :

string

マテリアルの名前です。

戻り値

integer

マテリアルに関連付けられた ID を返します。

パラメータ

self :

stingray.Unit

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

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

from :

number?

アニメーションの再生を開始する時間を指定します。(オプション) 既定値は nil です。現在の時間からアニメーションを開始するには nil を使用します。

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

to :

number?

アニメーションの再生を終了する時間を指定します。(オプション) 既定値は nil です。アニメーションを最後まで再生するには nil を使用します。

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

loop :

boolean?

true の場合は、指定された時間間隔でアニメーションがループします。(オプション) 既定値は false です。

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

speed :

number?

再生速度の制御に使用します。(オプション) 既定値は 1 です。

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

group :

string?

このパラメータを指定した場合は指定された単純なアニメーション グループが再生され、指定しなかった場合はユニット内のすべてのノードが単純なアニメーションの影響を受けます。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値
この関数は値を返しません。

from の時間から to の時間までアニメーションが再生されます。

パラメータ

self :

stingray.Unit

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

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

start :

stingray.Vector3

レイキャストの開始位置を指定します。

end :

stingray.Vector3

レイキャストの終了位置を指定します。

contexts :

string[]

マテリアル コンテキストを含むテーブルを指定します。

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

integer[]

コンテキストごとに 1 つのマテリアル ID が格納されたリストを返します。

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

コンテキストに対してマテリアルが見つからない場合は、そのスロットに 0 が入ります。これは material_id("") に対応します。

パラメータ

self :

stingray.Unit

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

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

group :

string?

このパラメータを指定した場合は単純なアニメーション グループが停止されます。指定しなかった場合は、単純なアニメーションが停止され、ユニット内のすべてのノードが影響を受けます。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値
この関数は値を返しません。
Please send us your comment about this page