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