【教程】LuaEngine开发教程(九) - 音频模组的使用

请注意:LuaEngineAudio需要LuaEngine1.2.0以上版本才能使用。

介绍

在LuaEngine1.2.0版本中新增了加载额外模组的接口,本篇教程我们来教大家使用同步开发的LuaEngineAudio模组。LuaEngineAudio(下文统称luaeau)可以实现加载wav或ogg格式的音频文件并控制播放,我们可以在lua中使用代码控制自定义播放一些我们想要的音效。

luaeau的安装方法非常简单,luae1.2.0版本默认已经安装了luaeau,如果你安装的是luae精简版本,你可以手动将LuaEngineAudio.dll复制到Monster Hunter World\nativePC\plugins文件夹在。

功能介绍

luaeau包含了以下功能,你可以使用这些功能控制音频的加载,播放,进度条件,音量调节等。

loadAudio 加载音频文件

loadAudio(string name, string file)

你可以使用这个函数加载音频文件到luaeau模组当中,文件加载后将被模组占用,直到你卸载文件为止。

第一个参数是音频名称,这个名称可以随意起,但是要注意,后续对音频的操作都根据这个名称进行,名称是全脚本共享的,为避免与其他脚本冲突,建议在命名时添加自己脚本特色的名称。

第二个参数是文件的路径,以怪猎根目录为相对目录开始,如果你想加载Monster Hunter World\nativePC\test.wav,你可以使用以下代码

loadAudio('test','nativePC/test.wav')

目前只能加载wav和ogg格式的音频文件,如果你的音频文件是其他格式的,请先进行转码后再使用。

同一个音频命名只能被加载一次,如果需要重新加载需要先卸载后才能使用,你可以使用deleteAudio函数卸载音频。

此函数运行后会返回一个布尔值,true则为加载成功,false则为加载失败,如果加载失败,模组会在前置的命令窗口中发布一个error等级的消息提示错误原因。

playAudio 播放音频

playAudio(string name)

你可以使用这个函数播放已经加载的音频,当音频已经处于播放状态时,重复执行将会重头播放音频。

如果音频还未加载或出现其他播放异常情况,函数将返回false并向前置的命令窗口发送错误信息

当音频成功播放后,将返回true

pauseAudio 暂停音频播放

pauseAudio(string name)

你可以使用这个函数暂停正在播放的音频,函数返回布尔值表示是否暂停成功

resumeAudio 继续音频播放

resumeAudio(string name)

你可以使用这个函数继续播放被暂停的音频,函数返回布尔值表示是否继续播放成功

seekAudio 控制播放进度

seekAudio(string name, number position)

你可以使用这个函数控制当前播放进度

参数position为播放的进度值,你可以通过getAudioSize获取音频的最大进度

setVolume 控制播放音量

setVolume(string name, number volume)

你可以使用这个函数控制当前播放的音量

参数volume的取值为0-128

getCurrentPosition 获取当前播放进度

getCurrentPosition(string name)

你可以使用这个函数获取当前播放的进度,返回number类型数据

getAudioSize 获取音频最大进度

getAudioSize(string name)

你可以使用这个函数获取当前音频的最大播放进度

deleteAudio 移除音频

deleteAudio(string name)

你可以使用这个函数卸载已经加载的音频

by Alcedo 更新于 2024-01-19
打赏后可直接下载附件 赠人玫瑰 手留余香
默认
最新
1