Add harlon into version control.
[harlon.git] / Flags
1 ====== Flags ======
2 Rooms and objects may have one or more flags. Each flag is set inside 
3 the 'flags' property for each room or object.
4
5 container - Valid only for objects. Indicates that the object is a 
6 container and other objects can be placed inside of it, rather than on 
7 it. See also the surface flag.
8
9 invisible - Valid only for objects. Indicates that the parser should 
10 deliberately not find the ojects, acting as though it does not exist.
11
12 nodescribe - Valid only for objects. Indicates that the object should 
13 not be described by routines like v_look. This is useful if the oject 
14 is already described another way, like in the room's description.
15
16 surface - Valid only for objects. Indicates that the object is a 
17 surface and other objects can be placed on top of it, rather than in 
18 it. See also the container flag.
19
20 take - Valid only for objects and indicates that the player can take 
21 the object.
22
23 open - Valid only for objects. Intended to be used with containers and 
24 doors. Used to indicate that it is open. If not set, the item is 
25 considered to be closed.
26
27 vowel - Valid only for objects. Indicates that the object's name 
28 begins with a vowel; printed text should use "an" instead of "a".
29
30 --
31 Copyright (C) 2018 Jason Self <j@jxself.org>
32
33 You can redistribute it and/or modify this file under the terms of the 
34 GNU Affero General Public License as published by the Free Software 
35 Foundation, either version 3 of the License, or (at your option) any 
36 later version.
37
38 This file is distributed in the hope that it will be useful, but 
39 WITHOUT ANY WARRANTY; without even the implied warranty of 
40 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
41 Affero General Public License for more details.
42
43 You should have received a copy of the GNU Affero General Public 
44 License along with this file. If not, see 
45 <http://www.gnu.org/licenses/>.