サウンド関数

関数一覧

PlayBgm	ＢＧＭを再生する
StopBgm	ＢＧＭを停止する
StoreBgm	ＢＧＭの状態を保存する
RestoreBgm	ＢＧＭの状態を復元する
PlaySe	効果音を再生する
StopSe	効果音を停止する
PlayVoice	ボイスを再生する
AutoVoice	自動音声を設定する
AutoVoiceAlias	自動音声のエイリアス(別名)を設定する
RemoveAutoVoice	自動音声の設定を削除する
ClearAutoVoice	自動音声の設定をクリアする

その他

RpgPlayBgm	ＲＰＧマップのＢＧＭの再生と設定を行う

関数詳細

PlayBgm()

機能

ＢＧＭを再生する

書式

void PlayBgm( path, fadeTime, volume )

引数

引数	型	省略	規定値	詳細
path	文字列	×	―	ファイルのパス
fadeTime	実数	◯	0.25	フェードアウト時間 (秒)
volume	実数	◯	1.0	音量 (0.0～1.0)

戻り値

なし

備考

fadeTime 引数は既にＢＧＭが再生中だった場合に使用される。再生中のＢＧＭは fadeTime に指定した秒数でフェードアウトし、その後、path で指定したＢＧＭが再生される

StopBgm()

機能

ＢＧＭを停止する

書式

void StopBgm( fadeTime )

引数

引数	型	省略	規定値	詳細
fadeTime	実数	◯	0.25	フェードアウト時間 (秒)

戻り値

なし

StoreBgm()

機能: ＢＧＭの状態を保存する
書式: void StoreBgm()
引数: なし
戻り値: なし

RestoreBgm()

機能

ＢＧＭを StoreBgm() を呼出したときの状態に復元する

書式

void RestoreBgm( fadeTime )

引数

引数	型	省略	規定値	詳細
fadeTime	実数	◯	0.25	フェードアウト時間 (秒)

戻り値

なし

PlaySe()

機能

効果音を再生する

書式

int PlaySe( path, loop, volume, pan, pitch, delay )

引数

引数	型	省略	規定値	詳細
path	文字列	×	―	ファイルのパス
loop	真偽値	◯	false	ループフラグ
volume	実数	◯	1.0	音量 (0.0～1.0)
pan	実数	◯	0.0	パン (-1.0～1.0)
pitch	実数	◯	1.0	ピッチ
delay	実数	◯	0.0	ディレイ時間 (秒)

戻り値

再生に使用されたトラックのインデックス。再生されなかった場合は -1 を返す

StopSe()

機能

効果音を停止する

書式

void StopSe( track )

引数

引数	型	省略	規定値	詳細
track	整数	×	―	トラックのインデックス

戻り値

なし

PlayVoice()

機能

ボイスを再生する

書式

void PlayVoice( path, volume, pan, delay )

引数

引数	型	省略	規定値	詳細
path	文字列	×	―	ファイルのパス
volume	実数	◯	1.0	音量 (0.0～1.0)
pan	実数	◯	0.0	パン (-1.0～1.0)
delay	実数	◯	0.0	ディレイ時間 (秒)

戻り値

なし

AutoVoice()

機能

自動音声を設定します

書式

void AutoVoice( charaName, basePath, voiceNo )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名
basePath	文字列	×	―	音声ファイルのベースパス
voiceNo	整数	◯	0	開始番号

戻り値

なし

AutoVoiceAlias()

機能

自動音声のエイリアス(別名)を設定します。この関数を使用する前に AutoVoice() 関数で基本設定を行う必用があります

書式

void AutoVoiceAlias( charaName, aliasName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	AutoVoice() で設定したキャラクター名
aliasName	文字列	×	―	キャラクターの別名

戻り値

なし

RemoveAutoVoice()

機能

AutoVoice()、AutoVoiceAlias() で追加した自動音声の設定を削除します

書式

void RemoveAutoVoice( charaName )

引数

引数	型	省略	規定値	詳細
charaName	文字列	×	―	キャラクター名、又は、キャラクターの別名

戻り値

なし

ClearAutoVoice()

機能: 自動音声の設定をクリアします
書式: void ClearAutoVoice()
引数: なし
戻り値: なし