Sound
声音
get_by_handle
function Sound.get_by_handle(py_sound: py.SoundEntity)
-> Sound
handle
py.SoundEntity
声音对象
play
function Sound.play(player: Player, sound: py.AudioKey, options?: Sound.PlayOptions)
-> Sound?
播放声音
@param player
— 玩家
@param sound
— 声音
@param options
— 播放选项
play_3d
function Sound.play_3d(player: Player, sound: py.AudioKey, point: Point, options?: Sound.Play3DOptions)
-> Sound?
播放3D声音
@param player
— 玩家
@param sound
— 声音
@param point
— 目标点
@param options
— 播放选项
play_with_object
function Sound.play_with_object(player: Player, sound: py.AudioKey, unit: Unit, options?: Sound.PlayUnitOptions)
-> Sound?
跟随单位播放声音
@param player
— 玩家
@param sound
— 声音
@param unit
— 跟随的单位
@param options
— 播放选项
set_volume
(method) Sound:set_volume(player: Player, volume: integer)
设置音量
@param player
— 玩家
@param volume
— 音量(0-100)
stop
(method) Sound:stop(player: Player, is_immediately?: boolean)
停止播放声音
@param player
— 玩家
@param is_immediately
— 是否立即停止
Sound.Play3DOptions
ensure
boolean
是否确保播放
fade_in
number
渐入时间
fade_out
number
渐出时间
height
number
高度
loop
boolean
是否循环
Sound.PlayOptions
fade_in
number
渐入时间
fade_out
number
渐出时间
loop
boolean
是否循环
Sound.PlayUnitOptions
ensure
boolean
是否确保播放
fade_in
number
渐入时间
fade_out
number
渐出时间
loop
boolean
是否循环
offset_x
number
X轴偏移
offset_y
number
Y轴偏移
offset_z
number
Z轴偏移