1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2026-04-30 10:51:22 +00:00

Clarify which sounds can be played with speaker

Closes #2327
This commit is contained in:
Jonathan Coates
2025-11-18 19:23:14 +00:00
parent 08d12f2b0e
commit 6334a9df15

View File

@@ -45,7 +45,7 @@ import static dan200.computercraft.api.lua.LuaValues.checkFinite;
* <p>
* The speaker can play three kinds of sound, in increasing orders of complexity:
* - {@link #playNote} allows you to play noteblock note.
* - {@link #playSound} plays any built-in Minecraft sound, such as block sounds or mob noises.
* - {@link #playSound} plays any Minecraft sound, such as block sounds or mob noises.
* - {@link #playAudio} can play arbitrary audio.
* <p>
* ## Recipe
@@ -229,7 +229,7 @@ public abstract class SpeakerPeripheral implements IPeripheral {
/**
* Plays a Minecraft sound through the speaker.
* <p>
* This takes the [name of a Minecraft sound](https://minecraft.wiki/w/Sounds.json), such as
* This takes the name of a [vanilla Minecraft](https://minecraft.wiki/w/Sounds.json) or modded sound, such as
* {@code "minecraft:block.note_block.harp"}, as well as an optional volume and pitch.
* <p>
* Only one sound can be played at once. This function will return {@literal false} if another sound was started