[ViewVC] Diff of: cvs/deliantra/server/pod/objects.pod

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.4 by elmex, Mon Dec 18 16:53:04 2006 UTC vs.
Revision 1.8 by elmex, Tue Dec 19 22:21:15 2006 UTC

…		…
94		94
95	If the object is on the active list and speed_left is lower or	95	If the object is on the active list and speed_left is lower or
96	equal to 0 the absolute value of the speed field is added to speed_left	96	equal to 0 the absolute value of the speed field is added to speed_left
97	on the end of the tick.	97	on the end of the tick.
98		98
		99	This means: the lower the speed field is (but still above MIN_ACTIVE_SPEED)
		100	the more seldom the object is processed. And the higher the speed field is
		101	the more often the object is processed.
		102
99	=item no_drop (0\|1)	103	=item no_drop (0\|1)
100		104
101	Sets the flag FLAG_NO_DROP.	105	Sets the flag FLAG_NO_DROP.
102	See Flags section below.	106	See Flags section below.
103		107
…		…
112	See Flags section below.	116	See Flags section below.
113		117
114	=item auto_apply (0\|1)	118	=item auto_apply (0\|1)
115		119
116	Sets the flag FLAG_AUTO_APPLY.	120	Sets the flag FLAG_AUTO_APPLY.
		121	See Flags section below.
		122
		123	=item no_steal (0\|1)
		124
		125	Sets the flag FLAG_NO_STEAL.
		126	See Flags section below.
		127
		128	=item activate_on_push (0\|1) (default: 1)
		129
		130	Sets the flag FLAG_ACTIVATE_ON_PUSH.
		131	See Flags section below.
		132
		133	=item activate_on_release (0\|1) (default: 1)
		134
		135	Sets the flag FLAG_ACTIVATE_ON_RELEASE.
117	See Flags section below.	136	See Flags section below.
118		137
119	=item editable (more than deprecated)	138	=item editable (more than deprecated)
120		139
121	This field had a special meaning for crossedit, which used parts	140	This field had a special meaning for crossedit, which used parts
…		…
162	or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.	181	or other objects that have the flags FLAG_GENERATOR and FLAG_CONTENT_ON_GEN set.
163		182
164	=item FLAG_AUTO_APPLY	183	=item FLAG_AUTO_APPLY
165		184
166	This flag has currently only meaning for the TREASURE type, see below.	185	This flag has currently only meaning for the TREASURE type, see below.
		186
		187	=item FLAG_ACTIVATE_ON_PUSH
		188
		189	This flag has only meaning for objects that can be linked together
		190	with the 'connected' field and controls wether the object should
		191	be activated when the connection is 'pushed' or it is 'released'.
		192
		193	This flag is by default on.
		194
		195	=item FLAG_ACTIVATE_ON_RELEASE
		196
		197	This flag has only meaning for objects that can be linked together
		198	with the 'connected' field and controls wether the object should
		199	be activated when the connection is 'pushed' or it is 'released'.
		200
		201	This flag is by default on.
		202
		203	=item FLAG_NO_STEAL
		204
		205	When this flag is set this object can't be stolen. The flag will be
		206	resetted once the object is placed on a map.
		207
		208	When this flag is set on a monster it can defent attempts of stealing
		209	(but in this context the flag is only used internally).
167		210
168	=back	211	=back
169		212
170	=head2 Description of type specific attributes	213	=head2 Description of type specific attributes
171		214
…		…
301	with the treasurelist specified here. (I guess it's highly undefined what	344	with the treasurelist specified here. (I guess it's highly undefined what
302	happens if there is not a spell in the potions inventory).	345	happens if there is not a spell in the potions inventory).
303		346
304	=item on_use_yield <archetype>	347	=item on_use_yield <archetype>
305		348
306	When this object is applied this object will be created.	349	When this object is applied an instance of <archetype> will be created.
307	This field is also used by FOOD and POISON.
308		350
309	=item subtypes <potion subtype>	351	=item subtypes <potion subtype>
310		352
311	see include/spells.h for possible potion subtypes, there are currently 4:	353	see include/spells.h for possible potion subtypes, there are currently 4:
312		354
…		…
329	=item POT_BALM	371	=item POT_BALM
330		372
331	Unused, default behaiour of a potion.	373	Unused, default behaiour of a potion.
332		374
333	=back	375	=back
		376
		377	=back
		378
		379	=head3 FOOD - type 6 - Eatable stuff
		380
		381	This is for objects that are representing general eatables like
		382	beef or bread.
		383
		384	The main difference between FOOD, FLESH and DRINK is that they
		385	give different messages.
		386
		387	The specialty of FLESH is that it inherits the resistancies of the
		388	monsters it was generated in and will let dragons raise their resistancies
		389	with that. If the monster has the POISON attacktype the FLESH
		390	will change into POISON.
		391
		392	If a player runs low on food he will grab for FOOD, DRINK and POISON
		393	and if he doesn't find any of that he will start eating FLESH.
		394
		395	=over 4
		396
		397	=item title <string>
		398
		399	If the food has a title or is cursed it is considered 'special', which means that the
		400	fields Str, Dex, Con, Int, Wis, Pow, resist_<resistancy>, hp and sp
		401	are interpreted and have further effects on the player.
		402
		403	The higher the food field is the longer the improvement of the player lasts
		404	(except for hp and sp).
		405
		406	=item food <number>
		407
		408	This is the amount of food points the player gets when he eats this.
		409
		410	=item on_use_yield <archetype>
		411
		412	When this object is applied an instance of <archetype> will be created.
		413
		414	=back
		415
		416	=head3 POISON - type 7 - Poisonous stuff
		417
		418	This type is for objects that can poison the player when drinking.
		419	When applied it will hit the attacked with AT_POISON and will create
		420	a POISONING object in the one who was hit.
		421
		422	=over 4
		423
		424	=item level <number>
		425
		426	This field affects the propability of poisoning. The higher the level difference
		427	between the one who is hit and the poision the mose propable it is the attacked
		428	one will be poisoned.
		429
		430	=item slaying <race>
		431
		432	On poison this field has the usual meaning of 'slaying', when the
		433	ones race matches the slaying field the damage done by the poison
		434	is multiplied by 3.
		435
		436	=item hp <number>
		437
		438	This is the amount of damage the player will receive from applying this. The
		439	attacktype AT_POISON will be used to hit the player and the damage will
		440	determine the strenght, duration and depletion of stats of the poisoning. The
		441	created POISONING object which is being placed in the one who was attacked will
		442	get the damage from this field (which is maybe adjusted by slaying or the
		443	resistancies).
		444
		445	=item food <number>
		446
		447	1/4 of <number> will be drained from the players food.
		448
		449	=item on_use_yield <archetype>
		450
		451	When this object is applied an instance of <archetype> will be created.
334		452
335	=back	453	=back
336		454
337	=head3 WEAPON - type 15 - Weapons	455	=head3 WEAPON - type 15 - Weapons
338		456
…		…
478	FLAG_XRAYS	596	FLAG_XRAYS
479	FLAG_BLIND	597	FLAG_BLIND
480	FLAG_SEE_IN_DARK	598	FLAG_SEE_IN_DARK
481	FLAG_UNDEAD	599	FLAG_UNDEAD
482		600
		601	=head3 DRINK - type 54 - Drinkable stuff
		602
		603	See FOOD description.
		604
		605	=head3 CHECK_INV - type 64 - Inventory checkers
		606
		607	This object checks whether the player has a specific item in his
		608	inventory when he moves above the inventory checker. If the player has
		609	the item (or not, which can be controlled with a flag) a connection will be triggered.
		610
		611	If you set move_block you can deny players and monsters to reach the space where
		612	the inventory checker is on, see 'move_block' description below.
		613
		614	The conditions specified by hp, slaying and race are concationated with OR.
		615	So matching one of those conditions is enough.
		616
		617	=over 4
		618
		619	=item move_block <move type bitmask>
		620
		621	If you set this field to block a movetype the move code will block any moves
		622	onto the space with the inventory checker, IF the moving object doesn't have
		623	(or has - if last_sp = 0) the item that the checker is searching for.
		624
		625	=item last_sp (0\|1)
		626
		627	If last_sp is 1 'having' the item that is being checked for will
		628	activate the connection or make the space with the checker non-blocking.
		629	If last_sp is 0 'not having' the item will activate the connection
		630	or make the space with the checker non-blocking.
		631
		632	=item last_heal (0\|1)
		633
		634	If last_heal is 1 the matching item will be removed if the inventory checker
		635	activates a connection and finds the item in the inventory.
		636
		637	(A inventory checker that blocks a space won't remove anything from inventories)
		638
		639	=item hp <number>
		640
		641	If this field is not 0 the inventory checker will search for an object
		642	with the type id <number>.
		643
		644	=item slaying <string>
		645
		646	If this field is set the inventory checker will search for an object that
		647	has the same string in the slaying field (for example a key string of a key).
		648
		649	=item race <string>
		650
		651	If this field is set the inventory checker will search for an object which
		652	has the archetype name that matches <string>.
		653
		654	=item connected <connection id>
		655
		656	This is the connection that will be activated.
		657
		658	=back
		659
		660	=head3 FLESH - type 72 - Organs and body parts
		661
		662	See FOOD description.
		663
		664	=head3 HOLE - type 94 - Holes
		665
		666	Holes are holes in the ground where objects can fall through. When the hole
		667	opens and/or is completly open all objects above it fall through (more
		668	precisely: if their head is above the hole).
		669
		670	Trapdoors can only transfer the one who falls through to other coordinates
		671	on the B<same> map.
		672
		673	=over 4
		674
		675	=item maxsp (0\|1)
		676
		677	This field negates the state of the connection: When maxsp is 1 the pit will
		678	open/close when the connection is deactivated. Otherwise it will open/close
		679	when the connection is activated. This field only has effect when the
		680	connection is triggered. So if you put a closed hole on a map, and the
		681	connection is deactivated, and maxsp is 1 the hole will remain closed until the
		682	connection was triggered once.
		683
		684	=item connected <connection id>
		685
		686	This is the connection id, which lets the hole opening or closing when
		687	activated. The flags FLAG_ACTIVATE_ON_PUSH and FLAG_ACTIVATE_ON_RELEASE control
		688	at which connection state the object is activated.
		689
		690	For example: if FLAG_ACTIVATE_ON_RELEASE is set to 0 the hole won't react when
		691	the connection is released.
		692
		693	=item wc <number> (internal)
		694
		695	This is an internal flag. If it is greater than 0 it means that the hole is not
		696	yet fully open. More preciesly: this field is the animation-step and if it is
		697	set to the 'closed' step of the animation the hole is closed and if it is on
		698	the 'open' animation step (wc = 0), the hole is open.
		699
		700	=item sp <number>
		701
		702	The destination y coordinates on the same map.
		703
		704	=item hp <number>
		705
		706	The destination x coordinates on the same map.
		707
		708	=back
		709
		710	=head3 POISONING - type 105 - The poisoning of players and monsters
		711
		712	This type is doing the actual damage to the ones who were attacked
		713	via AT_POISON (or drank POISON).
		714
		715	The duration is handled via the FLAG_IS_USED_UP mechanism (please look
		716	there for details).
		717
		718	=over 4
		719
		720	=item dam <number>
		721
		722	Each time the poisoning is processed (which is determined by the speed and speed_left
		723	fields, see the general object attributes above) it hits the player with
		724	<number> damage and the AT_INTERNAL attacktype (means: it will simply
		725	hit the player with no strings attached).
		726
		727	=item food <number>
		728
		729	Just a note: The posion is removed when food == 1 and not when
		730	the whole duration is up, because the POISONING code has to remove
		731	the poison-effects from the player before the FLAG_IS_USED_UP mechanism
		732	deletes the POISONING object.
		733
		734	=back
		735
483	=head3 FORCE - type 114 - Forces	736	=head3 FORCE - type 114 - Forces
484		737
485	Forces are a very 'thin' type. They don't have much behaviour other than	738	Forces are a very 'thin' type. They don't have much behaviour other than
486	disappearing after a time and/or affecting the player if they are in his inventory.	739	disappearing after a time and/or affecting the player if they are in his
		740	inventory.
487		741
488	Forces only take effect on the player if they have set FLAG_APPLIED.	742	Forces only take effect on the player if they have set FLAG_APPLIED.
489		743
490	Whether the duration field is processed or not a tick is controlled via the	744	Whether the duration field is processed or not a tick is controlled via the
491	speed and speed_left field. Look above at the generic description of these	745	speed and speed_left field. Look above at the generic description of these
492	fields.	746	fields.
493		747
		748	NOTE: Setting FLAG_IS_USED_UP on an force will also consider the 'food' field
		749	like stated above in the FLAG_IS_USED_UP description. BUT: If the food field reaches
		750	0 before duration and FLAG_APPLIED is set, the force will last for 'duration'.
		751	If the FLAG_APPLIED is not set the force is removed when food reaches 0.
		752	Generally this means: FLAG_IS_USED_UP doesn't have good semantics on forces.
		753
494	=over 4	754	=over 4
495		755
496	=item duration	756	=item duration
497		757
498	While this field is greater than 0 the force/object is not destroyed.	758	While this field is greater than 0 the force/object is not destroyed. It is
499	It is decreased each tick by 1.	759	decreased each tick by 1.
500		760
501	If it reaches 0 the force/object is destroyed.	761	If it reaches 0 the force/object is destroyed.
502		762
503	This field can have this meaning for B<any> object if that object has	763	This field can have this meaning for B<any> object if that object has
504	FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP	764	FLAG_IS_USED_UP and FLAG_APPLIED set. See the description of FLAG_IS_USED_UP
…		…
506		766
507	=back	767	=back
508		768
509	=head3 POTION_EFFECT - type 115 - Potion effects (resistancies)	769	=head3 POTION_EFFECT - type 115 - Potion effects (resistancies)
510		770
511	This object is generated by the POTION code when the potion is a	771	This object is generated by the POTION code when the potion is a resistance
512	resistance giving potion. It has mainly the same behaviour as a FORCE.	772	giving potion. It has mainly the same behaviour as a FORCE.
513		773
514	The specialty of the potion effect is that the resistancy it gives is absolute,	774	The specialty of the potion effect is that the resistancy it gives is absolute,
515	so if you drin a resistancy potion of fire+60 you will get 60% resistancy to fire.	775	so if you drin a resistancy potion of fire+60 you will get 60% resistancy to
		776	fire.
516		777
517	Multiple potion effects only give you the maximum of their resistancy.	778	Multiple potion effects only give you the maximum of their resistancy.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/pod/objects.pod (file contents): Revision 1.4 by elmex, Mon Dec 18 16:53:04 2006 UTC vs. Revision 1.8 by elmex, Tue Dec 19 22:21:15 2006 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.4 by elmex, Mon Dec 18 16:53:04 2006 UTC vs.
Revision 1.8 by elmex, Tue Dec 19 22:21:15 2006 UTC