索引
| 接口 | 端 | 描述 |
|---|---|---|
| PlaySound | 双端 | 播放音效至玩家身上,其他玩家能够选择性听到音效 |
| PlayUISound | 双端 | 播放音效至玩家身上,其他玩家无法听到音效 |
| PlaySoundNew | 双端 | 通过关键帧配置播放音效 |
PlaySound
双端
-
描述
播放音效至玩家身上,其他玩家能够选择性听到音效 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| SoundName | str | 音效名称 |
| ClearStop | bool | 是否清除所有通过此接口播放的音效,防止音效重叠,默认为False |
| Volume | float | 音量,默认为1.0 |
| Pitch | float | 音调,默认为1.0 |
| Loop | bool | 是否循环播放,默认为False |
| Range | float | 播放范围,默认为32.0 |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| SoundName | str | 音效名称 |
| ClearStop | bool | 是否清除所有通过此接口播放的音效,防止音效重叠,默认为False |
| Volume | float | 音量,默认为1.0 |
| Pitch | float | 音调,默认为1.0 |
| Loop | bool | 是否循环播放,默认为False |
| Range | float | 播放范围,默认为32.0 |
-
返回值
无 -
备注
无 -
示例 空
PlayUISound
双端
-
描述
播放音效至玩家身上,其他玩家无法听到音效 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| SoundName | str | 音效名称 |
| ClearStop | bool | 是否清除所有通过此接口播放的音效,防止音效重叠,默认为False |
| Volume | float | 音量,默认为1.0 |
| Pitch | float | 音调,默认为1.0 |
| Loop | bool | 是否循环播放,默认为False |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| SoundName | str | 音效名称 |
| ClearStop | bool | 是否清除所有通过此接口播放的音效,防止音效重叠,默认为False |
| Volume | float | 音量,默认为1.0 |
| Pitch | float | 音调,默认为1.0 |
| Loop | bool | 是否循环播放,默认为False |
-
返回值
无 -
备注
无 -
示例 空
PlaySoundNew
双端
-
描述
通过关键帧配置播放音效 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| SoundData | dict | 音效数据 |
| ClearStop | bool | 是否清除所有通过此接口播放的音效,防止音效重叠,默认为False |
| FliterBroadcastList | list[str] | 指定广播音效的玩家列表(未广播到的无法听到音效),默认为None则广播全员 |
| IsLogging | bool | 是否打印日志,默认为False |
-
返回值
无 -
备注
-
当音效定义类型为
ui时,无法感知远近及左右声效效果。 -
SoundData字典规范
参数名 数据类型 说明 Key float 关键帧时间 Value list[dict] 关键帧音效数据列表 Value.SoundName str 音效名称 Value.Volume float 音量,默认为1.0 Value.Pitch float 音调,默认为1.0 Value.Position tuple[float] 播放位置,默认为(0, 0, 0)。
当指定播放实体Id列表时,音效将播放在实体相对位置。未指定则播放在世界坐标。Value.EntityIdList list[str] 指定音效绑定的实体Id列表,默认为[] Value.Loop bool 是否循环播放,默认为False Value.PlayTimer float 当Value.Loop为 True时,才可指定播放定时器,默认为0.0则持续重复播放,需要通过调用此接口并将ClearStop设置为True来清除音效
-
-
示例
-
可复制直接执行的有效示例
import random
PlayerId = random.choice(serverApi.GetPlayerList())
SoundData = {
1.0: [
{
'SoundName': 'dfm_click_high',
'Volume': 1,
'Pitch': 1,
'Loop': False,
'EntityIdList': [PlayerId],
}
],
1.5: [
{
'SoundName': 'dfm_click_high',
'Volume': 1,
'Pitch': 1.5,
'Loop': False,
'EntityIdList': [PlayerId],
}
],
2.0: [
{
'SoundName': 'dfm_click_high',
'Volume': 1,
'Pitch': 0.5,
'Loop': False,
'EntityIdList': [PlayerId],
}
],
2.5: [
{
'SoundName': 'milkteamouse_gun_death_target',
'Volume': 2,
'Pitch': 1.0,
'Loop': False,
'Position': (4, 0, 0),
'EntityIdList': [PlayerId],
}
],
3.0: [
{
'SoundName': 'milkteamouse_gun_death_target',
'Volume': 2,
'Pitch': 1.0,
'Loop': False,
'Position': (0, -60, 0),
},
{
'SoundName': 'milkteamouse_gun_hurt_target',
'Volume': 5,
'Pitch': 1.0,
'Loop': True,
'PlayTimer': 5.0,
'EntityIdList': [PlayerId],
}
],
}
LASystem.PlaySoundNew(SoundData)