Add harlon into version control.
[harlon.git] / Properties
1 ====== Properties ======
2 Rooms and objects may have one or more properties.
3
4 action - Valid for rooms and objects. Associates a subroutine with it.
5
6 container action - Valid only for objects. Associates a subroutine 
7 with the object when it's acting as a container for another object. 
8 When an object is inside another object this specifies what 
9 subroutine, if any, to call to handle user input, before the 
10 contained object's actual action routine.
11
12 description - Valid for rooms and objects. Provides an unchanging 
13 description of it. See also description function.
14
15 description function - Valid for rooms and objects. Associates a 
16 subroutine with the item used to provide a more dynamic description. 
17 See also description.
18
19 flags - Valid for rooms and objects. Specifies which flags apply. 
20 Since flags may also be set or cleared at any appropriate time in the 
21 game, this is used to specify the room or object flags that exist at 
22 the start of the game.
23
24 location - Valid only for objects. Specifies the location of that 
25 object, using the internal name.
26
27 name - Valid for rooms and objects. Provides the external name of the 
28 item, as shown to the player.
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/>.