ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/pod/objects.pod
(Generate patch)

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.16 by elmex, Wed Dec 20 21:30:42 2006 UTC vs.
Revision 1.18 by elmex, Thu Dec 21 21:24:06 2006 UTC

108For players this field reflects the duration of the invisibility 108For players this field reflects the duration of the invisibility
109and is decreased every tick by 1. 109and is decreased every tick by 1.
110 110
111For non-player objects this field is not changed by server ticks. 111For non-player objects this field is not changed by server ticks.
112 112
113=item I<glow_radius> <number>
114
115This field indicates how far an object glows. Default is a radius of 0 (no
116glowing at all).
117
113=item I<speed> <number> 118=item I<speed> <number>
114 119
115If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed 120If this field is greater than MIN_ACTIVE_SPEED (~0.0001) the object is placed
116on the active object list and will be processed each tick (see also speed_left!). 121on the active object list and will be processed each tick (see also speed_left!).
117 122
194See Flags section below. 199See Flags section below.
195 200
196=item I<activate_on_release> (0|1) (default: 1) 201=item I<activate_on_release> (0|1) (default: 1)
197 202
198Sets the flag FLAG_ACTIVATE_ON_RELEASE. 203Sets the flag FLAG_ACTIVATE_ON_RELEASE.
204See Flags section below.
205
206=item I<is_lightable> (0|1)
207
208Sets the flag FLAG_IS_LIGHTABLE.
199See Flags section below. 209See Flags section below.
200 210
201=item I<editable> (more than deprecated) 211=item I<editable> (more than deprecated)
202 212
203This field had a special meaning for crossedit, which used parts 213This field had a special meaning for crossedit, which used parts
238If FLAG_APPLIED is not set the object is destroyed. 248If FLAG_APPLIED is not set the object is destroyed.
239 249
240=item FLAG_CHANGING 250=item FLAG_CHANGING
241 251
242If the I<state> field of the object is 0 the object will be processed periodically 252If the I<state> field of the object is 0 the object will be processed periodically
243(if speed is set). If the I<state> field is 1 it won't be processed. 253(if I<speed> is set). If the I<state> field is 1 it won't be processed.
254
255This flag indicates that the object is changing into a different object.
256The object has to have the I<other_arch> field set. The object the changing object
257changes into is derived from the archetype in I<other_arch>.
258
259When the object does not have FLAG_ALIVE set the I<food> field will be decremented
260each time the object is processed, and if I<food> reaches 0 one new object will be generated.
261
262When the object has FLAG_ALIVE set the I<food> field is the number of objects that
263will be generated.
264
265After the new object is created the I<hp> field from the old object is copied into
266the new one.
267
268When the old object was a B<LAMP> it's I<food> fields value less 1 will be copied
269to the new object.
244 270
245=item FLAG_IS_A_TEMPLATE (internal use) 271=item FLAG_IS_A_TEMPLATE (internal use)
246 272
247This flag is set on the inventory of generators like B<CREATOR>s and B<CONVERTER>s, 273This flag is set on the inventory of generators like B<CREATOR>s and B<CONVERTER>s,
248or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set. 274or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.
298 324
299=item FLAG_REFL_SPELL 325=item FLAG_REFL_SPELL
300 326
301This flag indicates whether something reflects spells, like spell reflecting 327This flag indicates whether something reflects spells, like spell reflecting
302amuletts. 328amuletts.
329
330=item FLAG_IS_LIGHTABLE
331
332This flag indicates whether a B<LIGHTER> can light this object. See also the
333description of the B<LIGHTER> type. How easy you can light an item depends
334partially on the material of the object.
303 335
304=back 336=back
305 337
306=head2 Description of type specific fields and behaviour 338=head2 Description of type specific fields and behaviour
307 339
1012 1044
1013A type for any object that has no special behaviour. 1045A type for any object that has no special behaviour.
1014 1046
1015=head3 B<LAMP> - type 82 - A lamp 1047=head3 B<LAMP> - type 82 - A lamp
1016 1048
1017This object makes light. 1049This object represents a lamp, that can be carried and switched
1050on and off and has a certain amount of fuel in it.
1051
1052A lamp consists of two archetypes: the 'on' archetype and the 'off' archetype.
1053Each of them should point at the other one with it's I<other_arch> field.
1054
1055See the I<other_arch> field for the behaviour of a lamp object when it is applied.
1056
1057If this object has FLAG_IS_LIGHTABLE set the lamp can be turned on and off
1058with a B<LIGHTER>, see also the description of FLAG_IS_LIGHTABLE.
1059
1060=over 4
1061
1062=item I<glow_radius> <number>
1063
1064The radius of the light that the lamp emits, see also I<glow_radius> in the
1065generic object flags description.
1066
1067=item I<speed> <number>
1068
1069If FLAG_CHANGING is set the I<speed> field will indicate how fast the
1070lamp burns it's fuel (I<food>).
1071
1072Setting FLAG_CHANGING makes only sense on the archetype which represents
1073the 'on' state of the lamp.
1074
1075See also the description of FLAG_CHANGING.
1076
1077Lamps which have no FLAG_CHANGING set would also make sense and represent
1078lamps that never burn up.
1079
1080=item I<other_arch> <number>
1081
1082This is the field that points to the 'other' archetype which represents the
1083opposite state of the lamp. The newly from I<other_arch> derived object will
1084replace the current object and will get the value of I<food> of the replaced object.
1085
1086Rationale:
1087
1088When the lamp (on) is applied a new object is derived from the archetype
1089in I<other_arch> and the I<food> value is copied to it ('the fuel is
1090transferred'). The new lamp (off) object has to have a I<other_arch> field
1091which points to the archetype from which a lamp (on) can be derived.
1092
1093=item I<food> <number>
1094
1095This fields stands for the fuel of the lamp.
1096
1097=back
1018 1098
1019=head3 B<DUPLICATOR> - type 83 - Duplicators or: Multiplicators 1099=head3 B<DUPLICATOR> - type 83 - Duplicators or: Multiplicators
1020 1100
1021This type of objects multiplies objects that are above it when it is activated. 1101This type of objects multiplies objects that are above it when it is activated.
1022You can even multiply by 0, which will destroy the object. 1102You can even multiply by 0, which will destroy the object.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines