Lua Script API: 音楽用関数 - Oren-LuckyJackpots/FNF-PsychEngine-JP GitHub Wiki

サウンド/音楽の開始

playMusic(sound:String, volume:Float = 1, loop:Bool = false)

  • sound - ファイル名 (mods/music/ または assets/music/ にある必要がある)
  • volume - オプションの値で、音量のパーセントは 0 から 1 である。デフォルト値: 1
  • loop - オプション値、音楽を無期限にループさせるかどうか。デフォルト値: false.

playSound(sound:String, volume:Float = 1, ?tag:String)

  • sound - ファイル名 (mods/sounds/ または assets/sounds/ にある必要がある)
  • volume - オプション値、音量のパーセントは 0 から 1 である。デフォルト値: 1

OPTIONAL: tag - 一時停止、再開、時間の変更、ボリュームの変更、サウンドのフェードイン/アウトを行いたい場合のみ使用する。

サウンド/音楽の制御

stopSound

この関数はサウンドを停止し、永久に削除します!

  • tag - サウンドタグ

pauseSound

  • tag - サウンドタグ

サウンドを再開する

  • tag - サウンドタグ

playSound('confirmMenu',0.5)を使用すると、メニューの "Accept" サウンドを50%の音量で再生します。

フェードイン/フェードアウト

soundFadeIn(tag:String, duration:Float, fromValue:Float = 0, toValue:Float = 1)

  • tag - 代わりにBGMをフェードインさせたい場合は、このフィールドを空にしておく。
  • duration - 音量が fromValue から toValue に移動する時間。
  • fromValue - 開始値。デフォルト値は 0
  • toValue - 終了値。デフォルト値は 1

soundFadeOut(tag:String, duration:Float, toValue:Float = 0).

  • tag - サウンドタグ。

soundFadeOut(tag:String, duration:Float, toValue:Float = 0)

  • tag - 代わりにBGMをフェードアウトさせたい場合は、このフィールドを空にしておく。
  • duration - 音量が開始音量から toValue になるまでの時間。
  • toValue - 終了値。デフォルト値は0

soundFadeCancel(tag:String)

  • tag - 代わりにBGMのフェードイン/アウトをキャンセルしたい場合は、このフィールドは空のままにする。

ゲッター/セッター

getSoundVolume(tag:String)

  • tag - サウンドタグ、BGMの音量を取得したい場合は空欄にする。

setSoundVolume(tag:String, value:Float) * tag - サウンドタグ。

  • tag - 代わりにBGMの音量を変更したい場合は、このフィールドは空にしておく。
  • value - 0から1まで。

getSoundTime(tag:String)

現在のサウンドの位置をミリ秒単位で取得する。

  • tag - サウンドタグ

setSoundTime(tag:String, value:Float) - 現在のサウンドの位置をミリ秒単位で設定する。

現在のサウンドの位置をミリ秒単位で設定する。

  • tag - サウンドタグ
  • value - 新しい位置

注: 値 5000 = 5 秒