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

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

説明

UnitSynchronizer は、複数のネットワーク接続されたピアでユニットの作成、破壊、位置、回転を同期するヘルパー オブジェクトです。

これは、ゲーム ユニットに加えられる最も一般的な変更を同期するための、簡易な組み込みシステムを提供します。これにより、ネットワーク オブジェクトの初期化に使用するコールバック オブジェクトへの実装が必要なコールバック数は最小化されます。ただし、ユニットを同期する方法をさらに詳細にコントロールする場合には、UnitSynchronizer を使用する代わりに、独自の同期手法をコーディングすることもできます。

UnitSynchronizer を使用するには、同期するゲーム オブジェクトを、ネットワークの初期化に使用する .network_config データ ファイル内で適切に設定する必要があります。詳細については、ネットワーキングのマニュアルを参照してください。

関数

パラメータ

self :

stingray.UnitSynchronizer

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

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

unit :

stingray.Unit

破壊するユニットです。

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

: ユニットは本来、UnitSynchronizer.spawn_unit() の呼び出しにより、同じ UnitSynchronizer オブジェクトでスポーンされていなければなりません。

パラメータ

self :

stingray.UnitSynchronizer

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

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

id :

integer

取得するユニットのゲーム オブジェクト ID です。

戻り値

stingray.Unit

対応するユニットです(ある場合)。

パラメータ

self :

stingray.UnitSynchronizer

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

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

world :

stingray.World

UnitSynchronizer がユニットをスポーンするゲーム ワールドです。

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

UnitSynchronizer オブジェクトの他の関数を呼び出す前に、この関数を呼び出す必要があります。

パラメータ

self :

stingray.UnitSynchronizer

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

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

type :

string

.network_config データ ファイルで設定されている、このユニットの同期に使用するゲーム オブジェクトのタイプです。

unit_name :

string

スポーンされる必要のあるユニット リソースの名前です。

position :

stingray.Vector3?

新しいユニットの開始位置です。これを省略した場合、ユニットは既定の位置 (3D 座標系の原点) でスポーンされます。

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

rotation :

stingray.Quaternion?

新しいユニットの初期の回転です。これを省略した場合、ユニットは既定の回転でスポーンされます。

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

stingray.Unit

新しく作成されるユニットです。

パラメータ

self :

stingray.UnitSynchronizer

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

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

unit :

stingray.Unit

ゲーム オブジェクト ID を取得するユニットです。

戻り値

integer

対応するゲーム オブジェクト ID です(ある場合)。