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

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

説明

NavData の生成に使用される関数です。

デスクトップ(Windows、Mac)およびコンソール(xb1、ps4)でのみ使用できます。

列挙

関数

パラメータ

self :

stingray.GwNavGeneration

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

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

nav_world :

stingray.GwNavWorld

NavData をロードするワールド。

navdata_resource_name :

string

NavData の名前。

戻り値

stingray.GwNavData

正常に追加された場合は生成された NavData、それ以外の場合は nil を返します。

パラメータ

nav_world :

stingray.GwNavWorld

NavData をロードするワールド。

navdata_filepath :

string

ロードする .NavData ファイルへの絶対パス。

戻り値

boolean

NavData ファイルが正常に追加された場合

パラメータ

self :

stingray.GwNavGeneration

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

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

後続の push_triangle へのすべての呼び出しは、同じ NavTag を持ちます。適用された NavTag は、begin_push_triangle の前の、最新の set_current_navtag または reset_current_navtag への呼び出しです。

パラメータ

offset_sector :

stingray.Vector3?

ランタイムにレベルがロードされる位置に NavData を生成するためにセクタに適用されるオフセットです。

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

database_id :

integer?

NavData がロードされるデータベースの ID です。既定値: 0。

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

stingray.GwNavGeneration

セクタの実行に使用される GwNavGeneration

です。

パラメータ

self :

stingray.GwNavGeneration

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

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

stingray.GwNavGenSectorNeighborsIterator

隣接セクタの名前は反復できます。

パラメータ

self :

stingray.GwNavGeneration

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

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

integer

database_id

パラメータ

self :

stingray.GwNavGeneration

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

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

iterator :

stingray.GwNavGenSectorNeighborsIterator

破壊するイテレータです。

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

self :

stingray.GwNavGeneration

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

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

enable :

boolean

ファイルの書き込みを無効にする場合は false です。そうでない場合は、既定値の true です。

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

NavData を生成して追加するには、GwNavGeneration.generate、次に GwNavGeneration.add_generated_navdata_to_world を使用します。

パラメータ

self :

stingray.GwNavGeneration

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

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

actor_shape_template :

string

生成から除外する物理アクターのシェイプ テンプレートの名前です。

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

self :

stingray.GwNavGeneration

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

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

sector_name :

string

生成するセクタの名前です。

戻り値

boolean

生成が正常に終了したかどうかを通知します。

パラメータ

self :

stingray.GwNavGeneration

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

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

sector_name :

string

ステータスを設定するセクタの名前です。

戻り値

stingray.GwNavGeneration.GenFlags

セクタのステータス。

戻り値

string

次の隣接セクタ名です。

パラメータ

self :

stingray.GwNavGeneration

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

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

unit :

stingray.Unit

次のものからメッシュを使用するユニットです。

consume_physics_mesh :

boolean

ユニットの物理的メッシュを使用するかどうかを示します。

consume_render_mesh :

boolean

ユニットのレンダリング メッシュを使用するかどうかを示します。

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

特定の NavTag をプッシュされた三角形に適用するには、set_current_navtag を使用します。

パラメータ

self :

stingray.GwNavGeneration

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

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

position :

stingray.Vector3

シード点の位置です。

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

self :

stingray.GwNavGeneration

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

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

polyline :

stingray.Vector3[]

少なくとも 3 つの Vector3 の配列

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

altitude_min :

number

TagVolume の最小高度

altitude_max :

number

TagVolume の最大高度

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

self :

stingray.GwNavGeneration

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

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

self :

stingray.GwNavGeneration

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

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

self :

stingray.GwNavGeneration

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

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

integer

.GenIO ファイルからのセクタ数が表示されます。

パラメータ

self :

stingray.GwNavGeneration

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

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

string

.GenIO ファイルからのセクタ名が表示されます。

パラメータ

self :

stingray.GwNavGeneration

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

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

genio_name :

string

.GenIO ファイルが存在する場合にそのロード先となる、および生成後の保存先となる、絶対ベース ディレクトリからの相対ファイル パスです。

regenerate_all_navmeshes :

boolean

他のセクターをこれらの .ClientInput ファイルから再生成する必要があるかどうかを示します。

戻り値

boolean

成功の場合は true です。 そうでない場合(たとえば GwNavGeneration.set_absolute_base_dir が前に呼び出されていない)場合には false を返します。

パラメータ

self :

stingray.GwNavGeneration

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

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

absoute_base_dir :

string

生成プロセスにより NavData が保存され、一時ファイルが書き込まれる可能性があるディレクトリです。

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

self :

stingray.GwNavGeneration

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

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

(メートル単位)。

パラメータ

self :

stingray.GwNavGeneration

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

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

(メートル単位)。

パラメータ

self :

stingray.GwNavGeneration

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

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

is_exclusive :

boolean

この障害物に関連付けられている NavTag が NavMesh をトラバースできないようにするかどうかを示します。

color :

stingray.Quaternion?

GwNavTagVolume が NavMesh にタグ付けするカラーです。nil の場合、既定のカラーが適用されます。is_exclusive が true の場合は使用されません。

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

layer_id :

number?

この GwNavTagVolume に関連付けるレイヤです。is_exclusive が true の場合は使用されません。

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

smartobject_id :

number?

この GwNavTagVolume に関連付ける SmartObject です。is_exclusive が true の場合は使用されません。

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

user_data_id :

number?

この GwNavTagVolume に関連付けるユーザ データです。is_exclusive が true の場合は使用されません。

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

(push_triangle、push_meshes_fromunit、push_tagvolume_fromvolume)

パラメータ

self :

stingray.GwNavGeneration

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

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

do_log_configuration :

boolean

ログ レポートが有効になっているときに、設定のログを有効にする場合は true です。

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

self :

stingray.GwNavGeneration

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

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

do_log_per_sector_report :

boolean

各セクタのログを取得する場合は true です。

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

self :

stingray.GwNavGeneration

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

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

do_log_report :

boolean

既定値では無効になっているログ レポートを有効にする場合は true です。

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

self :

stingray.GwNavGeneration

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

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

do_log_report_details :

boolean

詳細ログ レポートを取得する場合は true です。

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

self :

stingray.GwNavGeneration

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

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

do_multicore :

boolean

生成時にマルチコアの使用を無効にする場合は false です。そうでない場合は、PC プラットフォーム上で既定値の true を返します。

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

self :

stingray.GwNavGeneration

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

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

do_profile :

boolean

生成のプロファイリングを有効にする場合は true です。

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

self :

stingray.GwNavGeneration

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

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

(メートル単位)。

パラメータ

self :

stingray.GwNavGeneration

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

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

(メートル単位)。

パラメータ

self :

stingray.GwNavGeneration

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

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

0 に設定すると、サンプリングは、高さフィールドと同じ正確さになります。(メートル単位)。

パラメータ

self :

stingray.GwNavGeneration

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

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

enable :

boolean

メモリの使用を制限して一時ディスク ファイルの使用に依存する場合は true です。

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

self :

stingray.GwNavGeneration

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

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

(平方メートル単位)。

パラメータ

self :

stingray.GwNavGeneration

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

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

(メートル単位)。

パラメータ

self :

stingray.GwNavGeneration

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

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

sector_name :

string

ステータスを設定するセクタの名前です。

gen_flags_sector_change :

stingray.GwNavGeneration.GenFlags

セクタのステータスを示します。

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

self :

stingray.GwNavGeneration

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

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

(角度)。

パラメータ

self :

stingray.GwNavGeneration

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

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

(メートル単位)。