(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / group_type.h
blob530f31f1ea9278cfeb2e9c7ff9d7b3328e1e097c
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
10 /** @file group_type.h Types of a group. */
12 #ifndef GROUP_TYPE_H
13 #define GROUP_TYPE_H
15 typedef uint16 GroupID; ///< Type for all group identifiers.
17 static const GroupID NEW_GROUP = 0xFFFC; ///< Sentinel for a to-be-created group.
18 static const GroupID ALL_GROUP = 0xFFFD; ///< All vehicles are in this group.
19 static const GroupID DEFAULT_GROUP = 0xFFFE; ///< Ungrouped vehicles are in this group.
20 static const GroupID INVALID_GROUP = 0xFFFF; ///< Sentinel for invalid groups.
22 static const uint MAX_LENGTH_GROUP_NAME_CHARS = 32; ///< The maximum length of a group name in characters including '\0'
24 struct Group;
26 #endif /* GROUP_TYPE_H */