Codefix: Documentation comment in IndustryDirectoryWindow (#13059)
[openttd-github.git] / src / subsidy_type.h
blob2f613c4e90a81a07fddd4356ab21901a9ab224af
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 subsidy_type.h basic types related to subsidies */
10 #ifndef SUBSIDY_TYPE_H
11 #define SUBSIDY_TYPE_H
13 #include "core/enum_type.hpp"
15 /** What part of a subsidy is something? */
16 enum PartOfSubsidy : uint8_t {
17 POS_NONE = 0, ///< nothing
18 POS_SRC = 1 << 0, ///< bit 0 set -> town/industry is source of subsidised path
19 POS_DST = 1 << 1, ///< bit 1 set -> town/industry is destination of subsidised path
21 DECLARE_ENUM_AS_BIT_SET(PartOfSubsidy)
23 typedef uint16_t SubsidyID; ///< ID of a subsidy
24 struct Subsidy;
26 #endif /* SUBSIDY_TYPE_H */