JS Adventure バージョン2.0 リファレンス(……作成中)
アドベンチャーやノベルゲームを製作できるJavaScriptライブラリJS Adventure バージョン2.0のリファレンスを作りました。まだ完成してませんが、メソッド等を逐次載せていく予定です。
JavaScriptファイル JS Adventure ver 2.1
CSSファイル JS Adventure ver 1.0
目次
リファレンス
メソッド名はコード内に直に書くときと、JSONオブジェクト形式で書くときと微妙に違い紛らわしいため、メソッド名はJSON用の名称に続いてカッコで直接記述用の名称を並べるようにしています。
initVars (initVars) | ||
機能 | ゲーム内変数の初期化メソッド。用途としてはプレイヤーの入力した名前やクイズの回答数などゲーム中に使われる データを格納する。パラメーターはオブジェクト形式。gameVars、systemVars、templateの三つのプロパティを持つ。 ただし、プロパティは必要なものだけ設定すればよい。gameVarsに変数を設定すると、画面上のテキストなどに任意で反映させられる。 | |
パラメーター | (1)ゲームデータのオブジェクト。 | |
オプション 詳細 |
なし | |
記述コード例 | 直接記述 | |
オブジェクト | ||
備考 | ゲーム内変数には上の例のように返り値を持つ関数を設定することができる。ただし、そのままでは利用できないため、 Prototype.jsでうまく処理されるようにtoTemplateReplacementsメソッドというのを設定しなければならない。また、メッセージなどのテキスト内容に 変数の値を反映させたいとき、その箇所に#{変数名}の形式で記述しておくと、実行時にリアルタイムの値に替えてくれる。 |
createSimpleText (createSimpleText) | |||
機能 | テキスト表示用メソッド。テキスト内容をラップしたDIV要素を返す。このメソッドはテキスト要素を作成するだけなので単体では何も表示されない。 | ||
パラメーター |
(1)テキスト内容。 (2)テキスト要素の識別ID、省略すると"text***"というIDを自動作成する。 (3)オプション。 |
||
オプション 詳細 |
loc | 画面上に表示する座標。[x, y]の配列形式で。 | |
style | スタイル形式。script.aculo.usのMorphエフェクトと同じ形式で、クラス名かインラインのスタイル定義かCSSプロパティのハッシュで指定可。 | ||
shadow | shadowプロパティをtrueにするとブラウザ依存だが影付き文字に変換できる。 | ||
outline | outlineプロパティをtrueにすると、これもブラウザに依存するが白抜き文字に変換できる。 | ||
temp | テンプレートを使用するときに使う。テンプレート・オブジェクトの“name”プロパティか、もしくはゲーム変数を使うときは“gameVars”と設定する。 | ||
記述コード例 | 直接記述 | ||
オブジェクト | |||
備考 | 特になし |
dispSimpleText (dispSimpleText) | |||
機能 | createSimpleTextで登録したテキスト要素を表示する。 | ||
パラメーター | (1)テキストID。 | ||
オプション 詳細 |
effect | フェードなどのエフェクトをかけたいときは、エフェクト名をこのプロパティに指定する。ただし、使用するのがAppearエフェクトならtrueを渡すだけでよい。 | |
effectOpt | effectプロパティで指定したエフェクトのオプションを個別に設定したい場合はこのプロパティにオブジェクト形式で設定する。 | ||
記述コード例 | 直接記述 | ||
オブジェクト | |||
備考 | 表示後クリック待ちにするためwaitUntilClickメソッドと共に用いることが多い。 |
typeSimpleText (typeSimpleText) | ||
機能 | createSimpleTextで登録したテキスト要素をタイプ表示する。 | |
パラメーター | (1)テキストID。 | |
オプション 詳細 |
なし | |
記述コード例 | 直接記述 | |
オブジェクト | ||
備考 | 表示後クリック待ちにするためwaitUntilClickメソッドと共に用いることが多い。 |
animateText (animateSimpleText) | ||
機能 | createSimpleTextで登録したテキスト要素をアニメーションさせる。 | |
パラメーター |
(1)テキストID(Parrallelエフェクト使用なら、エフェクト関数またはインスタンスの配列)。 (2)エフェクト詳細。配列にして渡す。第1要素にscriptaculousのエフェクト名。第2要素は基本的にオプションを指定するが、 Scale、Parallel、Tweenのように必須引数が必要だったり、引数の不規則な渡し方が必要なエフェクトは、 求められる順番に各パラメーターを配列に入れていく。 |
|
オプション 詳細 |
なし | |
記述コード例 | 直接記述 | |
オブジェクト | ||
備考 | このメソッドだけではテキストが表示されないので注意。事前にテキスト要素を表示するか、Appearエフェクト等を使用する必要がある。 |
hideSimpleText (hideSimpleText) | |||
機能 | createSimpleTextで登録したテキスト要素を隠す。 | ||
パラメーター | (1)テキストID。 | ||
オプション 詳細 |
effect | フェードなどのエフェクトをかけたいときは、エフェクト名をこのプロパティに指定する。ただし、使用するのがFadeエフェクトならtrueを渡すだけでよい。 | |
effectOpt | effectプロパティで指定したエフェクトのオプションを個別に設定したい場合はこのプロパティにオブジェクト形式で設定する。 | ||
記述コード例 | 直接記述 | ||
オブジェクト | |||
備考 | 表示後クリック待ちにするためwaitUntilClickメソッドと共に用いることが多い。 |
showDialog (showDialog) | |||
機能 | ダイアログウィンドウを表示する。 | ||
パラメーター | (1)ダイアログのメッセージ内容 | ||
オプション 詳細 |
type | ダイアログの種類を指定する。alertはメッセージのみ表示するので、通常のアラートの代わりに使える。 inputにすると入力ダイアログを表示する。何も指定しないとデフォルトでalertになる。 | |
initValue | 入力ダイアログで初期値を設定したい場合はinitValueに値を入れる。 | ||
enableCancel | キャンセルボタンも表示させたいときは、enableCancelをtrueにする。キャンセルボタンが押されると、 insertDialogResultメソッドで入力内容が評価された際falseが代入される。 | ||
temp | テンプレートを使用するときに使う。テンプレート・オブジェクトの“name”プロパティか、もしくはゲーム変数を使うときは“gameVars”と設定する。 | ||
記述コード例 | 直接記述 | ||
オブジェクト | |||
備考 | 押されたボタンや入力テキストを評価するにはinsertResult(insertDialogResult)メソッドを使う。 |