Cynthia Yantis / Bukkit / 96340858187

Commits

coll1234567 authored and md_5 committed 96340858187 17 Nov 2023

#938: Various Sound API improvements

src/main/java/org/bukkit/entity/Player.java

Modified

-384
+    /**
-385
+     * Sets the Location where the player will spawn at their bed.
-386
+     *
-387
+     * @param location where to set the respawn location
-388
+     * @param force whether to forcefully set the respawn location even if a
-389
+     *     valid bed is not present
-390
+     */
-391
+    public void setBedSpawnLocation(@Nullable Location location, boolean force);
-392
-393
+    /**
--
+     * Play a note for a player at a location. This requires a note block
--
+     * at the particular location (as far as the client is concerned). This
--
+     * will not work without a note block. This will not work with cake.
-+
+     * Play a note for the player at a location. <br>
-+
+     * This <i>will</i> work with cake.
-396
+     *
--
+     * @param loc The location of a note block.
-+
+     * @param loc The location to play the note
-398
+     * @param instrument The instrument ID.
-399
+     * @param note The note ID.
-400
+     * @deprecated Magic value
-401
+     */
-402
+    @Deprecated
-403
+    public void playNote(@NotNull Location loc, byte instrument, byte note);
-404
-405
+    /**
--
+     * Play a note for a player at a location. This requires a note block
--
+     * at the particular location (as far as the client is concerned). This
--
+     * will not work without a note block. This will not work with cake.
--
+     *
--
+     * @param loc The location of a note block
-+
+     * Play a note for the player at a location. <br>
-+
+     * This <i>will</i> work with cake.
-+
+     * <p>
-+
+     * This method will fail silently when called with {@link Instrument#CUSTOM_HEAD}.
-+
+     * @param loc The location to play the note
-411
+     * @param instrument The instrument
-412
+     * @param note The note
-413
+     */
-414
+    public void playNote(@NotNull Location loc, @NotNull Instrument instrument, @NotNull Note note);
-415
-416
-417
+    /**
-418
+     * Play a sound for a player at the location.
-419
+     * <p>
-420
+     * This function will fail silently if Location or Sound are null.
-461
+     * sound for the value passed.
-462
+     *
-463
+     * @param location The location to play the sound
-464
+     * @param sound The internal sound name to play
-465
+     * @param category The category of the sound
-466
+     * @param volume The volume of the sound
-467
+     * @param pitch The pitch of the sound
-468
+     */
-469
+    public void playSound(@NotNull Location location, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch);
-470
-+
+    /**
-+
+     * Play a sound for a player at the location. For sounds with multiple
-+
+     * variations passing the same seed will always play the same variation.
-+
+     * <p>
-+
+     * This function will fail silently if Location or Sound are null.
-+
+     *
-+
+     * @param location The location to play the sound
-+
+     * @param sound The sound to play
-+
+     * @param category The category of the sound
-+
+     * @param volume The volume of the sound
-+
+     * @param pitch The pitch of the sound
-+
+     * @param seed The seed for the sound
-+
+     */
-+
+    public void playSound(@NotNull Location location, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch, long seed);
-+
-+
+    /**
-+
+     * Play a sound for a player at the location. For sounds with multiple
-+
+     * variations passing the same seed will always play the same variation.
-+
+     * <p>
-+
+     * This function will fail silently if Location or Sound are null. No sound
-+
+     * will be heard by the player if their client does not have the respective
-+
+     * sound for the value passed.
-+
+     *
-+
+     * @param location The location to play the sound
-+
+     * @param sound The internal sound name to play
-+
+     * @param category The category of the sound
-+
+     * @param volume The volume of the sound
-+
+     * @param pitch The pitch of the sound
-+
+     * @param seed The seed for the sound
-+
+     */
-+
+    public void playSound(@NotNull Location location, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch, long seed);
-+
-503
+    /**
-504
+     * Play a sound for a player at the location of the entity.
-505
+     * <p>
-506
+     * This function will fail silently if Entity or Sound are null.
-507
+     *
-508
+     * @param entity The entity to play the sound
-509
+     * @param sound The sound to play
-510
+     * @param volume The volume of the sound
-511
+     * @param pitch The pitch of the sound
-512
+     */
-543
+     * This function will fail silently if Entity or Sound are null.
-544
+     *
-545
+     * @param entity The entity to play the sound
-546
+     * @param sound The sound to play
-547
+     * @param category The category of the sound
-548
+     * @param volume The volume of the sound
-549
+     * @param pitch The pitch of the sound
-550
+     */
-551
+    public void playSound(@NotNull Entity entity, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch);
-552
-+
+    /**
-+
+     * Play a sound for a player at the location of the entity. For sounds with
-+
+     * multiple variations passing the same seed will always play the same variation.
-+
+     * <p>
-+
+     * This function will fail silently if Entity or Sound are null.
-+
+     *
-+
+     * @param entity The entity to play the sound
-+
+     * @param sound The sound to play
-+
+     * @param category The category of the sound
-+
+     * @param volume The volume of the sound
-+
+     * @param pitch The pitch of the sound
-+
+     * @param seed The seed for the sound
-+
+     */
-+
+    public void playSound(@NotNull Entity entity, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch, long seed);
-+
-+
+    /**
-+
+     * Play a sound for a player at the location of the entity. For sounds with
-+
+     * multiple variations passing the same seed will always play the same variation.
-+
+     * <p>
-+
+     * This function will fail silently if Entity or Sound are null.
-+
+     *
-+
+     * @param entity The entity to play the sound
-+
+     * @param sound The sound to play
-+
+     * @param category The category of the sound
-+
+     * @param volume The volume of the sound
-+
+     * @param pitch The pitch of the sound
-+
+     * @param seed The seed for the sound
-+
+     */
-+
+    public void playSound(@NotNull Entity entity, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch, long seed);
-+
-583
+    /**
-584
+     * Stop the specified sound from playing.
-585
+     *
-586
+     * @param sound the sound to stop
-587
+     */
-588
+    public void stopSound(@NotNull Sound sound);
-589
-590
+    /**
-591
+     * Stop the specified sound from playing.
-592
+     *

Bukkit

Commits

Jira Issues

Add shortcut