stingray.GwNavQueries ネームスペース リファレンス

説明

NavMesh (レイキャストなど)で実行できるさまざまな操作へのアクセスを提供します。

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

Gameware Navigation

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

「ゲームプレイを作成する > AI とパスファインディング > Navigation のクエリー」

関数

destroy_query_dynamic_output ( query_output ) クエリーによって作成された GwNavQueryDynamicOutput を破壊します。

パラメータ

query_output :

stingray.GwNavQueryDynamicOutput

破壊する GwNavQueryDynamicOutput オブジェクトです。

戻り値

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

NavQueryDynamicOutput からアクセスされたすべてのオブジェクトは、destroy_query_dynamic_output が呼び出されると破壊される可能性があることに注意してください

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

stingray.GwNavQueries.tag_volumes_from_position()

diskcango ( database_or_world, A, B, radius, logic ) : boolean ディスクを NavMesh サーフェスに沿って A から B までキャストします。ディスクが正常に B に到達した場合は true、それ以外の場合は false を返します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
A :	stingray.Vector3	開始する中心位置です。
B :	stingray.Vector3	キャストが終了する中心位置です。
radius :	number	ディスクの半径です。
logic :	stingray.GwNavTraverseLogicData?	このクエリーで使用する GwNavTraverseLogicData です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

boolean

ディスクが正常に到達する場合は true です。

diskcast ( database_or_world, A, radius, normalized_move_2d, distance, logic ) : boolean, stingray.Vector3, stingray.Vector3 ディスクを NavMesh サーフェスに沿って A から normalized_move_2d 方向に指定された距離だけキャストします。ディスクが距離全体を正常に移動すると true、それ以外の場合は false を返します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
A :	stingray.Vector3	開始する中心位置です。
radius :	number	ディスクの半径です。
normalized_move_2d :	stingray.Vector2	ディスクをキャストする方向です。
distance :	number	キャストの距離です。
logic :	stingray.GwNavTraverseLogicData?	このクエリーで使用する GwNavTraverseLogicData です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

boolean	ディスクが指定された距離を正常に移動した場合は true です。
stingray.Vector3	キャストが終了したときのディスクの中心位置です。
stingray.Vector3	ディスクが衝突した場合は、ディスクの衝突位置です。

最後の有効な中心位置、および衝突位置(ある場合)も返します。

inside_position_from_outside_position ( database_or_world, position, above_dist, below_dist, horizontal_dist, distance_from_obstacle, logic ) : stingray.Vector3? 外側の位置から NavMesh 内の位置を検索します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
position :	stingray.Vector3	NavMesh の外側の位置です。
above_dist :	number?	検索する位置の上の距離です(メートル単位)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
below_dist :	number?	検索する位置の下の距離です(メートル単位)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
horizontal_dist :	number?	検索する位置から水平の距離です(メートル単位)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
distance_from_obstacle :	number?	Navmesh の境界からポイントを移動する距離です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
logic :	stingray.GwNavTraverseLogicData?	このクエリーで使用する GwNavTraverseLogicData です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.Vector3?

NavMesh 内で位置が見つからなかった場合は nil です。それ以外の場合は、その位置自体です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

move_on_navmesh ( database_or_world, position, velocity, delta_time, logic ) : stingray.Vector3 NavMesh 上に安全に配置された有効な位置を出力します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
position :	stingray.Vector3	開始元となる位置です。
velocity :	stingray.Vector3	移動する速度です。
delta_time :	number	最後のフレームからのデルタ時間です(秒単位)。
logic :	stingray.GwNavTraverseLogicData?	このクエリーで使用する GwNavTraverseLogicData です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.Vector3

NavMesh 上の位置です。

位置が見つからない場合は、入力位置が返されます。通常は、物理的要素のないものを移動する場合に役立ちます。

nav_tag_volume ( query_output, index ) : stingray.GwNavTagVolume 指定されたインデックスを持つ GwNavTagVolume を取得します。

パラメータ

query_output :	stingray.GwNavQueryDynamicOutput	TagVolume を取得する対象の GwNavQueryDynamicOutput オブジェクト。
index :	integer	取得する TagVolume のインデックスです。

戻り値

stingray.GwNavTagVolume

指定されたインデックスを持つ TagVolume です。

この GwNavTagVolume は、NavQueryDynamicOutput.destroy()が呼び出されると破壊される可能性があることに注意してください。

nav_tag_volume_count ( query_output ) : integer クエリーによって返される TagVolume の数を指定します。

パラメータ

query_output :

stingray.GwNavQueryDynamicOutput

TagVolumes をテストする対象の GwNavQueryDynamicOutput オブジェクトです。

戻り値

integer

クエリーで見つかった TagVolumes の数です。

raycango ( database_or_world, A, B, logic ) : boolean レイを NavMesh サーフェスに沿って A から B までキャストします。レイが正常に B に到達した場合は true、それ以外の場合は false を返します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
A :	stingray.Vector3	開始元となる位置です。
B :	stingray.Vector3	キャストが終了する位置です。
logic :	stingray.GwNavTraverseLogicData?	このクエリーで使用する GwNavTraverseLogicData です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

boolean

レイが正常に到達する場合は true です。

raycast ( database_or_world, A, move_2d, logic ) : boolean, stingray.Vector3 レイを NavMesh サーフェスに沿って A から move_2d の方向と距離だけキャストします。レイが move_2d の距離全体を正常に移動した場合は true、それ以外の場合は false を返します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
A :	stingray.Vector3	レイの放射元となる位置です。
move_2d :	stingray.Vector2	投影する 2D の相対的な移動です。
logic :	stingray.GwNavTraverseLogicData?	このクエリーで使用する GwNavTraverseLogicData です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

boolean	レイが指定された距離を正常に移動した場合は true です。
stingray.Vector3	レイに沿ったヒットした位置です(ヒットしなかった場合は終点)。

レイに沿った最後の有効位置も返します。

raycast_full_3d ( database_or_world, A, B ) : boolean, stingray.Vector3 (NavMesh サーフェス上ではなく) 3d で A から B までレイをキャストします。レイが正常に B に到達した場合は true、それ以外の場合は false を返します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
A :	stingray.Vector3	レイの放射元となる位置です。
B :	stingray.Vector3	レイの放射先となる位置です。

戻り値

boolean	レイが正常に b に到達した場合は true です。
stingray.Vector3	レイに沿ったヒットした位置です(ヒットしなかった場合は終点)。

レイに沿った最後の有効位置も返します。

tag_volumes_from_position ( database_or_world, position, above, below ) : stingray.GwNavQueryDynamicOutput? NavMesh 内の位置から TagVolumes を検索します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
position :	stingray.Vector3	NavMesh の外側の位置です。
above :	number?	検索する位置の上の限度です(メートル単位)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
below :	number?	検索する位置の下の限度です(メートル単位)。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.GwNavQueryDynamicOutput?

nil、またはstingray.GwNavQueries.destroy_query_dynamic_output を使用してユーザが破壊する必要がある TagVolume が少なくとも 1 つある場合は、新しく作成された GwNavQueryDynamicOutput ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

triangle_from_position ( database_or_world, position, above, below ) : number?, stingray.Vector3?, stingray.Vector3?, stingray.Vector3? NavMesh 内の指定された位置で三角形を検索します。

パラメータ

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	クエリーを実行する GwNavDatabase。GwNavWorld の場合、既定の GwNavDatabase が使用されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
position :	stingray.Vector3	検索する位置です。
above :	number	検索する位置の上の限度です(メートル単位)。
below :	number	検索する位置の下の限度です(メートル単位)。

戻り値

number?	三角形が見つかった場合、これは三角形のプレーンへの入力位置の投影の高度を示します。それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
stingray.Vector3?	三角形が見つかった場合は、三角形の最初の頂点を示します。それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
stingray.Vector3?	三角形が見つかった場合は、三角形の 2 番目の頂点を示します。それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
stingray.Vector3?	三角形が見つかった場合は、三角形の 3 番目の頂点を示します。それ以外の場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。