※このページは書きかけです。
解説/上級編 †
Theaterクラスインスタンス生成時、およびactメソッドの引数について †
- Theaterクラスのインスタンス生成時、およびactメソッドの引数は、第一引数にオブジェクトがひとつだけとなり、そのオブジェクトに特定の名前でプロパティを作成することで様々な指定が行えます。
- Theaterクラスのインスタンス生成時引数は、解説/基礎編#a533d944で解説したimgプロパティやscenarioプロパティが基本となりますが、他にもプロパティが指定可能です。
- actメソッドの引数も、解説/基礎編#tc2077e6で解説したimgプロパティやmsgプロパティが基本となりますが、他にもプロパティが指定可能です。
- 以下に設定可能なプロパティを示します。前半がTheaterクラスのインスタンス生成時、actメソッド共通、後半がTheaterクラスのインスタンス生成時固有のプロパティです。
Theaterクラスインスタンス生成時、actメソッド共通プロパティ †
- imgプロパティだけ意味が異なります。
- その他は、Theaterクラスインスタンス生成時の場合はシナリオ全体、actメソッドの場合はそのときのみの指定となります。
- actメソッドの指定が優先されます。
- imgプロパティ
- (Theaterクラスのインスタンス生成時)説明:先読みする画像アドレス配列を指定する。
- (actメソッド)説明:表示する画像アドレスを指定する。nullまたは指定しない場合、画像を切り替えない。「」(空文字)を指定した場合、Theaterクラスインスタンス生成時、blankプロパティに指定した画像を表示する。
- filterプロパティ
- 説明:filterによる画像切替効果を指定する。設定値については効果一覧#h2115ddc参照。デフォルトは「」(空文字=効果なし)。
- typeIntervalプロパティ
- 説明:文章タイプライト時のタイプライト間隔をミリ秒で指定する。デフォルトは100(0.1秒)。
- isAutoプロパティ
- 説明:シナリオを自動進行させたい場合にtrue、そうでない場合にfalseを指定する。デフォルトはfalse。
- playIntervalプロパティ
- 説明:シナリオ自動進行時において、文章タイプライト終了後に次のシナリオ関数実行までの間隔をミリ秒で指定する。デフォルトは1000(1秒)。
Theaterクラスインスタンス生成時固有プロパティ †
- frameIdプロパティ
- 説明:画像を表示する要素IDまたはオブジェクトを指定する。デフォルトは「frame」。
- msgIdプロパティ
- 説明:文章を表示する要素IDまたはオブジェクトを指定する。デフォルトは「msg」。
- playIdプロパティ
- 説明:クリックすることでシナリオが進行する要素のIDまたはオブジェクト指定する。デフォルトは「play」。
- resetIdプロパティ
- 説明:クリック時にシナリオを最初に戻す要素IDまたはオブジェクトを指定する。デフォルトは「reset」。
- nameプロパティ
- 説明:同一ページに複数Theaterクラスインスタンスを生成する場合に、競合を防ぐために指定する。デフォルトは「Theater」。
- curtainプロパティ
- 説明:シナリオ開始前にあらかじめ表示しておく画像のアドレスを指定する。デフォルトはnullで、この場合、なにも表示されない。
- blankプロパティ
- 説明:シナリオで画像アドレス指定が「」(空文字)の際に表示する画像のアドレスを指定する。デフォルトはtheater.js等と同じフォルダ内のblank.gif(800×600の透明画像)のアドレス。
※このページは書きかけです。