Set placeholder record behavior

OpenBagTwo commented 1 year ago

Resolves #29 by implementing the following behaviors for placeholder records (tracks > n_discs and <= max_discs)

the discs' play sounds are set to 4.33 seconds of silence
their item name appears as "Music Disc" and tooltip as ""Joe Box - 4.33" (that's obvious parody, right?)
their texture renders in as a translucent vinyl record
these items still do not appear in the creative inventory (thank you #35)
the player's minecraft logs will now no longer contain copious amounts of warnings about missing textures and sound events (this has been verified)... unless they specify a config value of n_discs that's greater than the number of discs they've provided in their custom disc resource pack (this has also been verified)

The way this is done is through a little bit of a hodgepodge:

the Disc class now has a boolean flag that can be used to tell the client that thee disc should be treated as a placeholder (this explicitly changes nothing about the server behavior)
~~the discRegistry will set each disc's SoundEvent to a placeholder event (just overriding the client-side sound isn't enough to get rid of the "missing sound for event" warnings)~~ as of 1eca37d, the SoundEvents for these discs are a custom class that overrides the sound event ID on the client-side if a placeholder flag is set
I've added a client entrypoint to override the model json used to load the placeholder records (and thus the textures)

Validation Performed

With `n_discs` set to 12

Discs up to 12 appear in the creative inventory, everything beyond 7 has missing textures and item names

With `n_discs` set to 3

Only three FoxNap records appear in the creative inventory, and the previous missing textures and text are now the placeholder ones

Jukebox "now playing" behavior functioning as expected

OpenBagTwo commented 1 year ago

Dang it.

n_discs mismatching between server and client leads to incompatible sound registries

OpenBagTwo commented 1 year ago

Working on a client with n_discs set to 3 and a server with n_discs set to 12.

Connected successfully, no warnings about missing sound files, and popping in Track 6 (for which a music file could have been played if n_discs hasn't disabled it, resulted in nothing but silence on the client-side

client placeholder settings taking precedence over server settings

OpenBagTwo commented 1 year ago

An interesting (though not unwanted) behavior is that even with n_discs set to 3 _I can still run the command /playsound foxnap:track_5 master @s and hear the built-in music. This is presumably because sounds.json is registering the sound event to a code path that's separate from the one that uses SoundEvent.getId()

OpenBagTwo / FoxNap