src/group_type.h

   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  */
   7
   8 /** @file group_type.h Types of a group. */
   9
  10 #ifndef GROUP_TYPE_H
  11 #define GROUP_TYPE_H
  12
  13 typedef uint16 GroupID; ///< Type for all group identifiers.
  14
  15 static const GroupID NEW_GROUP     = 0xFFFC; ///< Sentinel for a to-be-created group.
  16 static const GroupID ALL_GROUP     = 0xFFFD; ///< All vehicles are in this group.
  17 static const GroupID DEFAULT_GROUP = 0xFFFE; ///< Ungrouped vehicles are in this group.
  18 static const GroupID INVALID_GROUP = 0xFFFF; ///< Sentinel for invalid groups.
  19
  20 static const uint MAX_LENGTH_GROUP_NAME_CHARS = 32; ///< The maximum length of a group name in characters including '\0'
  21
  22 struct Group;
  23
  24 #endif /* GROUP_TYPE_H */