… | |
… | |
7 | |
7 | |
8 | This documentation is in a sketchy state. It's mostly |
8 | This documentation is in a sketchy state. It's mostly |
9 | used to collect notes about the internal behaviour of the |
9 | used to collect notes about the internal behaviour of the |
10 | objects. |
10 | objects. |
11 | |
11 | |
|
|
12 | =head2 About the notation and terms |
|
|
13 | |
|
|
14 | The term 'archetype' stands for a collection of fields. |
|
|
15 | The term 'object' stands for an archetype instance. |
|
|
16 | The term 'field' is used for an object fields and archetype fields. |
|
|
17 | |
|
|
18 | Field names will be displayed like this: I<fieldname> |
|
|
19 | |
|
|
20 | Type names will be displayed like this: B<TYPENAME> |
|
|
21 | |
|
|
22 | Flag names will be displayer like this: FLAG_NAME |
|
|
23 | |
12 | =head2 About archetypes and objects |
24 | =head2 About archetypes and objects |
13 | |
25 | |
14 | Field denotes an attribute of an archetype. |
26 | Archetypes are 'templates' of objects. If an object is derived |
|
|
27 | from an archetype the object fields will be set to the corresponding |
|
|
28 | fields in the archetype. |
|
|
29 | |
|
|
30 | When a map is instanciated (loaded), the 'object' description on the |
|
|
31 | map are considered patches of the archetype. |
|
|
32 | |
|
|
33 | This document does explain the behaviour of the objects and the meaning of |
|
|
34 | their fields in the server engine, which are derived from archetypes. |
|
|
35 | |
15 | This is an example of an archetype: |
36 | This is an example of an archetype: |
16 | |
37 | |
17 | Object button_trigger |
38 | Object button_trigger |
18 | name button |
39 | name button |
19 | type 30 |
40 | type 30 |
… | |
… | |
30 | editable 48 |
51 | editable 48 |
31 | visibility 50 |
52 | visibility 50 |
32 | weight 1 |
53 | weight 1 |
33 | end |
54 | end |
34 | |
55 | |
35 | This archetype has the name 'button_trigger' and the objects that |
56 | The first B<field> is I<name>: 'button_trigger', which basically means that |
36 | inherit from this archetype have the name 'button'. |
57 | instances (objects) that are created/derived from this archetype have the |
|
|
58 | name 'button' (which means that the field I<name> of the object will be set |
|
|
59 | to the same value as the archetypes field I<name>). |
37 | |
60 | |
38 | The next field 'type' decides the main behaviour of this archetype. |
61 | The next field I<type> decides the behaviour of objects derived from this archetype. |
39 | For a comprehensive list of types see include/define.h. For this case |
62 | For a comprehensive list of types see include/define.h. For this case |
40 | you might find a line like: |
63 | you might find a line like: |
41 | |
64 | |
42 | #define TRIGGER_BUTTON 30 |
65 | #define TRIGGER_BUTTON 30 |
43 | |
66 | |
44 | The server internally works with objects that 'inherit' attributes from |
67 | The behaviour of objects is further determined by B<Flags>, like FLAG_APPLIED. |
45 | an archetype. They have a similar set of attributes. |
68 | For more information on this look in the Flags subsection in the next section |
46 | |
69 | |
47 | The following documentation will also document the meaning of code internal |
70 | The following documentation will also document the meaning of internal used |
48 | attributes of objects. These attributes are marked as '(internal)' and can't |
71 | fields of objects. These fields are marked as (internal) and can't |
49 | or shouldn't be set by an archetype. If the internal names differs the |
72 | or shouldn't be set by an archetype. |
50 | external name (for the archetypes) for the attribute is written behind it. |
|
|
51 | |
73 | |
52 | =head2 Description of generic archetype and object attributes |
74 | =head2 Description of (mostly) generic object fields |
53 | |
75 | |
54 | These are the fields that most of the objects have and/or their |
76 | These are the fields that most of the objects have and/or their |
55 | default behaviour. |
77 | default behaviour. |
56 | |
78 | |
57 | =over 4 |
79 | =over 4 |
58 | |
80 | |
59 | =item name <string> |
81 | =item I<name> <string> |
60 | |
82 | |
61 | The name of the object. |
83 | The name of the object. |
62 | |
84 | |
63 | =item name_pl <string> |
85 | =item I<name_pl> <string> |
64 | |
86 | |
65 | The name of a collection of these objects (the plural of the name). |
87 | The name of a collection of these objects (the plural of the name). |
66 | |
88 | |
67 | =item face <facename> |
89 | =item I<face> <facename> |
68 | |
90 | |
69 | The graphical appearance of this object. |
91 | The graphical appearance of this object. |
70 | |
92 | |
|
|
93 | =item I<x> <number> |
|
|
94 | |
|
|
95 | The x position of the object when it is on a map. |
|
|
96 | |
|
|
97 | =item I<y> <number> |
|
|
98 | |
|
|
99 | The y position of the object when it is on a map. |
|
|
100 | |
|
|
101 | =item I<map> (internal) |
|
|
102 | |
|
|
103 | The map the object is on. |
|
|
104 | |
71 | =item invisible <number> |
105 | =item I<invisible> <number> |
72 | |
106 | |
73 | If the <number> is greater than 0 the object is invisible. |
107 | If the <number> is greater than 0 the object is invisible. |
74 | For players this field reflects the duration of the invisibility |
108 | For players this field reflects the duration of the invisibility |
75 | and is decreased every tick by 1. |
109 | and is decreased every tick by 1. |
76 | |
110 | |
77 | For non-player objects this field is not changed by server ticks. |
111 | For non-player objects this field is not changed by server ticks. |
78 | |
112 | |
|
|
113 | =item I<glow_radius> <number> |
|
|
114 | |
|
|
115 | This field indicates how far an object glows. Default is a radius of 0 (no |
|
|
116 | glowing at all). |
|
|
117 | |
79 | =item speed <number> |
118 | =item I<speed> <number> |
80 | |
119 | |
81 | If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed |
120 | If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed |
82 | on the active object list and will be processed each tick (see also speed_left!). |
121 | on the active object list and will be processed each tick (see also speed_left!). |
83 | |
122 | |
84 | If the speed field drops below the MIN_ACTIVE_SPEED the object is removed |
123 | If I<speed> drops below the MIN_ACTIVE_SPEED the object is removed |
85 | from the active object list and it won't experience any processing per tick. |
124 | from the active object list and it won't experience any processing per tick. |
86 | |
125 | |
87 | =item speed_left <number> |
126 | =item I<speed_left> <number> |
88 | |
127 | |
89 | If this field is greater than 0 and the object is on the |
128 | If this field is greater than 0 and the object is on the |
90 | active list (mostly means it's speed is also greater than 0): |
129 | active list (mostly means it's speed is also greater than 0): |
91 | |
130 | |
92 | - speed_left is decreased by 1 |
131 | - speed_left is decreased by 1 |
93 | - and this object is processed and experiences a server tick. |
132 | - and this object is processed and experiences a server tick. |
94 | |
133 | |
95 | If the object is on the active list and speed_left is lower or |
134 | If the object is on the active list and I<speed_left> is lower or |
96 | equal to 0 the absolute value of the speed field is added to speed_left |
135 | equal to 0 the absolute value of the I<speed> is added to I<speed_left> |
97 | on the end of the tick. |
136 | on the end of the tick. |
98 | |
137 | |
99 | This means: the lower the speed field is (but still above MIN_ACTIVE_SPEED) |
138 | This means: the lower I<speed> is (but still above MIN_ACTIVE_SPEED) |
100 | the more seldom the object is processed. And the higher the speed field is |
139 | the more seldom the object is processed. And the higher I<speed> is |
101 | the more often the object is processed. |
140 | the more often the object is processed. |
102 | |
141 | |
|
|
142 | =item I<connected> <number> |
|
|
143 | |
|
|
144 | When this field is set the object will be linked to a connection with the |
|
|
145 | id <number>. What happens when the connection is 'activated' depends on the |
|
|
146 | type of the object. |
|
|
147 | |
|
|
148 | FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE they will control |
|
|
149 | when to activate the object, see description of these below for further details. |
|
|
150 | |
103 | =item no_drop (0|1) |
151 | =item I<no_drop> (0|1) |
104 | |
152 | |
105 | Sets the flag FLAG_NO_DROP. |
153 | Sets the flag FLAG_NO_DROP. |
106 | See Flags section below. |
154 | See Flags section below. |
107 | |
155 | |
108 | =item applied (0|1) |
156 | =item I<applied> (0|1) |
109 | |
157 | |
110 | Sets the flag FLAG_APPLIED. |
158 | Sets the flag FLAG_APPLIED. |
111 | See Flags section below. |
159 | See Flags section below. |
112 | |
160 | |
113 | =item is_used_up (0|1) |
161 | =item I<is_used_up> (0|1) |
114 | |
162 | |
115 | Sets the flag FLAG_IS_USED_UP. |
163 | Sets the flag FLAG_IS_USED_UP. |
116 | See Flags section below. |
164 | See Flags section below. |
117 | |
165 | |
|
|
166 | =item I<changing> (0|1) |
|
|
167 | |
|
|
168 | Sets the flag FLAG_CHANGING. |
|
|
169 | See Flags section below. |
|
|
170 | |
118 | =item auto_apply (0|1) |
171 | =item I<auto_apply> (0|1) |
119 | |
172 | |
120 | Sets the flag FLAG_AUTO_APPLY. |
173 | Sets the flag FLAG_AUTO_APPLY. |
121 | See Flags section below. |
174 | See Flags section below. |
122 | |
175 | |
|
|
176 | =item I<no_steal> (0|1) |
|
|
177 | |
|
|
178 | Sets the flag FLAG_NO_STEAL. |
|
|
179 | See Flags section below. |
|
|
180 | |
|
|
181 | =item I<reflecting> (0|1) |
|
|
182 | |
|
|
183 | Sets the flag FLAG_REFLECTING. |
|
|
184 | See Flags section below. |
|
|
185 | |
|
|
186 | =item I<reflect_spell> (0|1) |
|
|
187 | |
|
|
188 | Sets the flag FLAG_REFL_SPELL. |
|
|
189 | See Flags section below. |
|
|
190 | |
|
|
191 | =item I<no_skill_ident> (0|1) |
|
|
192 | |
|
|
193 | Sets the flag FLAG_NO_SKILL_IDENT. |
|
|
194 | See Flags section below. |
|
|
195 | |
123 | =item activate_on_push (0|1) (default: 1) |
196 | =item I<activate_on_push> (0|1) (default: 1) |
124 | |
197 | |
125 | Sets the flag FLAG_ACTIVATE_ON_PUSH. |
198 | Sets the flag FLAG_ACTIVATE_ON_PUSH. |
126 | See Flags section below. |
199 | See Flags section below. |
127 | |
200 | |
128 | =item activate_on_release (0|1) (default: 1) |
201 | =item I<activate_on_release> (0|1) (default: 1) |
129 | |
202 | |
130 | Sets the flag FLAG_ACTIVATE_ON_RELEASE. |
203 | Sets the flag FLAG_ACTIVATE_ON_RELEASE. |
131 | See Flags section below. |
204 | See Flags section below. |
132 | |
205 | |
|
|
206 | =item I<is_lightable> (0|1) |
|
|
207 | |
|
|
208 | Sets the flag FLAG_IS_LIGHTABLE. |
|
|
209 | See Flags section below. |
|
|
210 | |
133 | =item editable (more than deprecated) |
211 | =item I<editable> (more than deprecated) |
134 | |
212 | |
135 | This field had a special meaning for crossedit, which used parts |
213 | This field had a special meaning for crossedit, which used parts |
136 | of the server code for editing. Wherever you see this attribute being |
214 | of the server code for editing. Wherever you see this field being |
137 | set in an archetype ignore it and/or remove it. No code interprets this |
215 | set in an archetype ignore it and/or remove it. No code interprets this |
138 | field anymore. |
216 | field anymore. |
139 | |
217 | |
140 | =back |
218 | =back |
141 | |
219 | |
… | |
… | |
153 | |
231 | |
154 | This flag mostly states whether this object has been 'applied' by the player. |
232 | This flag mostly states whether this object has been 'applied' by the player. |
155 | For objects that are applied by the code or have this flag set in the archetype |
233 | For objects that are applied by the code or have this flag set in the archetype |
156 | it mostly means 'this object is active'. |
234 | it mostly means 'this object is active'. |
157 | |
235 | |
158 | For example the player adjustments of the hp/sp/grace fields and inheritance |
236 | For example the player adjustments of the I<hp>/I<sp>/I<grace> fields and inheritance |
159 | of flags from objects in his inventory is toggled by this flag. |
237 | of flags from objects in his inventory is toggled by this flag. |
160 | |
238 | |
161 | =item FLAG_IS_USED_UP |
239 | =item FLAG_IS_USED_UP |
162 | |
240 | |
163 | This flag controls whether an object is 'used up'. If it is set the 'food' field |
241 | This flag controls whether an object is 'used up'. If it is set I<food> |
164 | of the object is decreased by 1 each tick, and if it is lower or equal 0 after tha |
242 | is decreased by 1 each tick, and will be removed when I<food> is lower or equal 0. |
165 | it is removed. |
|
|
166 | |
243 | |
167 | If also the flag FLAG_APPLIED is set, the 'duration' field controls whether |
244 | If also the flag FLAG_APPLIED is set, the I<duration> field controls whether |
168 | this object is removed or not, see the Force type below for the meaning |
245 | this object is removed or not, see the B<FORCE> type below for the meaning |
169 | of the duration field in this context. |
246 | of the duration field in this context. |
170 | |
247 | |
171 | If FLAG_APPLIED is not set the object is destroyed. |
248 | If FLAG_APPLIED is not set the object is destroyed. |
172 | |
249 | |
|
|
250 | =item FLAG_CHANGING |
|
|
251 | |
|
|
252 | If the I<state> field of the object is 0 the object will be processed periodically |
|
|
253 | (if I<speed> is set). If the I<state> field is 1 it won't be processed. |
|
|
254 | |
|
|
255 | This flag indicates that the object is changing into a different object. |
|
|
256 | The object has to have the I<other_arch> field set. The object the changing object |
|
|
257 | changes into is derived from the archetype in I<other_arch>. |
|
|
258 | |
|
|
259 | When the object does not have FLAG_ALIVE set the I<food> field will be decremented |
|
|
260 | each time the object is processed, and if I<food> reaches 0 one new object will be generated. |
|
|
261 | |
|
|
262 | When the object has FLAG_ALIVE set the I<food> field is the number of objects that |
|
|
263 | will be generated. |
|
|
264 | |
|
|
265 | After the new object is created the I<hp> field from the old object is copied into |
|
|
266 | the new one. |
|
|
267 | |
|
|
268 | When the old object was a B<LAMP> it's I<food> fields value less 1 will be copied |
|
|
269 | to the new object. |
|
|
270 | |
173 | =item FLAG_IS_A_TEMPLATE (internal use) |
271 | =item FLAG_IS_A_TEMPLATE (internal use) |
174 | |
272 | |
175 | This flag is set on the inventory of generators like CREATORs and CONVERTERs, |
273 | This flag is set on the inventory of generators like B<CREATOR>s and B<CONVERTER>s, |
176 | or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set. |
274 | or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set. |
177 | |
275 | |
178 | =item FLAG_AUTO_APPLY |
276 | =item FLAG_AUTO_APPLY |
179 | |
277 | |
180 | This flag has currently only meaning for the TREASURE type, see below. |
278 | This flag has currently only meaning for the B<TREASURE> type, see below. |
181 | |
279 | |
182 | =item FLAG_ACTIVATE_ON_PUSH |
280 | =item FLAG_ACTIVATE_ON_PUSH |
183 | |
281 | |
184 | This flag has only meaning for objects that can be linked together |
282 | This flag has only meaning for objects that can be linked together |
185 | with the 'connected' field and controls wether the object should |
283 | by the I<connected> field and controls wether the object should |
186 | be activated when the connection is 'pushed' or it is 'released'. |
284 | be activated when the connection is 'pushed' or it is 'released'. |
187 | |
285 | |
|
|
286 | What 'pushed' and 'released' means depends on the object that |
|
|
287 | activates the connection. |
|
|
288 | |
188 | This flag is by default on. |
289 | This flag is by default on. |
189 | |
290 | |
190 | =item FLAG_ACTIVATE_ON_RELEASE |
291 | =item FLAG_ACTIVATE_ON_RELEASE |
191 | |
292 | |
192 | This flag has only meaning for objects that can be linked together |
293 | This flag has only meaning for objects that can be linked together |
193 | with the 'connected' field and controls wether the object should |
294 | by the I<connected> field and controls wether the object should |
194 | be activated when the connection is 'pushed' or it is 'released'. |
295 | be activated when the connection is 'pushed' or it is 'released'. |
195 | |
296 | |
|
|
297 | What 'pushed' and 'released' means depends on the object that |
|
|
298 | activates the connection. |
|
|
299 | |
196 | This flag is by default on. |
300 | This flag is by default on. |
197 | |
301 | |
198 | =back |
302 | =item FLAG_NO_STEAL |
199 | |
303 | |
200 | =head2 Description of type specific attributes |
304 | When this flag is set this object can't be stolen. The flag will be |
|
|
305 | resetted once the object is placed on a map. |
|
|
306 | |
|
|
307 | When this flag is set on a monster it can defent attempts of stealing |
|
|
308 | (but in this context the flag is only used internally). |
|
|
309 | |
|
|
310 | =item FLAG_NO_SKILL_IDENT |
|
|
311 | |
|
|
312 | This flag is mostly used internal and prevents unidentified objects |
|
|
313 | (objects which don't have FLAG_IDENTIFIED set) being identified |
|
|
314 | multiple times by skills. |
|
|
315 | |
|
|
316 | This flag is used to mark objects which were unsuccessfully identified by a |
|
|
317 | players skill. So that multiple tries of identifying aren't more effective than |
|
|
318 | one. |
|
|
319 | |
|
|
320 | =item FLAG_REFLECTING |
|
|
321 | |
|
|
322 | This flag is used by spell effects (eg. SP_BOLT), B<THROWN_OBJ> and B<ARROW> |
|
|
323 | to indicate whether this object reflects off walls. |
|
|
324 | |
|
|
325 | =item FLAG_REFL_SPELL |
|
|
326 | |
|
|
327 | This flag indicates whether something reflects spells, like spell reflecting |
|
|
328 | amuletts. |
|
|
329 | |
|
|
330 | =item FLAG_IS_LIGHTABLE |
|
|
331 | |
|
|
332 | This flag indicates whether a B<LIGHTER> can light this object. See also the |
|
|
333 | description of the B<LIGHTER> type. How easy you can light an item depends |
|
|
334 | partially on the material of the object. |
|
|
335 | |
|
|
336 | =back |
|
|
337 | |
|
|
338 | =head2 Description of type specific fields and behaviour |
201 | |
339 | |
202 | The beginning of the headers of the following subsection |
340 | The beginning of the headers of the following subsection |
203 | are the server internal names for the objects types, see include/define.h. |
341 | are the server internal names for the objects types, see include/define.h. |
204 | |
342 | |
205 | =head3 TRANSPORT - type 2 - Player transports |
343 | =head3 B<TRANSPORT> - type 2 - Player transports |
206 | |
344 | |
207 | This type is implemented by the transport extension and has currently no special |
345 | This type is implemented by the transport extension and has currently no special |
208 | attributes that affect it. |
346 | fields that affect it. |
209 | |
347 | |
210 | =head3 ROD - type 3 - Rods that fire spells |
348 | =head3 B<ROD> - type 3 - Rods that fire spells |
211 | |
349 | |
212 | Rods contain spells and can be fired by a player. |
350 | Rods contain spells and can be fired by a player. |
213 | |
351 | |
214 | =over 4 |
352 | =over 4 |
215 | |
353 | |
216 | =item level <number> |
354 | =item I<level> <number> |
217 | |
355 | |
218 | This attribute is used for calculating the spell level that can be fired |
356 | This field is used for calculating the spell level that can be fired |
219 | with this rod, it's also the maximum level of the spell that can be fired. |
357 | with this rod, it's also the maximum level of the spell that can be fired. |
220 | The level of the spell that is being fired depends mostly on |
358 | The level of the spell that is being fired depends mostly on |
221 | the 'use magic item' skill level of the player and 1/10 of the level of the |
359 | the 'use magic item' skill level of the player and 1/10 of the level of the |
222 | rod is added as bonus. |
360 | rod is added as bonus. |
223 | |
361 | |
224 | =item hp <number> |
362 | =item I<hp> <number> |
225 | |
363 | |
226 | The amount of spellpoints this rod has left. |
364 | The amount of spellpoints this rod has left. |
227 | |
365 | |
228 | =item maxhp <number> |
366 | =item I<maxhp> <number> |
229 | |
367 | |
230 | The maximum amount of spellpoints this rod has. |
368 | The maximum amount of spellpoints this rod has. |
231 | |
369 | |
232 | =item skill <skill name> |
370 | =item I<skill> <skill name> |
233 | |
371 | |
234 | This field determines which skill you need to apply this object. |
372 | This field determines which skill you need to apply this object. |
235 | |
373 | |
236 | =back |
374 | =back |
237 | |
375 | |
238 | =head3 TREASURE - type 4 - Treasures |
376 | =head3 B<TREASURE> - type 4 - Treasures |
239 | |
377 | |
240 | This type of objects are for random treasure generation in maps. |
378 | This type of objects are for random treasure generation in maps. |
241 | If this object is applied by a player it will replace itself with it's |
379 | If this object is applied by a player it will replace itself with it's |
242 | inventory. If it is automatically applied |
380 | inventory. If it is automatically applied |
243 | generate a treasure and replace itself with the generated treasure. |
381 | generate a treasure and replace itself with the generated treasure. |
… | |
… | |
245 | Chests are also of this type, their treasures are generated by |
383 | Chests are also of this type, their treasures are generated by |
246 | the auto apply code on map instantiation. |
384 | the auto apply code on map instantiation. |
247 | |
385 | |
248 | =over 4 |
386 | =over 4 |
249 | |
387 | |
250 | =item hp <number> |
388 | =item I<hp> <number> |
251 | |
389 | |
252 | The number of treasures to generate. |
390 | The number of treasures to generate. |
253 | |
391 | |
254 | =item exp <level> |
392 | =item I<exp> <level> |
255 | |
393 | |
256 | If FLAG_AUTO_APPLY is not set the exp field has no further meaning |
394 | If FLAG_AUTO_APPLY is not set the exp field has no further meaning |
257 | and the difficulty for the treasurecode only depends on the maps difficulty, |
395 | and the difficulty for the treasurecode only depends on the maps difficulty, |
258 | otherwise the exp field has the following meaning: |
396 | otherwise the exp field has the following meaning: |
259 | |
397 | |
… | |
… | |
262 | worth a treasure is or what bonuses it is given by the treasure code. |
400 | worth a treasure is or what bonuses it is given by the treasure code. |
263 | |
401 | |
264 | If this field is not set or 0 the difficulty of the map is passed to the treasure |
402 | If this field is not set or 0 the difficulty of the map is passed to the treasure |
265 | generation code. |
403 | generation code. |
266 | |
404 | |
267 | =item randomitems <treasurelist> |
405 | =item I<randomitems> <treasurelist> |
268 | |
406 | |
269 | The treasurelist to use to generate the treasure which is put in the |
407 | The treasurelist to use to generate the treasure which is put in the |
270 | treasure objects inventory. |
408 | treasure objects inventory. |
271 | |
409 | |
272 | =back |
410 | =back |
273 | |
411 | |
274 | =head3 POTION - type 5 - Potions for drinking and other nastynesses |
412 | =head3 B<POTION> - type 5 - Potions for drinking and other nastynesses |
275 | |
413 | |
276 | These objects contain a spell and will emit it on apply, which most |
414 | These objects contain a spell and will emit it on apply, which most |
277 | of the time has the meaning of 'drinking'. |
415 | of the time has the meaning of 'drinking'. |
278 | |
416 | |
279 | If no resistancy field, stat field or attacktype is set and no spell |
417 | If no resistancy field, stat field or attacktype is set and no spell |
… | |
… | |
284 | If the potion has FLAG_CURSED or FLAG_DAMNED set the usage of this potion |
422 | If the potion has FLAG_CURSED or FLAG_DAMNED set the usage of this potion |
285 | will yield an explosion and hurt the player. |
423 | will yield an explosion and hurt the player. |
286 | |
424 | |
287 | =over 4 |
425 | =over 4 |
288 | |
426 | |
289 | =item Str, Dex, Con, Int, Wis, Cha, Pow <number> |
427 | =item I<Str>, I<Dex>, I<Con>, I<Int>, I<Wis>, I<Cha>, I<Pow> <number> |
290 | |
428 | |
291 | These stat fields determine how many stat points the player gets |
429 | These stat fields determine how many stat points the player gets |
292 | when he applies this potion. |
430 | when he applies this potion. |
293 | |
431 | |
294 | If FLAG_CURSED or FLAG_DAMNED is set the player will loose that many stat points. |
432 | If FLAG_CURSED or FLAG_DAMNED is set the player will loose that many stat points. |
295 | |
433 | |
296 | =item sp <number> |
434 | =item I<sp> <number> |
297 | |
435 | |
298 | If this field is set and the randomitems field is not set |
436 | If this field is set and the randomitems field is not set |
299 | the field is interpreted as spell number, please look the right |
437 | the field is interpreted as spell number, please look the right |
300 | number up in common/loader.C. |
438 | number up in common/loader.C. |
301 | |
439 | |
302 | If this field is set the randomitems field will be unset by the |
440 | If this field is set the randomitems field will be unset by the |
303 | map loading code. |
441 | map loading code. |
304 | |
442 | |
305 | =item attacktype <attacktype> |
443 | =item I<attacktype> <attacktype> |
306 | |
444 | |
307 | This field has some special meaning in potions, currently the |
445 | This field has some special meaning in potions, currently the |
308 | bits for AT_DEPLETE and AT_GODPOWER control whethere this is a |
446 | bits for AT_DEPLETE and AT_GODPOWER control whethere this is a |
309 | restoration potion or improvement potion. |
447 | restoration potion or improvement potion. |
310 | See include/attackinc.h for the bits of these types. |
448 | See include/attackinc.h for the bits of these types. |
… | |
… | |
315 | into him. |
453 | into him. |
316 | |
454 | |
317 | If AT_GODPOWER is enabled the player will gain +1 maxvalue in his hp, sp or grace stat. |
455 | If AT_GODPOWER is enabled the player will gain +1 maxvalue in his hp, sp or grace stat. |
318 | When the potion has FLAG_CURSED or FLAG_DAMNED set he will loose one in one of these stats. |
456 | When the potion has FLAG_CURSED or FLAG_DAMNED set he will loose one in one of these stats. |
319 | |
457 | |
320 | =item resist_<resistancy> <number> |
458 | =item I<resist_RESISTANCY> <number> |
321 | |
459 | |
322 | If this stat is set and no spell is in the potion the potion |
460 | If this stat is set and no spell is in the potion the potion |
323 | will create a force that give the player this specific resistancy. |
461 | will create a force that give the player this specific resistancy. |
324 | The forces type will be changed to POTION_EFFECT (see POTION_EFFECT type below) |
462 | The forces type will be changed to POTION_EFFECT (see POTION_EFFECT type below) |
325 | and the potion will last 10 times longer than the default force archetype |
463 | and the potion will last 10 times longer than the default force archetype |
326 | FORCE_NAME (at the moment of this writing spell/force.arc). |
464 | FORCE_NAME (at the moment of this writing spell/force.arc). |
327 | |
465 | |
328 | =item randomitems <treasurelist> |
466 | =item I<randomitems> <treasurelist> |
329 | |
467 | |
330 | The inventory/spell of the potion will be created by calling the treasure code |
468 | The inventory/spell of the potion will be created by calling the treasure code |
331 | with the treasurelist specified here. (I guess it's highly undefined what |
469 | with the treasurelist specified here. (I guess it's highly undefined what |
332 | happens if there is not a spell in the potions inventory). |
470 | happens if there is not a spell in the potions inventory). |
333 | |
471 | |
334 | =item on_use_yield <archetype> |
472 | =item I<on_use_yield> <archetype> |
335 | |
473 | |
336 | When this object is applied an instance of <archetype> will be created. |
474 | When this object is applied an instance of <archetype> will be created. |
337 | |
475 | |
338 | =item subtypes <potion subtype> |
476 | =item I<subtypes> <potion subtype> |
339 | |
477 | |
340 | see include/spells.h for possible potion subtypes, there are currently 4: |
478 | see include/spells.h for possible potion subtypes, there are currently 4: |
341 | |
479 | |
342 | =over 4 |
480 | =over 4 |
343 | |
481 | |
… | |
… | |
346 | Unused, default behaiour of a potion. |
484 | Unused, default behaiour of a potion. |
347 | |
485 | |
348 | =item POT_DUST |
486 | =item POT_DUST |
349 | |
487 | |
350 | This potion can be thrown to cast the spell that it has in it's inventory, |
488 | This potion can be thrown to cast the spell that it has in it's inventory, |
351 | the behaviour is not defined if there is not a spell in the inventory and the |
489 | the behaviour is not defined if there is not a B<SPELL> in the inventory and the |
352 | server will log an error. |
490 | server will log an error. |
353 | |
491 | |
354 | =item POT_FIGURINE |
492 | =item POT_FIGURINE |
355 | |
493 | |
356 | Unused, default behaiour of a potion. |
494 | Unused, default behaiour of a potion. |
… | |
… | |
361 | |
499 | |
362 | =back |
500 | =back |
363 | |
501 | |
364 | =back |
502 | =back |
365 | |
503 | |
366 | =head3 FOOD - type 6 - Eatable stuff |
504 | =head3 B<FOOD> - type 6 - Eatable stuff |
367 | |
505 | |
368 | This is for objects that are representing general eatables like |
506 | This is for objects that are representing general eatables like |
369 | beef or bread. |
507 | beef or bread. |
370 | |
508 | |
371 | The main difference between FOOD, FLESH and DRINK is that they |
509 | The main difference between B<FOOD>, B<FLESH> and B<DRINK> is that they |
372 | give different messages. |
510 | give different messages. |
373 | |
511 | |
374 | The specialty of FLESH is that it inherits the resistancies of the |
512 | The specialty of B<FLESH> is that it inherits the resistancies of the |
375 | monsters it was generated in and will let dragons raise their resistancies |
513 | monsters it was generated in and will let dragons raise their resistancies |
376 | with that. |
514 | with that. If the monster has the B<POISON> attacktype the B<FLESH> |
|
|
515 | will change into B<POISON>. |
377 | |
516 | |
378 | If a player runs low on food he will grab for FOOD, DRINK and POISON |
517 | If a player runs low on food he will grab for B<FOOD>, B<DRINK> and B<POISON> |
379 | and if he doesn't find any of that he will start eating FLESH. |
518 | and if he doesn't find any of that he will start eating B<FLESH>. |
380 | |
519 | |
381 | =over 4 |
520 | =over 4 |
382 | |
521 | |
383 | =item title <string> |
522 | =item I<title> <string> |
384 | |
523 | |
385 | If the food has a title or is cursed it is considered 'special', which means that the |
524 | If the food has B<title> set or is cursed it is considered 'special', which |
386 | fields Str, Dex, Con, Int, Wis, Pow, resist_<resistancy>, hp and sp |
525 | means that the fields I<Str>, I<Dex>, I<Con>, I<Int>, I<Wis>, I<Pow>, |
387 | are interpreted and have further effects on the player. |
526 | I<resist_RESISTANCY>, I<hp> and I<sp> are interpreted and have further effects |
|
|
527 | on the player. |
388 | |
528 | |
389 | The higher the food field is the longer the improvement of the player lasts |
529 | The higher the I<food> field is the longer the improvement of the player lasts |
390 | (except for hp and sp). |
530 | (except for I<hp> and I<sp>). |
391 | |
531 | |
392 | =item food <number> |
532 | =item I<food> <number> |
393 | |
533 | |
394 | This is the amount of food points the player gets when he eats this. |
534 | This is the amount of food points the player gets when he eats this. |
395 | |
535 | |
396 | =item on_use_yield <archetype> |
536 | =item I<on_use_yield> <archetype> |
397 | |
537 | |
398 | When this object is applied an instance of <archetype> will be created. |
538 | When this object is applied an instance of <archetype> will be created. |
399 | |
539 | |
400 | =back |
540 | =back |
401 | |
541 | |
|
|
542 | =head3 B<POISON> - type 7 - Poisonous stuff |
|
|
543 | |
|
|
544 | This type is for objects that can poison the player when he drinks/applies it. |
|
|
545 | When applied it will hit the attacked with AT_POISON and will create |
|
|
546 | a B<POISONING> object in the one who was hit. |
|
|
547 | |
|
|
548 | =over 4 |
|
|
549 | |
|
|
550 | =item I<level> <number> |
|
|
551 | |
|
|
552 | This field affects the propability of poisoning. The higher the level difference |
|
|
553 | between the one who is hit and the poision the more propable it is the attacked |
|
|
554 | one will be poisoned. |
|
|
555 | |
|
|
556 | =item I<slaying> <race> |
|
|
557 | |
|
|
558 | This field has the usual meaning of 'slaying', when the |
|
|
559 | poisoned's race matches the I<slaying> field the damage done by the poison |
|
|
560 | is multiplied by 3. |
|
|
561 | |
|
|
562 | =item I<hp> <number> |
|
|
563 | |
|
|
564 | This is the amount of damage the player will receive from applying this. The |
|
|
565 | attacktype AT_POISON will be used to hit the player and the damage will |
|
|
566 | determine the strenght, duration and depletion of stats of the poisoning. The |
|
|
567 | created B<POISONING> object which is being placed in the one who was attacked will |
|
|
568 | get the damage from this field (which is maybe adjusted by slaying or the |
|
|
569 | resistancies). |
|
|
570 | |
|
|
571 | =item I<food> <number> |
|
|
572 | |
|
|
573 | 1/4 of <number> will be drained from the players I<food>. |
|
|
574 | |
|
|
575 | =item I<on_use_yield> <archetype> |
|
|
576 | |
|
|
577 | When this object is applied an instance of <archetype> will be created. |
|
|
578 | |
|
|
579 | =back |
|
|
580 | |
|
|
581 | =head3 B<BOOK> - type 8 - Readable books |
|
|
582 | |
|
|
583 | This type is basically for representing text books in the game. |
|
|
584 | |
|
|
585 | Reading a book also identifys it (if FLAG_NO_SKILL_IDENT is not set). |
|
|
586 | |
|
|
587 | =over 4 |
|
|
588 | |
|
|
589 | =item I<msg> <text> |
|
|
590 | |
|
|
591 | This is the contents of the book. When this field is unset |
|
|
592 | at treasure generation a random text will be inserted. |
|
|
593 | |
|
|
594 | =item I<skill> <skill name> |
|
|
595 | |
|
|
596 | The skill required to read this book. (The most resonable |
|
|
597 | skill would be literacy). |
|
|
598 | |
|
|
599 | =item I<exp> <number> |
|
|
600 | |
|
|
601 | The experience points the player get for reading this book. |
|
|
602 | |
|
|
603 | =item I<subtype> <readable subtype> |
|
|
604 | |
|
|
605 | This field determines the type of the readable. |
|
|
606 | Please see common/readable.C in the readable_message_types table. |
|
|
607 | |
|
|
608 | =back |
|
|
609 | |
|
|
610 | =head3 B<CLOCK> - type 9 - Clocks |
|
|
611 | |
|
|
612 | This type of objects just display the time when being applied. |
|
|
613 | |
|
|
614 | =head3 B<LIGHTNING> - type 12 - Lightnings (DEPRECATED: see B<SPELL_EFFECT> subtype SP_BOLT) |
|
|
615 | |
|
|
616 | This is a spell effect of a moving bolt. It moves straigt forward |
|
|
617 | through the map until something blocks it. |
|
|
618 | If FLAG_REFLECTING is set it even reflects on walls. |
|
|
619 | |
|
|
620 | FLAG_IS_TURNABLE should be set on these objects. |
|
|
621 | |
|
|
622 | =over 4 |
|
|
623 | |
|
|
624 | =item I<move_type> <movetype> |
|
|
625 | |
|
|
626 | This field affects the move type with which the lightning moves through |
|
|
627 | the map and which map cells will reflect or block it. |
|
|
628 | |
|
|
629 | =item I<attacktype> <attacktype> |
|
|
630 | |
|
|
631 | The attacktype with which it hits the objects on the map. |
|
|
632 | |
|
|
633 | =item I<dam> <number> |
|
|
634 | |
|
|
635 | The damage this bolt inflicts when it hits objects on the map. |
|
|
636 | |
|
|
637 | =item I<Dex> <number> |
|
|
638 | |
|
|
639 | This is the fork percentage, it is reduced by 10 per fork. |
|
|
640 | And the I<dam> field is halved on each fork. |
|
|
641 | |
|
|
642 | =item I<Con> (internal) |
|
|
643 | |
|
|
644 | This value is a percentage of which the forking lightning |
|
|
645 | is deflected to the left. This value should be mostly used internally. |
|
|
646 | |
|
|
647 | =item I<duration> <number> |
|
|
648 | |
|
|
649 | The duration the bolt stays on a map cell. This field is decreased each time |
|
|
650 | the object is processed (see the meaning of I<speed> and I<speed_left> fields in |
|
|
651 | the generic object field description). |
|
|
652 | |
|
|
653 | =item I<range> <number> |
|
|
654 | |
|
|
655 | This is the range of the bolt, each space it advances this field is decreased. |
|
|
656 | |
|
|
657 | =back |
|
|
658 | |
|
|
659 | =head3 B<ARROW> - type 13 - Arrows |
|
|
660 | |
|
|
661 | This is the type for objects that represent projectiles like arrows. |
|
|
662 | The movement of B<THROWN_OBJ>s behave similar to this type. |
|
|
663 | |
|
|
664 | Flying arrows are stopped either when they hit something blocking |
|
|
665 | (I<move_block>) or something which is alive. |
|
|
666 | If it hits something that is alive, which doesn't have FLAG_REFL_MISSILE |
|
|
667 | set, it will inflict damage. If FLAG_REFL_MISSILE is set it will inflict |
|
|
668 | damage with a small chance which is affected by the I<level> field of the arrow. |
|
|
669 | |
|
|
670 | If FLAG_REFLECTING is set on the arrow it will bounce off everything |
|
|
671 | that is not alive and blocks it's movement. |
|
|
672 | |
|
|
673 | When an arrow is being shot it's I<dam>, I<wc>, I<attacktype>, I<slaying> |
|
|
674 | fields will be saved in the I<sp>, I<hp>, I<grace> and I<spellarg> fields of |
|
|
675 | the object, to restore them once the arrow has been stopped. |
|
|
676 | |
|
|
677 | =over 4 |
|
|
678 | |
|
|
679 | =item I<dam> <number> |
|
|
680 | |
|
|
681 | The amount of damage that is being done to the victim that gets hit. |
|
|
682 | This field is recomputed when the arrow is fired and will consist |
|
|
683 | of the sum of a damage bonus (see description of the B<BOW> type), |
|
|
684 | the arrows I<dam> field, the bows I<dam> field, the bows I<magic> field |
|
|
685 | and the arrows I<magic> field. |
|
|
686 | |
|
|
687 | =item I<wc> <number> |
|
|
688 | |
|
|
689 | The weapon class of the arrow, which has effect on the propability of hitting. |
|
|
690 | |
|
|
691 | It is recomputed when the arrow is being fired by this formula: |
|
|
692 | |
|
|
693 | wc = 20 - bow->magic - arrow->magic - (skill->level or shooter->level) |
|
|
694 | - dex_bonus - thaco_bonus - arrow->stats.wc - bow->stats.wc + wc_mod |
|
|
695 | |
|
|
696 | When the arrow is not being shot by an player dex_bonus and thaco_bonus and the |
|
|
697 | level is not added. |
|
|
698 | |
|
|
699 | wc_mod is dependend on the fire mode of the bow. For a more detailed |
|
|
700 | explanation of dex_bonus, thaco_bonus and wc_mod please consult the code. |
|
|
701 | |
|
|
702 | =item I<magic> <number> |
|
|
703 | |
|
|
704 | This field is added to the damage of the arrow when it is shot and |
|
|
705 | will also improve it's I<speed> by 1/5 of it's value. |
|
|
706 | |
|
|
707 | =item I<attacktype> <attacktype> |
|
|
708 | |
|
|
709 | Bitfield which decides the attacktype of the damage, see include/attackinc.h |
|
|
710 | On fireing the I<attacktype> of the bow is added to the arrows I<attacktype>. |
|
|
711 | |
|
|
712 | =item I<level> <number> (interally used) |
|
|
713 | |
|
|
714 | The level of the arrow, this affects the propability of piercing FLAG_REFL_MISSILE, |
|
|
715 | see above in the B<ARROW> description. |
|
|
716 | |
|
|
717 | The I<level> is set when the arrow is fired to either the skill level or the |
|
|
718 | shooters level. |
|
|
719 | |
|
|
720 | =item I<speed> <number> (internal) |
|
|
721 | |
|
|
722 | This field shouldn't be set directly in the archetype, the arrow will get it's |
|
|
723 | I<speed> from the bow. This fields value has to be at least 0.5 or otherwise the |
|
|
724 | arrow will be stopped immediatly. |
|
|
725 | |
|
|
726 | On fireing the I<speed> of the arrow is computed of 1/5 of the |
|
|
727 | sum of the damage bonus (see BOW), bow I<magic> and arrow I<magic>. After that 1/7 |
|
|
728 | of the bows I<dam> field is added to the I<speed> of the arrow. |
|
|
729 | |
|
|
730 | The minimum I<speed> of an arrow is 1.0. |
|
|
731 | |
|
|
732 | While flying the arrows I<speed> is decreased by 0.05 each time it's moved. |
|
|
733 | |
|
|
734 | If the I<speed> is above 10.0 it goes straight through the creature it hits and |
|
|
735 | it's I<speed> is reduced by 1. If the I<speed> is lower or equal 10.0 the arrow is |
|
|
736 | stopped and either sticked into the victim (see I<weight> field description) or |
|
|
737 | put on it's map square (if it didn't break, see description of the I<food> field). |
|
|
738 | |
|
|
739 | =item I<weight> <number> |
|
|
740 | |
|
|
741 | This field is the weight of the arrow, if I<weight> is below or equal 5000 (5 kg) |
|
|
742 | the arrow will stick in the victim it hits. Otherwise it will fall to the ground. |
|
|
743 | |
|
|
744 | =item I<food> <number> |
|
|
745 | |
|
|
746 | The breaking percentage. 100 (%) means: breaks on usage for sure. |
|
|
747 | |
|
|
748 | =item I<inventory> (internal) |
|
|
749 | |
|
|
750 | If the flying/moving object has something in it's inventory and it stops, it |
|
|
751 | will be replaced with it's inventory. Otherwise it will be handled as usual, |
|
|
752 | which means: it will be calculated whether the arrow breaks and it will be |
|
|
753 | reset for reuse. |
|
|
754 | |
|
|
755 | =item I<slaying> <string> |
|
|
756 | |
|
|
757 | When the bow that fires this arrow has it's I<slaying> field set it is copied |
|
|
758 | to the arrows I<slaying> field. Otherwise the arrows I<slaying> field remains. |
|
|
759 | |
|
|
760 | =item I<move_type> <movetype> (internally used) |
|
|
761 | |
|
|
762 | This field is set when the arrow is shot to MOVE_FLY_LOW. |
|
|
763 | |
|
|
764 | =item I<move_on> <movetype> (internally used) |
|
|
765 | |
|
|
766 | This field is set when the arrow is shot to MOVE_FLY_LOW and MOVE_WALK. |
|
|
767 | |
|
|
768 | =item I<race> <string> |
|
|
769 | |
|
|
770 | The I<race> field is a unique key that assigns arrows, bows and quivers. When |
|
|
771 | shooting an arrow the bows I<race> is used to search for arrows (which have the |
|
|
772 | same I<race> as the bow) in the players inventory and will recursively search in |
|
|
773 | the containers (which are applied and have the same I<race> as the bow and the arrow). |
|
|
774 | |
|
|
775 | =back |
|
|
776 | |
|
|
777 | =head3 B<BOW> - type 14 - Bows, those that fire B<ARROW>s |
|
|
778 | |
|
|
779 | TODO, but take into account B<ARROW> description above! |
|
|
780 | |
402 | =head3 WEAPON - type 15 - Weapons |
781 | =head3 B<WEAPON> - type 15 - Weapons |
403 | |
782 | |
404 | This type is for general hack and slash weapons like swords, maces |
783 | This type is for general hack and slash weapons like swords, maces |
405 | and daggers and and .... |
784 | and daggers and and .... |
406 | |
785 | |
407 | =over 4 |
786 | =over 4 |
408 | |
787 | |
409 | =item weapontype <type id> |
788 | =item I<weapontype> <type id> |
410 | |
789 | |
411 | decides what attackmessages are generated, see include/define.h |
790 | decides what attackmessages are generated, see include/define.h |
412 | |
791 | |
413 | =item attacktype <bitmask> |
792 | =item I<attacktype> <bitmask> |
414 | |
793 | |
415 | bitfield which decides the attacktype of the damage, see include/attackinc.h |
794 | bitfield which decides the attacktype of the damage, see include/attackinc.h |
416 | |
795 | |
417 | =item dam <number> |
796 | =item I<dam> <number> |
418 | |
797 | |
419 | amount of damage being done with the attacktype |
798 | amount of damage being done with the attacktype |
420 | |
799 | |
421 | =item item_power <level> |
800 | =item I<item_power> <level> |
422 | |
801 | |
423 | the itempower of this weapon. |
802 | the itempower of this weapon. |
424 | |
803 | |
425 | =item name |
804 | =item I<name> |
426 | |
805 | |
427 | the name of the weapon. |
806 | the name of the weapon. |
428 | |
807 | |
429 | =item level (internal) |
808 | =item I<level> (internal) |
430 | |
809 | |
431 | The improvement state of the weapon. |
810 | The improvement state of the weapon. |
432 | If this field is greater than 0 the 'name' field starts with the |
811 | If this field is greater than 0 the I<name> field starts with the |
433 | characters name who improved this weapon. |
812 | characters name who improved this weapon. |
434 | |
813 | |
435 | =item last_eat (internal) |
814 | =item I<last_eat> (internal) |
436 | |
815 | |
437 | seems to be the amount of improvements of a weapon, |
816 | This seems to be the amount of improvements of a weapon, |
438 | the formular for equipping a weapon seems to be (server/apply.C:check_weapon_power): |
817 | the formular for equipping a weapon seems to be (server/apply.C:check_weapon_power): |
439 | |
818 | |
440 | ((who->level / 5) + 5) >= op->last_eat |
819 | ((who->level / 5) + 5) >= op->last_eat |
441 | |
820 | |
442 | =item last_sp |
821 | =item I<last_sp> |
443 | |
822 | |
444 | the weapon speed (see magic description) |
823 | the weapon speed (see magic description) |
445 | |
824 | |
446 | =item food <number> |
825 | =item I<food> <number> |
447 | |
826 | |
448 | addition to food regeneration of the player |
827 | addition to food regeneration of the player |
449 | |
828 | |
450 | =item hp <number> |
829 | =item I<hp> <number> |
451 | |
830 | |
452 | addition to health regeneration |
831 | addition to health regeneration |
453 | |
832 | |
454 | =item sp <number> |
833 | =item I<sp> <number> |
455 | |
834 | |
456 | addition to mana regeneration |
835 | addition to mana regeneration |
457 | |
836 | |
458 | =item grace <number> |
837 | =item I<grace> <number> |
459 | |
838 | |
460 | addititon to grace regeneration |
839 | addititon to grace regeneration |
461 | |
840 | |
462 | =item gen_sp_armour <number> |
841 | =item I<gen_sp_armour> <number> |
463 | |
842 | |
464 | the players gen_sp_armour field (which is per default 10) is added the <number> amount. |
843 | the players I<gen_sp_armour> field (which is per default 10) is being added the |
465 | gen_sp_armour seems to be a factor with which gen_sp in do_some_living() |
844 | <number> amount. gen_sp_armour seems to be a factor with which gen_sp in |
466 | is multiplied: gen_sp *= 10/<number> |
845 | do_some_living() is multiplied: gen_sp *= 10/<number> meaning: values > 10 of |
467 | meaning: values > 10 of gen_sp_armour limits the amout of regenerated |
846 | I<gen_sp_armour> limits the amout of regenerated spellpoints. |
468 | spellpoints. |
|
|
469 | |
847 | |
470 | generally this field on weapons is in ranges of 1-30 and decides the slowdown of the |
848 | Generally this field on weapons is in ranges of 1-30 and decides the slowdown of the |
471 | sp regeneration. |
849 | I<sp> regeneration. |
472 | |
850 | |
473 | =item body_<body slot/part> |
851 | =item I<body_BODYSLOT> |
474 | |
852 | |
475 | the part of the body you need to use this weapon, possible values should be |
853 | The part of the body you need to use this weapon, possible values should be |
476 | looked up in common/item.C at body_locations. |
854 | looked up in common/item.C at body_locations. |
477 | |
855 | |
478 | =item resist_<resistnacy> <number> |
856 | =item I<resist_RESISTNACY> <number> |
479 | |
857 | |
480 | this is the factor with which the difference of the players resistancy and 100% |
858 | this is the factor with which the difference of the players resistancy and 100% |
481 | is multiplied, something like this: |
859 | is multiplied, something like this: |
482 | |
860 | |
483 | additional_resistancy = (100 - current_resistanct) * (<number>/100) |
861 | additional_resistancy = (100 - current_resistanct) * (<number>/100) |
… | |
… | |
487 | |
865 | |
488 | 'total resistance = total protections - total vulnerabilities' |
866 | 'total resistance = total protections - total vulnerabilities' |
489 | |
867 | |
490 | see also common/living.C:fix_player |
868 | see also common/living.C:fix_player |
491 | |
869 | |
492 | =item patch_(attuned|repelled|denied) |
870 | =item I<path_(attuned|repelled|denied)> |
493 | |
871 | |
494 | this field modifies the pathes the player is attuned to, see include/spells.h PATH_* |
872 | this field modifies the pathes the player is attuned to, see include/spells.h PATH_* |
495 | for the pathes. |
873 | for the pathes. |
496 | |
874 | |
497 | =item luck <number> |
875 | =item I<luck> <number> |
498 | |
876 | |
499 | this luck is added to the players luck |
877 | this luck is added to the players I<luck> |
500 | |
878 | |
501 | =item move_type |
879 | =item I<move_type> |
502 | |
880 | |
503 | if the weapon has a move_type set the player inherits it's move_type |
881 | if the weapon has a I<move_type> set the player inherits it's I<move_type> |
504 | |
882 | |
505 | =item exp <number> |
883 | =item I<exp> <number> |
506 | |
884 | |
507 | the added_speed and bonus_speed of the player is raised by <number>/3. |
885 | the added_speed and bonus_speed of the player is raised by <number>/3. |
508 | if <number> < 0 then the added_speed is decreased by <number> |
886 | if <number> < 0 then the added_speed is decreased by <number> |
509 | |
887 | |
510 | =item weight |
888 | =item I<weight> |
511 | |
889 | |
512 | the weight of the weapon |
890 | the weight of the weapon |
513 | |
891 | |
514 | =item magic |
892 | =item I<magic> |
515 | |
893 | |
516 | the magic field affects the amounts of the following fields: |
894 | the I<magic> field affects the amounts of the following fields: |
517 | |
895 | |
518 | - wc : the players wc is adjusted by: player->wc -= (wc + magic) |
896 | - wc : the players wc is adjusted by: player->wc -= (wc + magic) |
519 | |
897 | |
520 | - ac : the players ac is lowered by (ac + magic) if (player->ac + magic) > 0 |
898 | - ac : the players ac is lowered by (ac + magic) if (player->ac + magic) > 0 |
521 | |
899 | |
522 | - dam: the players dam is adjusted by: player->dam += (dam + magic) |
900 | - dam: the players dam is adjusted by: player->dam += (dam + magic) |
523 | |
901 | |
524 | - weapon speed (last_sp): weapon_speed is calculated by: (last_sp * 2 - magic) / 2 |
902 | - weapon speed (last_sp): weapon_speed is calculated by: (last_sp * 2 - magic) / 2 |
525 | (minium is 0) |
903 | (minium is 0) |
526 | |
904 | |
527 | =item ac <number> |
905 | =item I<ac> <number> |
528 | |
906 | |
529 | the amount of ac points the player's ac is decreased |
907 | the amount of ac points the player's I<ac> is decreased when applying this object. |
530 | |
908 | |
531 | =item wc <number> |
909 | =item I<wc> <number> |
532 | |
910 | |
533 | the amount of wc points the player's wc is decreased |
911 | the amount of wc points the player's I<wc> is decreased when applying this object. |
534 | |
912 | |
535 | =back |
913 | =back |
536 | |
914 | |
537 | =head4 Player inherits following flags from weapons: |
915 | =head4 Player inherits following flags from weapons: |
538 | |
916 | |
… | |
… | |
543 | FLAG_XRAYS |
921 | FLAG_XRAYS |
544 | FLAG_BLIND |
922 | FLAG_BLIND |
545 | FLAG_SEE_IN_DARK |
923 | FLAG_SEE_IN_DARK |
546 | FLAG_UNDEAD |
924 | FLAG_UNDEAD |
547 | |
925 | |
|
|
926 | =head3 B<GRIMREAPER> - type 28 - Grimreapers |
|
|
927 | |
|
|
928 | These type are mostly used for monsters, they give the |
|
|
929 | monster the ability to dissapear after 10 hits with AT_DRAIN. |
|
|
930 | |
|
|
931 | =over 4 |
|
|
932 | |
|
|
933 | =item I<value> <number> |
|
|
934 | |
|
|
935 | This field stores the hits the monster did yet. |
|
|
936 | |
|
|
937 | =back |
|
|
938 | |
|
|
939 | =head3 B<CREATOR> - type 42 - Object creators |
|
|
940 | |
|
|
941 | Once a creator is activated by a connection it creates a number of objects |
|
|
942 | (cloned from it's inventory or a new object derived from the archetype |
|
|
943 | named in the other_arch slot). |
|
|
944 | |
|
|
945 | If FLAG_LIVESAFE is set the number of uses is unlimited. |
|
|
946 | |
|
|
947 | =over 4 |
|
|
948 | |
|
|
949 | =item I<hp> <number> |
|
|
950 | |
|
|
951 | If FLAG_LIVE_SAVE is not set it is the absolute number of times the creator can |
|
|
952 | be used. |
|
|
953 | |
|
|
954 | =item I<speed> <number> |
|
|
955 | |
|
|
956 | If I<speed> is set the creator will create an object periodically, |
|
|
957 | see I<speed> and I<speed_left> fields in the general object field description |
|
|
958 | for more details. |
|
|
959 | |
|
|
960 | =item I<slaying> <string> |
|
|
961 | |
|
|
962 | If set the generated object's name and title will be set to this. |
|
|
963 | |
|
|
964 | =item I<other_arch> <string> |
|
|
965 | |
|
|
966 | If the inventory of the creator is empty new objects will be derived from the |
|
|
967 | archetype named by <string>. |
|
|
968 | |
|
|
969 | =item I<connected> <number> |
|
|
970 | |
|
|
971 | See generic object field description. |
|
|
972 | |
|
|
973 | =back |
|
|
974 | |
548 | =head3 DRINK - type 54 - Drinkable stuff |
975 | =head3 B<DRINK> - type 54 - Drinkable stuff |
549 | |
976 | |
550 | See FOOD description. |
977 | See B<FOOD> description. |
551 | |
978 | |
552 | =head3 CHECK_INV - type 64 - Inventory checkers |
979 | =head3 B<CHECK_INV> - type 64 - Inventory checkers |
553 | |
980 | |
554 | This object checks whether the player has a specific item in his |
981 | This object checks whether the player has a specific item in his |
555 | inventory when he moves above the inventory checker. If the player has |
982 | inventory when he moves above the inventory checker. If the player has |
556 | the item (or not, which can be controlled with a flag) a connection will be triggered. |
983 | the item (or not, which can be controlled with a flag) a connection will be triggered. |
557 | |
984 | |
558 | If you set move_block you can deny players and monsters to reach the space where |
985 | If you set I<move_block> you can deny players and monsters to reach the space where |
559 | the inventory checker is on, see 'move_block' description below. |
986 | the inventory checker is on, see I<move_block> description below. |
560 | |
987 | |
561 | The conditions specified by hp, slaying and race are concationated with OR. |
988 | The conditions specified by I<hp>, I<slaying> and I<race> are OR concationated. |
562 | So matching one of those conditions is enough. |
989 | So matching one of those conditions is enough. |
563 | |
990 | |
564 | =over 4 |
991 | =over 4 |
565 | |
992 | |
566 | =item move_block <move type bitmask> |
993 | =item I<move_block> <move type bitmask> |
567 | |
994 | |
568 | If you set this field to block a movetype the move code will block any moves |
995 | If you set this field to block a movetype the move code will block any moves |
569 | onto the space with the inventory checker, IF the moving object doesn't have |
996 | onto the space with the inventory checker, IF the moving object doesn't have |
570 | (or has - if last_sp = 0) the item that the checker is searching for. |
997 | (or has - if I<last_sp> = 0) the item that the checker is searching for. |
571 | |
998 | |
572 | =item last_sp (0|1) |
999 | =item I<last_sp> (0|1) |
573 | |
1000 | |
574 | If last_sp is 1 'having' the item that is being checked for will |
1001 | If I<last_sp> is 1 'having' the item that is being checked for will |
575 | activate the connection or make the space with the checker non-blocking. |
1002 | activate the connection or make the space with the checker non-blocking. |
576 | If last_sp is 0 'not having' the item will activate the connection |
1003 | If I<last_sp> is 0 'not having' the item will activate the connection |
577 | or make the space with the checker non-blocking. |
1004 | or make the space with the checker non-blocking. |
578 | |
1005 | |
579 | =item last_heal (0|1) |
1006 | =item I<last_heal> (0|1) |
580 | |
1007 | |
581 | If last_heal is 1 the matching item will be removed if the inventory checker |
1008 | If I<last_heal> is 1 the matching item will be removed if the inventory checker |
582 | activates a connection and finds the item in the inventory. |
1009 | activates a connection and finds the item in the inventory. |
583 | |
1010 | |
584 | (A inventory checker that blocks a space won't remove anything from inventories) |
1011 | (A inventory checker that blocks a space won't remove anything from inventories) |
585 | |
1012 | |
586 | =item hp <number> |
1013 | =item I<hp> <number> |
587 | |
1014 | |
588 | If this field is not 0 the inventory checker will search for an object |
1015 | If this field is not 0 the inventory checker will search for an object |
589 | with the type id <number>. |
1016 | with the type id <number>. |
590 | |
1017 | |
591 | =item slaying <string> |
1018 | =item I<slaying> <string> |
592 | |
1019 | |
593 | If this field is set the inventory checker will search for an object that |
1020 | If this field is set the inventory checker will search for an object that |
594 | has the same string in the slaying field (for example a key string of a key). |
1021 | has the same string in the I<slaying> field (for example a key string of a key). |
595 | |
1022 | |
596 | =item race <string> |
1023 | =item I<race> <string> |
597 | |
1024 | |
598 | If this field is set the inventory checker will search for an object which |
1025 | If this field is set the inventory checker will search for an object which |
599 | has the archetype name that matches <string>. |
1026 | has the archetype name that matches <string>. |
600 | |
1027 | |
601 | =item connected <connection id> |
1028 | =item I<connected> <connection id> |
602 | |
1029 | |
603 | This is the connection that will be activated. |
1030 | This is the connection that will be activated. The connection is |
|
|
1031 | 'pushed' when someone enters the space with the inventory checker, |
|
|
1032 | and it is 'released' when he leaves it. |
604 | |
1033 | |
605 | =back |
1034 | See also the description of the I<connected> field in the generic object field |
|
|
1035 | section. |
606 | |
1036 | |
|
|
1037 | =back |
|
|
1038 | |
607 | =head3 FLESH - type 72 - Organs and body parts |
1039 | =head3 B<FLESH> - type 72 - Organs and body parts |
608 | |
1040 | |
609 | See FOOD description. |
1041 | See B<FOOD> description. |
610 | |
1042 | |
|
|
1043 | =head3 B<MISC_OBJECT> - type 79 - Misc. objects |
|
|
1044 | |
|
|
1045 | A type for any object that has no special behaviour. |
|
|
1046 | |
|
|
1047 | =head3 B<LAMP> - type 82 - A lamp |
|
|
1048 | |
|
|
1049 | This object represents a lamp, that can be carried and switched |
|
|
1050 | on and off and has a certain amount of fuel in it. |
|
|
1051 | |
|
|
1052 | A lamp consists of two archetypes: the 'on' archetype and the 'off' archetype. |
|
|
1053 | Each of them should point at the other one with it's I<other_arch> field. |
|
|
1054 | |
|
|
1055 | See the I<other_arch> field for the behaviour of a lamp object when it is applied. |
|
|
1056 | |
|
|
1057 | If this object has FLAG_IS_LIGHTABLE set the lamp can be turned on and off |
|
|
1058 | with a B<LIGHTER>, see also the description of FLAG_IS_LIGHTABLE. |
|
|
1059 | |
|
|
1060 | =over 4 |
|
|
1061 | |
|
|
1062 | =item I<glow_radius> <number> |
|
|
1063 | |
|
|
1064 | The radius of the light that the lamp emits, see also I<glow_radius> in the |
|
|
1065 | generic object flags description. |
|
|
1066 | |
|
|
1067 | =item I<speed> <number> |
|
|
1068 | |
|
|
1069 | If FLAG_CHANGING is set the I<speed> field will indicate how fast the |
|
|
1070 | lamp burns it's fuel (I<food>). |
|
|
1071 | |
|
|
1072 | Setting FLAG_CHANGING makes only sense on the archetype which represents |
|
|
1073 | the 'on' state of the lamp. |
|
|
1074 | |
|
|
1075 | See also the description of FLAG_CHANGING. |
|
|
1076 | |
|
|
1077 | Lamps which have no FLAG_CHANGING set would also make sense and represent |
|
|
1078 | lamps that never burn up. |
|
|
1079 | |
|
|
1080 | =item I<other_arch> <number> |
|
|
1081 | |
|
|
1082 | This is the field that points to the 'other' archetype which represents the |
|
|
1083 | opposite state of the lamp. The newly from I<other_arch> derived object will |
|
|
1084 | replace the current object and will get the value of I<food> of the replaced object. |
|
|
1085 | |
|
|
1086 | Rationale: |
|
|
1087 | |
|
|
1088 | When the lamp (on) is applied a new object is derived from the archetype |
|
|
1089 | in I<other_arch> and the I<food> value is copied to it ('the fuel is |
|
|
1090 | transferred'). The new lamp (off) object has to have a I<other_arch> field |
|
|
1091 | which points to the archetype from which a lamp (on) can be derived. |
|
|
1092 | |
|
|
1093 | =item I<food> <number> |
|
|
1094 | |
|
|
1095 | This fields stands for the fuel of the lamp. |
|
|
1096 | |
|
|
1097 | =back |
|
|
1098 | |
|
|
1099 | =head3 B<DUPLICATOR> - type 83 - Duplicators or: Multiplicators |
|
|
1100 | |
|
|
1101 | This type of objects multiplies objects that are above it when it is activated. |
|
|
1102 | You can even multiply by 0, which will destroy the object. |
|
|
1103 | |
|
|
1104 | =over 4 |
|
|
1105 | |
|
|
1106 | =item I<level> <number> |
|
|
1107 | |
|
|
1108 | The multiplicator, if set to 0 or lower it will destroy the objects above it. |
|
|
1109 | |
|
|
1110 | =item I<other_arch> <string> |
|
|
1111 | |
|
|
1112 | The archetype name of the objects that should be multiplied. |
|
|
1113 | |
|
|
1114 | =item I<connected> <number> |
|
|
1115 | |
|
|
1116 | See generic object field description. |
|
|
1117 | |
|
|
1118 | =back |
|
|
1119 | |
611 | =head3 HOLE - type 94 - Holes |
1120 | =head3 B<HOLE> - type 94 - Holes |
612 | |
1121 | |
613 | Holes are holes in the ground where objects can fall through. When the hole |
1122 | B<HOLE>s are holes in the ground where objects can fall through. When the hole |
614 | opens and/or is completly open all objects above it fall through (more |
1123 | opens and/or is completly open all objects above it fall through (more |
615 | precisely: if their head is above the hole). |
1124 | precisely: if their head is above the hole). |
616 | |
1125 | |
|
|
1126 | When the B<HOLE> is activated it's speed is set to 0.5. |
|
|
1127 | |
617 | Trapdoors can only transfer the one who falls through to other coordinates |
1128 | These holes can only transfer the one who falls through to other coordinates |
618 | on the B<same> map. |
1129 | on the same map. |
619 | |
1130 | |
620 | =over 4 |
1131 | =over 4 |
621 | |
1132 | |
622 | =item maxsp (0|1) |
1133 | =item I<maxsp> (0|1) |
623 | |
1134 | |
624 | This field negates the state of the connection: When maxsp is 1 the pit will |
1135 | This field negates the state of the connection: When maxsp is 1 the pit will |
625 | open/close when the connection is deactivated. Otherwise it will open/close |
1136 | open/close when the connection is deactivated. Otherwise it will open/close |
626 | when the connection is activated. This field only has effect when the |
1137 | when the connection is activated. This field only has effect when the |
627 | connection is triggered. So if you put a closed hole on a map, and the |
1138 | connection is triggered. So if you put a closed hole on a map, and the |
628 | connection is deactivated, and maxsp is 1 the hole will remain closed until the |
1139 | connection is deactivated, and I<maxsp> is 1 the hole will remain closed until the |
629 | connection was triggered once. |
1140 | connection was triggered once. |
630 | |
1141 | |
631 | =item connected <connection id> |
1142 | =item I<connected> <connection id> |
632 | |
1143 | |
633 | This is the connection id, which lets the hole opening or closing when |
1144 | This is the connection id, which lets the hole opening or closing when |
634 | activated. The flags FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE control |
1145 | activated. The flags FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE control |
635 | at which connection state the object is activated. |
1146 | at which connection state the object is activated. |
636 | |
1147 | |
637 | For example: if FLAG_ACTIVATE_ON_RELEASE is set to 0 the hole won't react when |
1148 | For example: if FLAG_ACTIVATE_ON_RELEASE is set to 0 the hole won't react when |
638 | the connection is released. |
1149 | the connection is released. |
639 | |
1150 | |
640 | =item wc <number> (internal) |
1151 | =item I<wc> <number> (internal) |
641 | |
1152 | |
642 | This is an internal flag. If it is greater than 0 it means that the hole is not |
1153 | This is an internal field. If it is greater than 0 it means that the hole is not |
643 | yet fully open. More preciesly: this field is the animation-step and if it is |
1154 | yet fully open. More preciesly: this field is the animation-step and if it is |
644 | set to the 'closed' step of the animation the hole is closed and if it is on |
1155 | set to the 'closed' step of the animation the hole is closed and if it is on |
645 | the 'open' animation step (wc = 0), the hole is open. |
1156 | the 'open' animation step (I<wc> = 0), the hole is open. |
646 | |
1157 | |
647 | =item sp <number> |
1158 | =item I<sp> <number> |
648 | |
1159 | |
649 | The destination y coordinates on the same map. |
1160 | The destination y coordinates on the same map. |
650 | |
1161 | |
651 | =item hp <number> |
1162 | =item I<hp> <number> |
652 | |
1163 | |
653 | The destination x coordinates on the same map. |
1164 | The destination x coordinates on the same map. |
654 | |
1165 | |
655 | =back |
1166 | =back |
656 | |
1167 | |
|
|
1168 | =head3 B<POISONING> - type 105 - The poisoning of players and monsters |
|
|
1169 | |
|
|
1170 | This type is doing the actual damage to the ones who were attacked |
|
|
1171 | via AT_POISON (or drank B<POISON>). |
|
|
1172 | |
|
|
1173 | The duration is handled via the FLAG_IS_USED_UP mechanism (please look |
|
|
1174 | there for details). |
|
|
1175 | |
|
|
1176 | =over 4 |
|
|
1177 | |
|
|
1178 | =item I<dam> <number> |
|
|
1179 | |
|
|
1180 | Each time the poisoning is proccessed (which is determined by the I<speed> and |
|
|
1181 | I<speed_left> fields, see the general object fields description above) it hits |
|
|
1182 | the player with <number> damage and the AT_INTERNAL attacktype (means: it will |
|
|
1183 | simply hit the player with no strings attached). |
|
|
1184 | |
|
|
1185 | =item I<food> <number> |
|
|
1186 | |
|
|
1187 | Just a note: The posioning is removed if I<food> == 1 and not if |
|
|
1188 | the whole I<duration> is up, because the B<POISONING> code has to remove |
|
|
1189 | the poison-effects from the player before the FLAG_IS_USED_UP mechanism |
|
|
1190 | deletes the B<POISONING> object. |
|
|
1191 | |
|
|
1192 | =back |
|
|
1193 | |
657 | =head3 FORCE - type 114 - Forces |
1194 | =head3 B<FORCE> - type 114 - Forces |
658 | |
1195 | |
659 | Forces are a very 'thin' type. They don't have much behaviour other than |
1196 | Forces are a very 'thin' type. They don't have much behaviour other than |
660 | disappearing after a time and/or affecting the player if they are in his |
1197 | disappearing after a time and/or affecting the player if they are in his |
661 | inventory. |
1198 | inventory. |
662 | |
1199 | |
663 | Forces only take effect on the player if they have set FLAG_APPLIED. |
1200 | Forces only take effect on the player if they have FLAG_APPLIED set. |
664 | |
1201 | |
665 | Whether the duration field is processed or not a tick is controlled via the |
1202 | Whether the I<duration> field is processed or not per tick is controlled by the |
666 | speed and speed_left field. Look above at the generic description of these |
1203 | I<speed> and I<speed_left> fields. Look above in the generic object field description. |
667 | fields. |
|
|
668 | |
1204 | |
669 | NOTE: Setting FLAG_IS_USED_UP on an force will also consider the 'food' field |
1205 | NOTE: If FLAG_IS_USED_UP is set on a B<FORCE> it's I<food> field will also |
670 | like stated above in the FLAG_IS_USED_UP description. BUT: If the food field reaches |
1206 | interpreter like described in the description of the FLAG_IS_USED_UP flag. |
671 | 0 before duration and FLAG_APPLIED is set, the force will last for 'duration'. |
1207 | BUT: If I<food> reaches 0 before I<duration> and FLAG_APPLIED is set, the force |
672 | If the FLAG_APPLIED is not set the force is removed when food reaches 0. |
1208 | will still last for I<duration>. If the FLAG_APPLIED is not set the force is |
673 | Generally this means: FLAG_IS_USED_UP doesn't have good semantics on forces. |
1209 | removed when I<food> reaches 0. Generally this means: FLAG_IS_USED_UP doesn't |
|
|
1210 | have good semantics on forces, try to avoid it. |
674 | |
1211 | |
675 | =over 4 |
1212 | =over 4 |
676 | |
1213 | |
677 | =item duration |
1214 | =item I<duration> |
678 | |
1215 | |
679 | While this field is greater than 0 the force/object is not destroyed. It is |
1216 | While this field is greater than 0 the force/object is not destroyed. It is |
680 | decreased each tick by 1. |
1217 | decreased each tick by 1. |
681 | |
1218 | |
682 | If it reaches 0 the force/object is destroyed. |
1219 | If it reaches 0 the force/object is destroyed. |
… | |
… | |
685 | FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP |
1222 | FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP |
686 | what happens then. |
1223 | what happens then. |
687 | |
1224 | |
688 | =back |
1225 | =back |
689 | |
1226 | |
690 | =head3 POTION_EFFECT - type 115 - Potion effects (resistancies) |
1227 | =head3 B<POTION_EFFECT> - type 115 - Potion effects (resistancies) |
691 | |
1228 | |
692 | This object is generated by the POTION code when the potion is a resistance |
1229 | This object is generated by the B<POTION> code when the potion is a resistance |
693 | giving potion. It has mainly the same behaviour as a FORCE. |
1230 | giving potion. It has mainly the same behaviour as a B<FORCE>. |
694 | |
1231 | |
695 | The specialty of the potion effect is that the resistancy it gives is absolute, |
1232 | The specialty of the potion effect is that the resistancy it gives is absolute, |
696 | so if you drin a resistancy potion of fire+60 you will get 60% resistancy to |
1233 | so if you drink a resistancy potion of fire+60 you will get 60% absolute resistancy to |
697 | fire. |
1234 | fire. |
698 | |
1235 | |
699 | Multiple potion effects only give you the maximum of their resistancy. |
1236 | Multiple potion effects only give you the maximum of their resistancy. |