[WIP] [Peripheral] Speaker #201

Restioson · 2017-05-06T09:04:01Z

Closed

PR has been closed due to a number of factors. Below is the original PR.

Speaker API

This PR adds a new peripheral: the speaker peripheral. This allows computers to play any sound! Theoretically, you can even play sounds from other mods, provided that you use the correct domain. However, as of writing, speaker.play throws a NPE due to ItemPocketComputer's ServerComputer.getPos() returning null. This is fixed in #172 .

Possible Use Cases

Notification API! You can notify the user with a snazzy ping. Useful as currently there is no way of notifying players of something on a computer
Music! You can play records
Custom music! You can make music using this by combining different sounds
Super sneaky wireless range pinpointer! You can play a tone on a wireless pocket computer every time it gets a packet according to the range of the other modem. You could use this for PVP. I created a working implementation of this. Click here to see the video!

Example

speaker.playsound("minecraft:entity.cow.ambient") -- Plays entity.cow.ambient from domain minecraft
sleep(1 / 20) -- Sleeps the required amount of time, converting from ticks to seconds
speaker.playsound("entity.cow.ambient", 0.1) -- Plays entity.cow.ambient (in default domain, minecraft) at volume 0.1
sleep(1 / 20)
speaker.playsound("entity.cow.ambient", 1, 0.1) -- Plays entity.cow.ambient at volume 1 and pitch 0.1, thereby slowing it down
sleep(1 / 20)
speaker.playnote("harp",1,2) -- Plays the noteblock harp note at volume 1 and pitch 2

Functions

speaker.playsound - Takes 1 positional arguments (string resource name) and 2 optional positional arguments (double volume and double pitch). Returns true or false based on whether the resourcename exists and is a sound. Plays the sound at resourcename with volume and pitch, under category RECORDS.

Summation of changes

Added speaker_enable config option
Added speaker peripheral & provider
Added speaker.playsound(resourceLocator, volume, pitch) function in java
Added speaker.playnote(noteblockInstrument, volume, pitch) function in java

WIP

Rewrite as peripheral.

Thanks

Special thanks to @SquidDev for helping me understand and navigate the codebase, and @gegy1000 for helping me out with Forge.

…rc/main/java/dan200/computercraft/core/apis/TimeAPI.java

getSelectedBoundingBox expects a bounding box relative to (0, 0, 0) but we were returning one relative to the current block. Instead we allow the default behaviour to continue, which will call getBoundingBox and offset it.

# Conflicts: # src/main/java/dan200/computercraft/core/apis/SoundAPI.java

SquidDev · 2017-05-06T09:14:09Z

src/main/java/dan200/computercraft/ComputerCraft.java

@@ -277,6 +281,9 @@ public void preInit( FMLPreInitializationEvent event )
        Config.turtlesCanPush = Config.config.get( Configuration.CATEGORY_GENERAL, "turtlesCanPush", turtlesCanPush );
        Config.turtlesCanPush.setComment( "If set to true, Turtles will push entities out of the way instead of stopping if there is space to do so" );

+        Config.minTimeBetweenSounds = Config.config.get( Configuration.CATEGORY_GENERAL, "minTimeBetweenSounds", minTimeBetweenSounds);
+        Config.minTimeBetweenSounds.setComment("The minimum time in between calls to sound.play on one computer in milliseconds" );


You'll need to add a language key to en_US.lang. Something like gui.computercraft:config.min_time_between_sounds=Minimum time between sounds. Make sure it fits on the screen though. It might also be a good idea to add a .setMinValue(0) so people cannot use negatives.

I had added the setMinValue. I don't understand the language key: won't this snippet do it -

for (Property property : Config.config.getCategory( Configuration.CATEGORY_GENERAL ).getOrderedValues()) { property.setLanguageKey( "gui.computercraft:config." + CaseFormat.LOWER_CAMEL.to( CaseFormat.LOWER_UNDERSCORE, property.getName() ) ); }

That will register the language key, but you haven't actually provided a translation - if you open the GUI, you'll just see minTimeBetweenSounds. If you add the appropriate string to en_US.lang, then it should be translated correctly.

SquidDev · 2017-05-06T09:14:09Z