StoryTeller - stingray.StoryTeller オブジェクト リファレンス - Stingray Lua API リファレンス
説明
ストーリー(カットシーン)を再生できるクラスです。
各ゲーム ワールドでは独自の StoryTeller オブジェクトが保持され、World.storyteller() を呼び出すことによりこのオブジェクトを取得できます。
ストーリーは Lua StoryTeller オブジェクトからだけでなく、フローからも再生できます。
コンストラクタとアクセサ 
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
関数
 |
end_time ( self, id ) : number 指定された ID を持つストーリーの再生におけるグローバル終了時間を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | 終了時間を取得するストーリーの ID です。 |
number |
ストーリーのグローバル終了時間です。 |
| |
is_playing ( self, id ) : boolean指定されたストーリーの再生が進行中かどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | チェックするストーリーの ID を指定します。 |
boolean |
ストーリーの再生が進行中の場合は true を返し、そうでない場合は false を返します。 |
| |
length ( self, id ) : number指定されたストーリーの長さを取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | ストーリーの ID を指定します。 |
number |
ストーリーの長さを返します。 |
| |
play_level_story ( self, level, name ) : integer指定されたレベルから指定されたストーリーの再生を開始します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
level : | 再生するストーリーを含むレベルを指定します。 | |
name : | string | 再生するストーリーの名前を指定します。 |
integer |
ストーリー再生を制御するための ID を返します。 |
| |
set_loop_mode ( self, id, mode )ストーリーの最後に達したときに行う処理、またはループ範囲の終わりを決定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | ストーリーの ID を指定します。 |
mode : | integer | ストーリーに設定する新しいループ モードを指定します。任意のループ モード値を指定できます。 |
| この関数は値を返しません。 |
既定では、ストーリーの全範囲がループされます。
| |
set_loop_range ( self, id, start, stop )ストーリー内でループする範囲を指定する開始時間と停止時間を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | 設定を行うストーリーの ID を指定します。 |
start : | integer | 新しいループ範囲の開始時間を指定します。 |
stop : | integer | 新しいループ範囲の終了時間を指定します。 |
| この関数は値を返しません。 |
| |
set_speed ( self, id, speed )ストーリーの再生速度を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | 速度を設定するストーリーの ID を指定します。 |
speed : | number | ストーリーの再生速度を標準速度の乗数で指定します。 |
| この関数は値を返しません。 |
既定値は 1.0 で、ストーリーは標準速度で再生されます。この値を 0.5 に設定すると、半分の速度でストーリーが再生されます。
完全に手動制御でストーリー内の時間を先に進める場合は、速度を 0.0 に設定し、set_time() を使用してストーリー内の時間を手動で先に進めます。
| |
set_time ( self, id, time )指定された ID を持つストーリーの再生における現在の時間を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | 時間を設定するストーリーの ID を指定します。 |
time : | number | ストーリー内の新しい時間を指定します。 |
| この関数は値を返しません。 |
その他の関連リファレンス項目
| |
start_time ( self, id ) : number指定された ID を持つストーリーの再生におけるグローバル開始時間を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | 開始時間を取得するストーリーの ID です。 |
number |
ストーリーのグローバル開始時間です。 |
| |
stop ( self, id )指定されたストーリーの再生を停止します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | 停止するストーリーの ID を指定します。 |
| この関数は値を返しません。 |
| |
time ( self, id ) : number指定された ID を持つストーリーの再生における現在の経過時間を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | 時間を取得するストーリーの ID を指定します。 |
number |
ストーリー内の現在の時間を返します。 |
ループ モード
このグループの定数は、StoryTeller がストーリーの最後またはループ範囲の終わりに達したときに行う処理を示します。
| |
LOOP : integer ストーリーの最後に到達すると、最初にループして再生を続行します。
|
これは既定のモードです。
| |
NONE : integerストーリーの最後に到達すると、再生が停止します。
|
最初にはループしません。
 |
PING_PONG : integerストーリーの最後に到達すると、ストーリーを逆方向に再生し、最初に到達すると再び通常の方向で再生します。
|