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

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.5 by elmex, Tue Dec 19 13:41:45 2006 UTC vs.
Revision 1.9 by elmex, Tue Dec 19 23:41:56 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 no_skill_ident (0\|1)
		129
		130	Sets the flag FLAG_NO_SKILL_IDENT.
117	See Flags section below.	131	See Flags section below.
118		132
119	=item activate_on_push (0\|1) (default: 1)	133	=item activate_on_push (0\|1) (default: 1)
120		134
121	Sets the flag FLAG_ACTIVATE_ON_PUSH.	135	Sets the flag FLAG_ACTIVATE_ON_PUSH.
…		…
188	This flag has only meaning for objects that can be linked together	202	This flag has only meaning for objects that can be linked together
189	with the 'connected' field and controls wether the object should	203	with the 'connected' field and controls wether the object should
190	be activated when the connection is 'pushed' or it is 'released'.	204	be activated when the connection is 'pushed' or it is 'released'.
191		205
192	This flag is by default on.	206	This flag is by default on.
		207
		208	=item FLAG_NO_STEAL
		209
		210	When this flag is set this object can't be stolen. The flag will be
		211	resetted once the object is placed on a map.
		212
		213	When this flag is set on a monster it can defent attempts of stealing
		214	(but in this context the flag is only used internally).
		215
		216	=item FLAG_NO_SKILL_IDENT
		217
		218	This flag is mostly used internal and prevents unidentified objects
		219	(objects which don't have FLAG_IDENTIFIED set) being identified by
		220	skills.
		221
		222	This flag is used to mark objects to never being identified by a skill
		223	once a player failed to identify an object. So that multiple tries
		224	of identifying aren't more effective than one.
193		225
194	=back	226	=back
195		227
196	=head2 Description of type specific attributes	228	=head2 Description of type specific attributes
197		229
…		…
327	with the treasurelist specified here. (I guess it's highly undefined what	359	with the treasurelist specified here. (I guess it's highly undefined what
328	happens if there is not a spell in the potions inventory).	360	happens if there is not a spell in the potions inventory).
329		361
330	=item on_use_yield <archetype>	362	=item on_use_yield <archetype>
331		363
332	When this object is applied this object will be created.	364	When this object is applied an instance of <archetype> will be created.
333	This field is also used by FOOD and POISON.
334		365
335	=item subtypes <potion subtype>	366	=item subtypes <potion subtype>
336		367
337	see include/spells.h for possible potion subtypes, there are currently 4:	368	see include/spells.h for possible potion subtypes, there are currently 4:
338		369
…		…
355	=item POT_BALM	386	=item POT_BALM
356		387
357	Unused, default behaiour of a potion.	388	Unused, default behaiour of a potion.
358		389
359	=back	390	=back
		391
		392	=back
		393
		394	=head3 FOOD - type 6 - Eatable stuff
		395
		396	This is for objects that are representing general eatables like
		397	beef or bread.
		398
		399	The main difference between FOOD, FLESH and DRINK is that they
		400	give different messages.
		401
		402	The specialty of FLESH is that it inherits the resistancies of the
		403	monsters it was generated in and will let dragons raise their resistancies
		404	with that. If the monster has the POISON attacktype the FLESH
		405	will change into POISON.
		406
		407	If a player runs low on food he will grab for FOOD, DRINK and POISON
		408	and if he doesn't find any of that he will start eating FLESH.
		409
		410	=over 4
		411
		412	=item title <string>
		413
		414	If the food has a title or is cursed it is considered 'special', which means that the
		415	fields Str, Dex, Con, Int, Wis, Pow, resist_<resistancy>, hp and sp
		416	are interpreted and have further effects on the player.
		417
		418	The higher the food field is the longer the improvement of the player lasts
		419	(except for hp and sp).
		420
		421	=item food <number>
		422
		423	This is the amount of food points the player gets when he eats this.
		424
		425	=item on_use_yield <archetype>
		426
		427	When this object is applied an instance of <archetype> will be created.
		428
		429	=back
		430
		431	=head3 POISON - type 7 - Poisonous stuff
		432
		433	This type is for objects that can poison the player when drinking.
		434	When applied it will hit the attacked with AT_POISON and will create
		435	a POISONING object in the one who was hit.
		436
		437	=over 4
		438
		439	=item level <number>
		440
		441	This field affects the propability of poisoning. The higher the level difference
		442	between the one who is hit and the poision the mose propable it is the attacked
		443	one will be poisoned.
		444
		445	=item slaying <race>
		446
		447	On poison this field has the usual meaning of 'slaying', when the
		448	ones race matches the slaying field the damage done by the poison
		449	is multiplied by 3.
		450
		451	=item hp <number>
		452
		453	This is the amount of damage the player will receive from applying this. The
		454	attacktype AT_POISON will be used to hit the player and the damage will
		455	determine the strenght, duration and depletion of stats of the poisoning. The
		456	created POISONING object which is being placed in the one who was attacked will
		457	get the damage from this field (which is maybe adjusted by slaying or the
		458	resistancies).
		459
		460	=item food <number>
		461
		462	1/4 of <number> will be drained from the players food.
		463
		464	=item on_use_yield <archetype>
		465
		466	When this object is applied an instance of <archetype> will be created.
		467
		468	=back
		469
		470	=head3 BOOK - type 8 - Readable books
		471
		472	This type is basically for representing text books in the game.
		473
		474	Reading a book also identifys it (if FLAG_NO_SKILL_IDENT is not set).
		475
		476	=over 4
		477
		478	=item msg <text>
		479
		480	This is the contents of the book. When this field is unset
		481	at treasure generation a random text will be inserted.
		482
		483	=item skill <skill name>
		484
		485	The skill required to read this book. (The most resonable
		486	skill would be literacy).
		487
		488	=item exp <number>
		489
		490	The experience points the player get for reading this book.
		491
		492	=item subtype <readable subtype>
		493
		494	This field determines the type of the readable.
		495	Please see common/readable.C in the readable_message_types table.
360		496
361	=back	497	=back
362		498
363	=head3 WEAPON - type 15 - Weapons	499	=head3 WEAPON - type 15 - Weapons
364		500
…		…
504	FLAG_XRAYS	640	FLAG_XRAYS
505	FLAG_BLIND	641	FLAG_BLIND
506	FLAG_SEE_IN_DARK	642	FLAG_SEE_IN_DARK
507	FLAG_UNDEAD	643	FLAG_UNDEAD
508		644
		645	=head3 DRINK - type 54 - Drinkable stuff
		646
		647	See FOOD description.
		648
		649	=head3 CHECK_INV - type 64 - Inventory checkers
		650
		651	This object checks whether the player has a specific item in his
		652	inventory when he moves above the inventory checker. If the player has
		653	the item (or not, which can be controlled with a flag) a connection will be triggered.
		654
		655	If you set move_block you can deny players and monsters to reach the space where
		656	the inventory checker is on, see 'move_block' description below.
		657
		658	The conditions specified by hp, slaying and race are concationated with OR.
		659	So matching one of those conditions is enough.
		660
		661	=over 4
		662
		663	=item move_block <move type bitmask>
		664
		665	If you set this field to block a movetype the move code will block any moves
		666	onto the space with the inventory checker, IF the moving object doesn't have
		667	(or has - if last_sp = 0) the item that the checker is searching for.
		668
		669	=item last_sp (0\|1)
		670
		671	If last_sp is 1 'having' the item that is being checked for will
		672	activate the connection or make the space with the checker non-blocking.
		673	If last_sp is 0 'not having' the item will activate the connection
		674	or make the space with the checker non-blocking.
		675
		676	=item last_heal (0\|1)
		677
		678	If last_heal is 1 the matching item will be removed if the inventory checker
		679	activates a connection and finds the item in the inventory.
		680
		681	(A inventory checker that blocks a space won't remove anything from inventories)
		682
		683	=item hp <number>
		684
		685	If this field is not 0 the inventory checker will search for an object
		686	with the type id <number>.
		687
		688	=item slaying <string>
		689
		690	If this field is set the inventory checker will search for an object that
		691	has the same string in the slaying field (for example a key string of a key).
		692
		693	=item race <string>
		694
		695	If this field is set the inventory checker will search for an object which
		696	has the archetype name that matches <string>.
		697
		698	=item connected <connection id>
		699
		700	This is the connection that will be activated.
		701
		702	=back
		703
		704	=head3 FLESH - type 72 - Organs and body parts
		705
		706	See FOOD description.
		707
509	=head3 HOLE - type 94 - Holes	708	=head3 HOLE - type 94 - Holes
510		709
511	Holes are holes in the ground where objects can fall through. When the hole	710	Holes are holes in the ground where objects can fall through. When the hole
512	opens and/or is completly open all objects above it fall through (more	711	opens and/or is completly open all objects above it fall through (more
513	precisely: if their head is above the hole).	712	precisely: if their head is above the hole).
…		…
550		749
551	The destination x coordinates on the same map.	750	The destination x coordinates on the same map.
552		751
553	=back	752	=back
554		753
		754	=head3 POISONING - type 105 - The poisoning of players and monsters
		755
		756	This type is doing the actual damage to the ones who were attacked
		757	via AT_POISON (or drank POISON).
		758
		759	The duration is handled via the FLAG_IS_USED_UP mechanism (please look
		760	there for details).
		761
		762	=over 4
		763
		764	=item dam <number>
		765
		766	Each time the poisoning is processed (which is determined by the speed and speed_left
		767	fields, see the general object attributes above) it hits the player with
		768	<number> damage and the AT_INTERNAL attacktype (means: it will simply
		769	hit the player with no strings attached).
		770
		771	=item food <number>
		772
		773	Just a note: The posion is removed when food == 1 and not when
		774	the whole duration is up, because the POISONING code has to remove
		775	the poison-effects from the player before the FLAG_IS_USED_UP mechanism
		776	deletes the POISONING object.
		777
		778	=back
		779
555	=head3 FORCE - type 114 - Forces	780	=head3 FORCE - type 114 - Forces
556		781
557	Forces are a very 'thin' type. They don't have much behaviour other than	782	Forces are a very 'thin' type. They don't have much behaviour other than
558	disappearing after a time and/or affecting the player if they are in his	783	disappearing after a time and/or affecting the player if they are in his
559	inventory.	784	inventory.
…		…
562		787
563	Whether the duration field is processed or not a tick is controlled via the	788	Whether the duration field is processed or not a tick is controlled via the
564	speed and speed_left field. Look above at the generic description of these	789	speed and speed_left field. Look above at the generic description of these
565	fields.	790	fields.
566		791
		792	NOTE: Setting FLAG_IS_USED_UP on an force will also consider the 'food' field
		793	like stated above in the FLAG_IS_USED_UP description. BUT: If the food field reaches
		794	0 before duration and FLAG_APPLIED is set, the force will last for 'duration'.
		795	If the FLAG_APPLIED is not set the force is removed when food reaches 0.
		796	Generally this means: FLAG_IS_USED_UP doesn't have good semantics on forces.
		797
567	=over 4	798	=over 4
568		799
569	=item duration	800	=item duration
570		801
571	While this field is greater than 0 the force/object is not destroyed. It is	802	While this field is greater than 0 the force/object is not destroyed. It is

Diff Legend

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

Comparing deliantra/server/pod/objects.pod (file contents): Revision 1.5 by elmex, Tue Dec 19 13:41:45 2006 UTC vs. Revision 1.9 by elmex, Tue Dec 19 23:41:56 2006 UTC

Diff Legend

Comparing deliantra/server/pod/objects.pod (file contents):
Revision 1.5 by elmex, Tue Dec 19 13:41:45 2006 UTC vs.
Revision 1.9 by elmex, Tue Dec 19 23:41:56 2006 UTC