新規
編集
添付メソッド
kag.bgm.play(elm)
- 機能
- playbgmタグに相当するメソッド。BGMを再生する
- 引数
- elm…辞書配列オブジェクト。当メソッドはキーstorage、loopの値を参照する
- 戻り値
- なし
kag.bgm.setOptions(elm)
- 機能
- bgmoptタグに相当するメソッド。BGMを設定する
- 引数
- elm…辞書配列オブジェクト。当メソッドはキーvolume、gvolumeの値を参照する
- 戻り値
- なし
- 備考
- 厳密にはelmのキーdeviceも参照するが、使われていない
kag.bgm.stop()
- 機能
- stopbgmタグに相当するメソッド。BGMの再生を停止する
- 引数
- なし
- 戻り値
- なし
kag.movies[n].setOptions(elm)
- 機能
- videoタグに相当するメソッド。ムービーオブジェクト n を設定する
- 引数
- elm…辞書配列オブジェクト。当メソッドはキーvisible、left、top、width、height、loop、position、frame、mode、playrate、volume、pan、audiostreamnumの値を参照する
- 戻り値
- なし
kag.se[n].play(elm, resetvolume = true)
- 機能
- playseタグに相当するメソッド。効果音バッファ n で効果音を再生する
- 引数
- elm…辞書配列オブジェクト。当メソッドはキーstorage、loopの値を参照する
resetvolume…音量をリセットする場合はtrue、そうでない場合はfalseを指定すること。省略時true - 戻り値
- なし
ハイパーリンク、グラフィカルボタン、クリッカブルマップなどで、利用する機会が多いメソッド。
; グラフィカルボタンがクリックされた時、効果音バッファ２で"click.wav"を再生 [button graphic="next.png" target=*next exp="kag.se[2].play(%['storage'=>'click.wav'])"]
kag.se[n].setOptions(elm)
- 機能
- seoptタグに相当するメソッド。効果音バッファ n を設定する
- 引数
- elm…辞書配列オブジェクト。当メソッドはキーvolume、gvolume、panの値を参照する
- 戻り値
- なし
プロパティ
kag.bgm.currentBuffer.status
- ゲッター
- BGMの現在の状態を文字列で返す…"unload"：メディアを開いていない／"play"：メディアを再生中／"stop"：メディアを停止中
- セッター
- なし
kag.bgm.currentBuffer.volume
- ゲッター
- BGMの音量（0～100000）を返す
- セッター
- BGMの音量を設定する
- 備考
- ‐％に換算する場合は1000で割ること
‐この値を変更する場合は、bgmoptタグまたはkag.bgm.setOptions()を介した方が無難
‐内部的にはシステム変数に記録されている
kag.bgm.currentBuffer.volume2
- ゲッター
- BGMの大域音量（0～100000）を返す
- セッター
- BGMの大域音量を設定する
- 備考
- ‐％に換算する場合は1000で割ること
‐この値を変更する場合は、bgmoptタグまたはkag.bgm.setOptions()を介した方が無難
‐内部的にはシステム変数に記録されている
kag.movies[n].audioVolume
- ゲッター
- ムービーオブジェクト番号 n のムービーの音量（0～100000）を返す
- セッター
- ムービーオブジェクト番号 n のムービーの音量を設定する
- 備考
- ‐％に換算する場合は1000で割ること
‐この値を変更する場合は、videoタグまたはkag.movies[n].setOptions()を介した方が無難
‐内部的にはシステム変数に記録されている
‐ムービーに大域音量はない（音量のみ）
kag.se[n].volume
- ゲッター
- 効果音バッファ n の音量（0～100000）を返す
- セッター
- 効果音バッファ n の音量を設定する
- 備考
- ‐％に換算する場合は1000で割ること
‐この値を変更する場合は、seoptタグまたはkag.se[n].setOptions()を介した方が無難
‐内部的にはシステム変数に記録されている
kag.se[n].volume2
- ゲッター
- 効果音バッファ n の大域音量（0～100000）を返す
- セッター
- 効果音バッファ n の大域音量を設定する
- 備考
- ‐％に換算する場合は1000で割ること
‐この値を変更する場合は、seoptタグまたはkag.se[n].setOptions()を介した方が無難
‐内部的にはシステム変数に記録されている
メンバ変数
kag.bgm.playingStorage
再生中のストレージ名。
再生が完了すると空文字になる。
kag.numMovies
ムービーオブジェクトの数。
Config.tjsのnumMoviesと同じ。
kag.numSEBuffers
効果音バッファの数。
Config.tjsのnumSEBuffersと同じ。
補足
kag.bgm.currentBufferとkag.bgm.buf1の違いに関して
個人的には、BGMの大域音量を調べるのにkag.bgm.currentBuffer.volume2を好んで使っているが、gvolume.ksなどではkag.bgm.buf1.volume2が使われている。
Config.tjsのdoubleBufferedがfalseなら両者は同じ意味だが、trueならkag.bgm.currentBuffer.volume2はkag.bgm.buf2.volume2の別名（エイリアス）になっている場合がある。
微妙に違うので注意。
音量（kag.bgm.currentBuffer.volumeとkag.bgm.buf1.volume）に関しても同じことが言える。
