API
Звуки и частицы
Собственные звуки и частицы поставляются внутри мода, как текстуры, и используются по id, как и игровые. Они объявляются так же, как остальной контент.
Звуки
sound "ruby_chime" { file: "ruby/chime", subtitle: "A ruby chimes", pitch: 1.2 }
sound "ruby_crumble" { files: ["ruby/crumble_1", "ruby/crumble_2"], subtitle: "Ruby ore crumbles", volume: 0.8 }| Свойство | Значения | По умолчанию |
|---|---|---|
file |
путь к файлу без расширения: ruby/chime — это sounds/ruby/chime.ogg мода |
sounds/<id>.ogg |
files |
несколько путей; каждый раз играет случайный | — |
subtitle |
что показывается при включённых субтитрах | — |
volume |
0–1 | 1 |
pitch |
высота звука; 1 — исходная | 1 |
Он проигрывается как любой игровой звук: player.play_sound("rubies:ruby_chime") для одного игрока, world().play_sound(location, "rubies:ruby_chime") в точке. Файлы — в формате .ogg.
Частицы
particle "ruby_spark" { textures: ["ruby_spark_0", "ruby_spark_1"], motion: "sparkle" }| Свойство | Значения | По умолчанию |
|---|---|---|
textures |
изображения из textures/particle/, без расширения. Несколько складываются в анимацию в этом порядке |
textures/particle/<id>.png |
motion |
float_up: поднимается и тает. flame: почти неподвижна, уменьшается. sparkle: дрейфует и мерцает. drift: парит на месте. |
float_up |
Частица создаётся по id: world().spawn_particle("rubies:ruby_spark", location, 30, 1.5, 0.02), с количеством, разбросом и скоростью, как у игровых частиц. Чтобы отправить одну частицу в заданную сторону, передай вместо этого скорость: world().spawn_particle("minecraft:end_rod", location, vector(0, 0.1, 0)), в блоках за тик. Частицы, которые притягиваются к месту, как minecraft:enchant, начинают с location + velocity и летят к location.
Реальный пример
В примере мода, когда руда выбрасывает лишний рубин, звучит перезвон, а там, где был блок, разлетаются искры:
import { give_rubies } from "/lib/rewards"
import { SETTINGS } from "/settings"
on break(e) {
let p = e.player
if p == null { return }
if e.block.type == "minecraft:diamond_ore" and chance(SETTINGS["bonus_chance"]) {
give_rubies(p, 1)
p.play_sound("rubies:ruby_chime")
p.world.spawn_particle("rubies:ruby_spark", e.block.location, 12, 0.4, 0.02)
}
}На Kotlin
package com.example.rubies.content
object Sounds {
const val CHIME = "rubies:ruby_chime"
fun register(content: ContentBuilder) {
content.sound("ruby_chime") { file("ruby/chime"); subtitle = "A ruby chimes"; pitch = 1.2f }
content.sound("ruby_crumble") { file("ruby/crumble_1"); file("ruby/crumble_2"); subtitle = "Ruby ore crumbles"; volume = 0.8f }
}
}package com.example.rubies.content
object Particles {
const val SPARK = "rubies:ruby_spark"
fun register(content: ContentBuilder) {
content.particle("ruby_spark") { texture("ruby_spark_0"); texture("ruby_spark_1"); motion = ParticleMotion.SPARKLE }
}
}sound(id) { file(...); subtitle; volume; pitch } и particle(id) { texture(...); motion = ParticleMotion.SPARKLE } внутри ContentBuilder. Чтобы проиграть и создать: player.playSound(id), world.playSound(at, id), world.spawnParticle(id, at, count, spread, speed) и world.spawnParticle(id, at, Vector(0.0, 0.1, 0.0)).
Файлы
| Мод | Где |
|---|---|
| CraftScript (папка) | mods/rubies/sounds/ruby/chime.ogg, mods/rubies/textures/particle/ruby_spark_0.png |
| Kotlin или Java | src/main/resources/assets/rubies/sounds/ruby/chime.ogg, …/assets/rubies/textures/particle/ruby_spark_0.png |