Replay - stingray.Replay オブジェクト リファレンス - Stingray Lua API リファレンス
説明
Replay オブジェクトを使用して、ゲーム ワールド内で発生したイベントを再生することができます。
既定では、移動するすべてのユニットの位置が Replay オブジェクトに記録され、record_debug_line()、record_screen_debug_text()、および record_world_debug_text() 関数を使用するとデバッグ ラインとデバッグ テキストも記録されます。再生を実行すると、記録されたユニットが記録された位置へ自動的に移動し、記録されたデバッグ ラインとデバッグ テキストが描画されます。
Replay クラスの主な用途は AI およびスクリプト関連タスクのデバッグです。ゲーム内で何らかの問題が発生した場合は、再生システムを使用してゲームを一時停止し、時間を巻き戻してデバッグ テキストとデバッグ ラインを確認し、AI がなぜそのような判断を下したのかを確認できます。
再生システムのデータは環状バッファまたはリング バッファに記録されます。PC 上で確保されるこのバッファのサイズは既定で 50 MB に設定されます。メモリに余裕のないプラットフォームでは 1 MB に設定されます。どのくらい時間を巻き戻せるかは、このバッファのサイズとバッファに記録されているユニットの数により決定されます。
再生システムは開発モードでのみ使用でき、Application.ENABLE_REPLAY フラグ付きで作成された World でのみ使用できます。再生が有効になっているワールドでは、World.replay () を呼び出すことで再生コントローラにアクセスできます。
再生を実行すると、ワールド内のユニットが記録された位置に移動します。再生システムへの干渉を防ぐため、再生中はユニットを意図的に動かさないようにする必要があります。
注: 再生システムは開発中の機能であり、将来のバージョンで API が変更される可能性があります。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
frame ( self ) : integer 現在の再生フレームを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
現在再生中のフレームを返します。 |
| |
is_playing_back ( self ) : boolean現在、再生システムが再生モードであるかどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
boolean |
現在、再生システムが再生モードである場合は true を返し、記録中である場合は false を返します。 |
| |
num_frames ( self ) : integer再生システムによって記録されたデータのフレーム数を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
記録されたフレームの数を返します。 |
| |
record_debug_line ( self, color, p1, p2 )ポイント p1 から ポイント p2 の間で、指定された色を使用して描画されるデバッグ ラインを記録します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
color : | ラインのカラーです。 | |
p1 : | ラインの開始ポイントを指定します。 | |
p2 : | ラインの終了ポイントを指定します。 |
| この関数は値を返しません。 |
記録されたデバッグ ラインは再生時にのみ描画されます。
| |
record_screen_debug_text ( self, color, position, text )画面スペース内の指定された位置に指定された色を使用して描画されるデバッグ テキストを記録します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
color : | テキストの色です。 | |
position : | テキストを描画する位置を画面スペース内の 2D 座標で指定します。 | |
text : | string | 描画するテキストを指定します。 |
| この関数は値を返しません。 |
テキストは再生時にのみ描画されます。
| |
record_world_debug_text ( self, color, position, text )ワールド空間内の指定された位置に指定された色を使用して描画されるデバッグ テキストを記録します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
color : | テキストの色です。 | |
position : | テキストを描画する位置をワールド内の座標で指定します。 | |
text : | string | 描画するテキストを指定します。 |
| この関数は値を返しません。 |
テキストは再生時にのみ描画されます。
| |
set_frame ( self, frame )現在の再生フレームを設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
frame : | integer | 再生するフレームを返します。 |
| この関数は値を返しません。 |
| |
set_unit_record_mode ( self, unit, mode )指定されたユニットのデータを記録する方法を制御します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
unit : | データを記録するユニットを指定します。 | |
mode : | integer | 記録モードを指定します。任意の[記録モード]値を使用できます。 |
| この関数は値を返しません。 |
再生バッファのメモリ使用量を節約するため、既定では、移動するユニットのルート位置のみが再生システムで記録されます。
その他の関連リファレンス項目
| |
start_playback ( self )記録されたデータの再生を開始します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
記録された最初のフレームから再生を開始します。
| |
stop_playback ( self )再生を終了して記録モードに戻ります。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
記録モード
set_unit_record_mode () を呼び出すときにこのグループの定数を渡すと、特定のユニットに対して使用する再生システムの記録モードを設定できます。
| |
RECORD_MODE_DISABLED : integer ユニットの記録を無効にします。
|
データは保存されません。
| |
RECORD_MODE_SCENE_GRAPH : integerユニットのシーン グラフ内にある全ノードのトランスフォームを記録します。
|
したがって、ユニットのアニメーション全体が記録されます。
| |
RECORD_MODE_TRANSFORM : integerユニットのルート ノードのトランスフォーム(位置と回転)のみを記録します。
|
これが既定の記録モードです。