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

説明

Navigation のメイン パスファインディング クエリーへのアクセスを提供します。

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

stingray.GwNavAStar.create() stingray.GwNavBot.get_astar_query()

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

	stingray.GwNavAStar.TryCanGoMode.ALWAYS_TRY stingray.GwNavAStar.TryCanGoMode.NEVER_TRY
	stingray.GwNavBot.compute_path_async() stingray.GwNavBot.get_astar_query() stingray.GwNavBot.init_astar_query() stingray.GwNavBot.inject_path()
	Gameware Navigation

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

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

列挙

stingray.GwNavAStar.TryCanGoMode AStar Try CanGo Mode

関数

cancel ( self ) 指定した GwNavAStar がまだ完了していない場合、それはキャンセルされ、計算は行われません。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

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

compute_async ( self ) GwNavAStar の非同期処理を開始し、即座に返します。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

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

compute_blocking ( self ) GwNavAStar を同期的に計算します。パスは関数が返されるとアクセスできるようになります。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

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

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

stingray.GwNavBot.init_astar_query()

create ( database_or_world ) : stingray.GwNavAStar GwNavAStar オブジェクトを作成します。

パラメータ

database_or_world :

any(stingray.GwNavWorld, stingray.GwNavDatabase)

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

戻り値

stingray.GwNavAStar

作成された GwNavAStar です。

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

パラメータ

self :

stingray.GwNavAStar

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

戻り値

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

initialize ( self, start, dest ) 指定した GwNavAStar を初期化します。

パラメータ

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

戻り値

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

is_safe_to_read_result ( self ) : boolean 指定された GwNavAStar の結果を安全に読み取ることができるかどうかを返します。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

boolean

処理が終了して AStar クエリーから結果を安全に読み取ることができる場合は true、そうでない場合は false を返します。

node_at_index ( self ) : stingray.Vector3? 指定した GwNavAStar の所定のインデックスでノードの位置を返します。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

stingray.Vector3?

指定されたインデックスが有効な場合、そのインデックスのノードの位置を返します。それ以外の場合は、nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

node_count ( self ) : number 指定した GwNavAStar のパス内のノードの数を返します。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

number

パスのノードの数です(パスが見つからなかった場合は 0)。

path_cost ( self ) : number 指定した GwNavAStar のパスのコストを返します。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

number

パスのコストです(パスが見つからなかった場合は 0)。

path_distance ( self ) : number 指定した GwNavAStar のパスの距離をメートル単位で返します。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

number

パスの距離です(パスが見つからなかった場合は 0)。

path_found ( self ) : boolean 指定した GwNavAStar がパスを見つけられたかどうかを返します。

パラメータ

self :

stingray.GwNavAStar

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

戻り値

boolean

パスが見つかった場合は true、それ以外の場合は false です。

set_channel_advanced_config ( self, turn_sampling_angle, channel_smoothing_angle, min_distance_between_gates, max_distance_between_gates ) 指定したボットのチャネルの環境設定を設定します。

パラメータ

self :	stingray.GwNavAStar	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
turn_sampling_angle :	number	曲がりがこの値より大きくなると、ファンに均等に分割されます(角度)。
channel_smoothing_angle :	number	チャネルの最大角度。オープン スペースに入る時または終了時に、参照としてパス エッジ方向とともに取得されます。範囲: [1, 89]。
min_distance_between_gates :	number	この距離は、2 つの連続したゲート間の最小距離を定義します。これらは 2 つの「曲がる部分のゲート」間を広げる際に追加されます。
max_distance_between_gates :	number	この距離は、2 つの連続したゲート間の最大距離を定義します。これらは 2 つの「曲がる部分のゲート」間を広げる際に追加されます。

戻り値

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

set_channel_radius ( self, channel_radius ) 指定したボットのチャネルの環境設定を設定します。

パラメータ

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

戻り値

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

set_channel_radius ( self, channel_radius ) 指定したボットのチャネルの環境設定を設定します。

パラメータ

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

戻り値

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

set_outside_navmesh_distance ( self, from_outside_navmesh_distance, to_outside_navmesh_distance ) from_outside_navmesh_distance と to_outside_navmesh_distance を設定します。

パラメータ

self :	stingray.GwNavAStar	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
from_outside_navmesh_distance :	number	始点が NavMesh の外側にある場合に、NavMesh に検索される X 軸および Y 軸に沿った始点からの最大距離。検索は、from_outside_navmesh_distance と等しい X 軸と Y 軸の半分の範囲で、始点の周囲の軸に位置合わせされたバウンディング ボックス内で三角形を探します。この機能を無効にするには、この値を 0 に設定します。
to_outside_navmesh_distance :	number	ターゲット点が NavMesh の外側にある場合に、NavMesh に検索される X 軸および Y 軸に沿ったターゲットからの最大距離です。検索は、to_outside_navmesh_distance と等しい X 軸と Y 軸の半分の範囲で、ターゲット点の周囲の軸に位置合わせされたバウンディング ボックス内で三角形を探します。この機能を無効にするには、この値を 0 に設定します。

戻り値

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

set_propagation_box ( self, extent ) GwNavAStar の伝播ボックス範囲を設定します。

パラメータ

self :	stingray.GwNavAStar	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
extent :	number	伝播指向の 2D ボックスの境界と [start, dest] セグメントの間の距離です。astar 伝播はボックスの外側に移動しません。

戻り値

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

set_traverse_logic_data ( self, logic_data ) GwNavTraverseLogicData を GwNavAStar に設定します。

パラメータ

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

戻り値

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