Codechange: Return pair from instead of optional out parameter. (#13166)
[openttd-github.git] / src / sound / null_s.h
blobfb931b84dd4ace2bc7912122bce36ac61b22969e
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file null_s.h Base for the sound of silence. */
10 #ifndef SOUND_NULL_H
11 #define SOUND_NULL_H
13 #include "sound_driver.hpp"
15 /** Implementation of the null sound driver. */
16 class SoundDriver_Null : public SoundDriver {
17 public:
18 std::optional<std::string_view> Start(const StringList &) override { return std::nullopt; }
20 void Stop() override { }
21 std::string_view GetName() const override { return "null"; }
22 bool HasOutput() const override { return false; }
25 /** Factory for the null sound driver. */
26 class FSoundDriver_Null : public DriverFactoryBase {
27 public:
28 FSoundDriver_Null() : DriverFactoryBase(Driver::DT_SOUND, 1, "null", "Null Sound Driver") {}
29 Driver *CreateInstance() const override { return new SoundDriver_Null(); }
32 #endif /* SOUND_NULL_H */