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

説明

Navigation ワールドを表します。

コンストラクタとアクセサ

stingray.GwNavWorld.create()

関連サンプル コード

Appkit: /app.lua

その他の関連リファレンス項目

stingray.GwNavAStar.create() stingray.GwNavBot.create() stingray.GwNavBoxObstacle.create() stingray.GwNavBoxObstacle.create_exclusive() stingray.GwNavCylinderObstacle.create() stingray.GwNavCylinderObstacle.create_exclusive() stingray.GwNavGeneration.add_generated_navdata_to_world() stingray.GwNavGeneration.add_navdata_file_to_world() stingray.GwNavGraph.create() stingray.GwNavQueries.diskcango() stingray.GwNavQueries.diskcast() stingray.GwNavQueries.inside_position_from_outside_position() stingray.GwNavQueries.move_on_navmesh() stingray.GwNavQueries.raycango() stingray.GwNavQueries.raycast() stingray.GwNavQueries.raycast_full_3d() stingray.GwNavQueries.tag_volumes_from_position() stingray.GwNavQueries.triangle_from_position() stingray.GwNavSmartObjectInterval.can_traverse_smartobject() stingray.GwNavSmartObjectInterval.create() stingray.GwNavTagVolume.create() stingray.GwNavTraversal.get_seed_triangle() stingray.GwNavTraverseLogicData.create()

Gameware Navigation

この参照ページは、次の概要トピックと関連付けられています

	「リリース ノート > Stingray 1.4 リリース ノート」
	「ゲームプレイを作成する > AI とパスファインディング > Gameware Navigation を使用するレベルを設定する」
	「ゲームプレイを作成する > AI とパスファインディング > Navigation Options」

関数

add_navdata ( database_or_world, navdata ) : stingray.GwNavData 指定した GwNavWorld に NavData を追加します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	navdata が追加される GwNavDatabase です。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
navdata :	string	データベース サフィックスなしで追加する NavData のリソース名です。

戻り値

stingray.GwNavData

正常にロードされた場合はロードされた navdata、それ以外の場合は nil を返します。

allow_smartobject ( self, smartobject_id ) SmartObject をトラバースすることができます。

パラメータ

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

戻り値

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

create ( transform, database_count ) : stingray.GwNavWorld 新しい GwNavWorld を作成して返します。

パラメータ

transform :	stingray.Matrix4x4?	3D 空間内の新しい GwNavWorld のトランスフォームを指定します。オプション。省略した場合は、GwNavWorld は単位行列を使用します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
database_count :	integer?	オプション。使用されるデータベースの数です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.GwNavWorld

新しい GwNavWorld です。

database ( self, database_id ) : stingray.GwNavDatabase 指定した ID の GwNavDatabase が存在する場合はそれを返し、それ以外の場合は nil を返します。

パラメータ

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

戻り値

stingray.GwNavDatabase

Kaim::Database へのポインタです(存在する場合)。

database_count ( self ) : number GwNavWorld で作成されたデータベースの数を返します。

パラメータ

self :

stingray.GwNavWorld

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

戻り値

number

GwNavWorld で作成されたデータベースの数です。

destroy ( self ) 指定した GwNavWorld を破壊します。

パラメータ

self :

stingray.GwNavWorld

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

戻り値

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

enable_crowd_dispersion ( self ) GwNavWorld の群集分散を有効にします。

パラメータ

self :

stingray.GwNavWorld

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

戻り値

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

forbid_smartobject ( self, smartobject_id ) コストが set_smartobject_cost_multiplier() を介して設定された場合、SmartObject がトラバースするのを禁止します。後で allow_smartobject() が呼び出された場合、SmartObject はそのまま残ります。

パラメータ

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

戻り値

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

init_async_update ( self ) ワールドにワーカー スレッドを作成させます。

パラメータ

self :

stingray.GwNavWorld

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

戻り値

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

重要: kick_async_update()/join_async_update() を呼び出す場合は、これを呼び出す 必要があります。

is_crowd_dispersion_enabled ( self ) : boolean GwNavWorld の群集分散を有効にします。

パラメータ

self :

stingray.GwNavWorld

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

戻り値

boolean

stingray.GwNavWorld.enable_crowd_dispersion が呼び出された場合は true です。

join_async_update ( self ) kick_update() により開始された非同期更新が完了するまでブロックします。

パラメータ

self :

stingray.GwNavWorld

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

戻り値

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

重要 - この関数への呼び出しは、kick_async_update() への呼び出しに 1 対 1 でマッピングする必要があります。

kick_async_update ( self, delta_time ) ワーカー スレッド上でワールドを更新させます。

パラメータ

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

戻り値

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

重要: join_update() (以下を参照)を呼び出す前に呼び出す必要があるナビゲーション関連の関数はありません。呼び出すと、クラッシュしたり、その他の定義されていない動作が発生します。

register_all_navgraphedges_for_crowd_dispersion ( self, nav_graph ) 群集分散に GwNavGraph を登録します。

パラメータ

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

戻り値

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

register_tagvolume_for_crowd_dispersion ( self, tag_volume ) 群集分散に GwNavTagVolume を登録します。

パラメータ

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

戻り値

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

remove_navdata ( navdata ) 指定した GwNavWorld から NavData を除去します。

パラメータ

navdata :

stingray.GwNavData

追加する NavData リソースのファイル名です。

戻り値

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

set_dynamicnavmesh_budget ( self, budget ) フレームごとのバジェットをこのワールドに設定します(秒単位)。

パラメータ

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

戻り値

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

ワールドは、動的 navmesh を処理する際に、指定されたバジェットを超えません。

set_pathfinder_budget ( self, budget ) フレームごとのバジェットをこのワールドに設定します(秒単位)。

パラメータ

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

戻り値

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

ワールドは、パスファインディングの要求を処理する際に、指定されたバジェットを超えません。

set_smartobject_cost_multiplier ( self, smartobject_id, cost_multiplier ) 指定した SmartObject をトラバースするときに使用する必要があるコスト乗数を指定することができます。

パラメータ

self :	stingray.GwNavWorld	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
smartobject_id :	number	設定する SmartObject ID です。
cost_multiplier :	number	この SmartObject の関連付けられたコスト乗数です。

戻り値

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

unset_smartobject ( self, smartobject_id ) ワールドの SmartObject テーブルから SmartObject を除去することができます。

パラメータ

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

戻り値

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

smartobject_id が検出されたもののコストが設定されていない場合、smartobject_id はトラバースされません。

update ( self, delta_time ) 指定した GwNavWorld を更新します。

パラメータ

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

戻り値

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

開発のみ

このグループの要素は、開発ビルドでのみ使用可能です。

最終的なビルドでは使用しないでください。

build_database_visual_geometry ( database_or_world ) 指定した GwNavWorld のデータベースのデバッグ レンダリング リプレゼンテーションを再構築します。

パラメータ

database_or_world :

any(stingray.GwNavWorld, stingray.GwNavDatabase)

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

戻り値

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

database_tile_count ( database_or_world ) : integer 指定した GwNavWorld のデータベース ビジュアル リプレゼンテーションでのタイルの数を返します。

パラメータ

database_or_world :

any(stingray.GwNavWorld, stingray.GwNavDatabase)

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

戻り値

integer

データベース内のタイルの数です。

database_tile_triangle_count ( database_or_world, tile_index ) : integer 指定した GwNavWorld のデータベース ビジュアル リプレゼンテーションで所定のタイル内の三角形の数を返します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	使用する GwNavDatabase です。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
tile_index :	integer	三角形をカウントするタイルのインデックスです。

戻り値

integer

タイル内の三角形の数です。

database_triangle ( database_or_world, tile_index, triangle_index ) : stingray.Vector3?, stingray.Vector3?, stingray.Vector3?, stingray.Quaternion? 指定した GwNavWorld のデータベース ビジュアル リプレゼンテーションで指定したタイル内の指定した三角形、または nil を返します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	使用する GwNavDatabase です。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
tile_index :	integer	データベース内のタイルのインデックスです。
triangle_index :	integer	タイル内の三角形のインデックスです。

戻り値

stingray.Vector3?	三角形の頂点(見つかった場合)、それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
stingray.Vector3?	三角形の頂点(見つかった場合)、それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
stingray.Vector3?	三角形の頂点(見つかった場合)、それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
stingray.Quaternion?	三角形のカラー(見つかった場合)、それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

init_visual_debug_server ( self, server_port ) 指定したポートで指定した GwNavWorld のビジュアル デバッグ サーバを起動します。

パラメータ

self :	stingray.GwNavWorld	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
server_port :	number	GwNavWorld がビジュアル デバッグ サーバを作成する際に使用する必要があるポートです。

戻り値

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

set_visual_debug_camera_transform ( self, position, look_at, up ) この関数を使用してビジュアル デバッガでカメラをコントロールすることができます。

パラメータ

self :	stingray.GwNavWorld	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
position :	stingray.Vector3	カメラの目的の位置です。
look_at :	stingray.Vector3	カメラを向ける位置です。
up :	stingray.Vector3	カメラの「アップ」軸です。

戻り値

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

この方法で、ボットの POV またはその他の興味深い POV を確認することができます。

visual_debug_draw_line ( self, display_list_name, group_name, start, end, color ) NavigationLab にラインを描画します。

パラメータ

self :	stingray.GwNavWorld	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
display_list_name :	string	表示リストの名前です。
group_name :	string	表示リストが属するグループです。
start :	stingray.Vector3	ラインの開始位置です。
end :	stingray.Vector3	ラインの終了位置です。
color :	stingray.Quaternion	ラインのカラーです。

戻り値

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

visual_debug_draw_text ( self, display_list_name, group_name, text, position, color ) NavigationLab に 3D テキストを描画します。

パラメータ

self :	stingray.GwNavWorld	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
display_list_name :	string	表示リストの名前です。
group_name :	string	表示リストが属するグループです。
text :	string	描画するテキストです。
position :	stingray.Vector3	テキストの位置です。
color :	stingray.Quaternion	テキストのカラーです。

戻り値

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