org.spongepowered.api.event.sound.PlaySoundEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
There is a newer version: 9.0.0
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.event.sound;

import net.kyori.adventure.sound.Sound;
import org.spongepowered.api.Server;
import org.spongepowered.api.block.entity.Jukebox;
import org.spongepowered.api.data.type.InstrumentType;
import org.spongepowered.api.data.type.NotePitch;
import org.spongepowered.api.effect.sound.SoundType;
import org.spongepowered.api.effect.sound.music.MusicDisc;
import org.spongepowered.api.entity.Entity;
import org.spongepowered.api.entity.living.player.server.ServerPlayer;
import org.spongepowered.api.event.Cancellable;
import org.spongepowered.api.event.Event;
import org.spongepowered.api.world.server.ServerLocation;

import java.util.Optional;

/**
 * An umbrella event that fires when in-game sounds, such as
 * records in jukeboxes or sounds when boss entities die.
 */
public interface PlaySoundEvent extends Event, Cancellable {

    /**
     * Gets the location of the sound being played.
     *
     * @return the location of the sound being played
     */
    ServerLocation location();

    /**
     * Gets the {@link SoundType} for the sound being played.
     *
     * @return The {@link SoundType}
     */
    SoundType soundType();

    /**
     * Gets the {@link Sound.Source} for the sound being played.
     *
     *  @return The {@link Sound.Source}
     */
    Sound.Source soundSource();

    /**
     * Gets the volume of the sound being played.
     *
     * @return A float that represents the relative volume. This value may be
     *         positive value.
     */
    float volume();

    /**
     * Gets the pitch of the sound being played
     *
     * @return A float that represents the pitch.
     */
    float pitch();

    /**
     * Fired when a sound is broadcasted to all {@link ServerPlayer player's} on the {@link Server}.
     * Examples of when this might be fired include:
     *
     * 
     * When a Wither or Dragon dies;
     * When a sound event is played globally
     * 
     */
    interface Broadcast extends PlaySoundEvent {

    }

    /**
     * Fired when a record is inserted into a Jukebox
     */
    interface Record extends PlaySoundEvent {

        /**
         * Gets the {@link Jukebox} associated with this event.
         *
         * @return The jukebox tile
         */
        Jukebox jukebox();

        /**
         * Gets the {@link MusicDisc} associated with this event.
         *
         * @return The record type
         */
        MusicDisc recordType();

        /**
         * Fired when a record starts playing.
         */
        interface Start extends Record {}

        /**
         * Fired when a record stops playing.
         */
        interface Stop extends Record {}

    }

    /**
     * Fired when a sound is played at a specific {@link Entity}
     */
    interface AtEntity extends PlaySoundEvent {

        /**
         * Gets the {@link ServerPlayer player} that this sound was played at, if the sound
         * was played at a player.
         *
         * @return The player, if applicable.
         */
        Optional player();

    }

    /**
     * Fired when a noteblock is triggered
     */
    interface NoteBlock extends PlaySoundEvent {

        /**
         * The type of instrument that played the
         * {@link org.spongepowered.api.block.BlockTypes#NOTE_BLOCK Note block}.
         *
         * @return The {@link InstrumentType}
         */
        InstrumentType instrument();

        /**
         * The pitch of the played
         * {@link org.spongepowered.api.block.BlockTypes#NOTE_BLOCK Note block}.
         *
         * @return The {@link NotePitch}
         */
        NotePitch notePitch();

    }

}