Свои звуки

Проиграть файлСкопировать ссылку

Путь считается от папки со скриптами, так что достаточно имени файла. Можно дать и полный путь с диска, и ссылку: файл по ссылке клиент скачает к себе в кеш и заиграет, как только тот приедет. Скачанное остаётся в кеше, поэтому второй раз звук стартует сразу.

1
2
3
4
5
6
7
8
9
10
11@command("beep")
def beep(ctx):
    """Проиграть звук"""
    sound.play("beep.wav")


# Файл лежит в подпапке рядом со скриптом
sound.play("audio/hit.mp3")

# Ссылка: клиент скачает файл сам
sound.play("https://example.com/alert.ogg")

Форматов три: wav, mp3 и ogg. Тип определяется по содержимому файла, а не по расширению, так что файл без расширения тоже заиграет.

Громкость, скорость и повторСкопировать ссылку

Всё настраивается прямо в вызове. Громкость - доля от единицы, скорость - множитель (он меняет и высоту тона, как у пластинки), loop зацикливает звук, пока его не остановят.

1
2
3
4
5
6
7
8sound.play("hit.wav", volume=0.4)
sound.play("hit.wav", volume=0.4, speed=1.25)

# Фоновая музыка: играет по кругу, пока скрипт загружен
music_loop = sound.loop("ambient.mp3", volume=0.2)

# Остановить
music_loop.stop()

Громкость по умолчанию считается от ползунков звука в настройках игры: игрок убавил общий звук - твой звук тоже стал тише. Ползунок выбирается параметром category: master, music, players, blocks, ambient и остальные из настроек звука. Значение none отвязывает звук от игры совсем.

1
2
3
4
5# Тише вместе с ползунком "Музыка"
sound.play("ambient.mp3", volume=0.5, category="music")

# Ползунки игры не учитываются вообще
sound.play("alert.wav", category="none")

Управление звукомСкопировать ссылку

Любой вызов возвращает объект звука. Его можно сохранить и потом останавливать, ставить на паузу, крутить громкость и спрашивать, сколько уже отыграно.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23track = sound.load("ambient.mp3", volume=0.3, loop=True)

m = Module("Ambient", "Other")


@events.on("module_toggled")
def toggled(event):
    if event.getModule().getName() != "Ambient":
        return

    if m.isEnabled():
        track.play()
    else:
        track.stop()


@events.on("tick")
def tick():
    if track.playing:
        # Плавно приглушаем к концу трека
        left = track.duration - track.position
        if left < 3:
            track.volume(0.3 * left / 3)

on_end срабатывает только на естественный конец: после stop() и после выгрузки скрипта колбэк не зовётся. У зацикленного звука его не будет вовсе.

1
2
3
4
5intro = sound.load("intro.wav")
main = sound.load("main.mp3", loop=True)

intro.on_end(lambda: main.play())
intro.play()

Несколько звуков разомСкопировать ссылку

sound.play держит по одному звуку на файл: позвал второй раз - тот же звук начнётся заново. Для звука удара это как раз то, что нужно, а вот когда удары идут очередью и должны накладываться друг на друга, нужен sound.once: он заводит отдельный голос и убирает его сам, как только тот доиграет.

1
2
3
4@events.on("attack")
def on_attack(event):
    # Каждый удар слышно отдельно, даже если они идут подряд
    sound.once("hit.wav", volume=0.5)

Именованные параметры у всех вызовов одинаковые: volume, speed, loop, category, on_end, а у sound.play ещё и overlap=True - это то же самое, что once.

Что стоит помнитьСкопировать ссылку