sound_spec.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
#pragma once
 
#include <string>
#include "irrlichttypes_bloated.h"
 
struct SoundSpec
{
        SoundSpec(std::string_view name = "", float gain = 1.0f,
                        bool loop = false, float fade = 0.0f, float pitch = 1.0f,
                        float start_time = 0.0f) :
                        name(name), gain(gain), fade(fade), pitch(pitch), start_time(start_time),
                        loop(loop)
        {
        }
 
        bool exists() const { return !name.empty(); }
 
        // Serialize/Deserialize a `SimpleSoundSpec`.
        void serializeSimple(std::ostream &os, u16 protocol_version) const;
        void deSerializeSimple(std::istream &is, u16 protocol_version);
 
        // Name of the sound-group
        std::string name;
        float gain = 1.0f;
        float fade = 0.0f;
        float pitch = 1.0f;
        float start_time = 0.0f;
        bool loop = false;
        // If true, a local fallback (ie. from the user's sound pack) is used if the
        // sound-group does not exist.
        bool use_local_fallback = true;
};
 
 
// The order must not be changed. This is sent over the network.
enum class SoundLocation : u8 {
        Local,
        Position,
        Object
};