[ViewVC] Annotation of: cvs/deliantra/arch/gods/README


Meaning/uses of Gods archetype values. No particular value is 
needed to be specified (but it helps!).

 name          - name of the god  
 title         - diametrically opposed god (not required) 
 other_arch    - name of the archetype which is summoned by the holy servant spell
 race          - the name of the race of creatures that are aligned w/ the god.
                 "summon cult monsters" and "pacify" are 2 (of many) spells that 
                 use this. Value can be omitted if no race exists. 
 slaying       - name of the race of creatures "holy word","holy possession"
                 spells will effect. Used by other things too. Value can be 
                 be omitted if no such race exists.  
 attacktype    - favored attack of this god, used in summoning spells and "holy 
                 possession". Weapons blessed by the god get this too.
 protected     - Priest of this god gets this.
 vulnerable    - Priest of this god and recipient of "curse" spell gets this.
 immune        - Recipient of "holy possession" gets this.
 path_attuned  - priest of this god and recipient of "bless" gets this
 path_repelled - priest and recipient of "curse" gets this
 path_denied   - priest and recipient of "curse" gets this
 msg           - comma delimited list of descriptive terms (used by book code).

 wc, ac, hp, dam, etc. - get used when the 'god' is summoned as an avatar.

 last_eat, last_heal, last_sp, last_grace, & various flags - these are used to 
                 pass on certain properties to the worshiping priest. 

Treasure list reference:

Such a list is passed to create_treasure() with flag GT_STARTEQUIP.
The generated treasure is put into the followers inventory.  The
follower can get unlimited amounts of this treasure just by praying
long enough.  See below ("other visible items") for an alternative
way of giving items to followers.

Invisible books (with specific names):

Can be accessed through determine_holy_arch() which will return the
item's other_arch field.  For example, such book with name "avatar"
determines the avatar archetype for the "summon avatar" prayer.

Invisible book with name "grace limit":

If follower doesn't have maximum grace, or follower's grace is less
than item->stats.grace, a "holy possession" prayer is invoked and the
function returns.  Can be used to limit the lower part of the treasure
list to followers with much grace.

Invisible book with name "restore grace":

If the follower's grace is negative, sets the grace to a small
positive value and returns.

Invisible book with name "restore hitpoints":

If the follower's hitpoints are not at their maximum, sets hitpoints
to maximum and returns.

Invisible book with name "restore spellpoints":

Can restore the followers spellpoints.  The maximum spellpoints for
this effect are calculated using this formula:

  max = follower->stats.maxsp * (item->stats.maxsp / 100.0)

In other words, the item's stats.maxsp is the maximum in percent
relative to the followers normal spellpoint maximum.  If the followers
current spellpoints are below 50% of 'max', they are set to a random
value between 50% and 100% of 'max', and the function returns.

Invisible book with name "heal spell":

Casts a heal spell (which spell is determined by item's slaying or
stats.sp field) and returns if the spell was successful.

Invisible book with name "remove curse":

Removes curse from all cursed (but not damned) items, returns if curse
was removed from at least one item.

Invisible book with name "remove damnation":

Removes curse and damnation from all cursed or damned items, returns
if curse or damnation was removed from at least one item.

Invisible book with name "heal depletion":

Removes all depletion effects and returns unless the follower's stats
were not depleted.

Invisible book with name "voice_behind":

The follower hears a voice from behind.  item->msg is what the voice
says.  Always returns.

Invisible book with name "message":

The follower receives item->msg as a simple message.  Always returns.

Invisible book with name "enchant weapon":

The follower's weapon is enchanted in various ways.  item->level
affects how much the weapon is enchanted, higher value means less
enchantment.

Invisible spellbooks:

If the prayer in the book is not yet known to the follower, and the
follower has the required level, teaches the prayer to the follower
and returns.  The prayer is determined by item's slaying field.

Visible spellbooks:

If the prayer in the book is not yet known to the follower, the
follower has the required level, and the follower doesn't already have
a spellbook with that prayer, gives a copy of this spellbook to the
follower and returns.  The item must have FLAG_STARTEQUIP.  The prayer
is determined by item's slaying field.

Other visible items:

If the follower doesn't already have this or a similar item (with same
type, name, title, msg and slaying fields), gives a copy of this item
to the follower.  You have to set FLAG_STARTEQUIP in the archetype
yourself if you wan't the copy to have this flag.  This method (with
FLAG_STARTEQUIP set) should be prefered for giving items to followers,
because it is rather safe to use.  The amount is limited, because if
the follower wants more of it he has to go back to an altar of his
god.  He can't pray an hour over an altar and then go fighting with a
hundred potions of restoration.

Other invisible items:

If the follower doesn't already have it this item, gives it, similar
to visible items.  Except, it ALWAYS gives it, upon conversion.
And on conversion to another religion, it is ALWAYS removed.
Signs and forces and skills may not be given/taken this way.
Revision:	1.1.1.1 (vendor branch)
Committed:	Mon Feb 6 20:26:02 2006 UTC (18 years, 3 months ago) by root
Branch:	UPSTREAM, MAIN
CVS Tags:	pre_first_cfarch_normalize_run, pre_second_normalise_run, post_second_normalise_run, post_normalise_revert, rel-2_82, rel-2_81, rel-2_80, UPSTREAM_2006_03_15, rel-3_0, rel-2_6, rel-2_7, rel-2_4, rel-2_5, rel-2_2, rel-2_0, rel-2_1, rel-2_72, rel-2_73, rel-2_71, rel-2_76, rel-2_77, rel-2_74, rel-2_75, rel-2_54, rel-2_55, rel-2_56, rel-2_79, UPSTREAM_2006_02_01, rel-2_53, rel-2_32, post_first_cfarch_normalize_run, UPSTREAM_2006_02_22, rel-2_90, rel-2_92, rel-2_93, rel-2_78, rel-2_61, pre_normalise_revert, rel-2_43, rel-2_42, rel-2_41, HEAD
Changes since 1.1:	+0 -0 lines
Log Message:	Initial Import
#	User	Rev	Content
1	root	1.1
2			Meaning/uses of Gods archetype values. No particular value is
3			needed to be specified (but it helps!).
4
5			name - name of the god
6			title - diametrically opposed god (not required)
7			other_arch - name of the archetype which is summoned by the holy servant spell
8			race - the name of the race of creatures that are aligned w/ the god.
9			"summon cult monsters" and "pacify" are 2 (of many) spells that
10			use this. Value can be omitted if no race exists.
11			slaying - name of the race of creatures "holy word","holy possession"
12			spells will effect. Used by other things too. Value can be
13			be omitted if no such race exists.
14			attacktype - favored attack of this god, used in summoning spells and "holy
15			possession". Weapons blessed by the god get this too.
16			protected - Priest of this god gets this.
17			vulnerable - Priest of this god and recipient of "curse" spell gets this.
18			immune - Recipient of "holy possession" gets this.
19			path_attuned - priest of this god and recipient of "bless" gets this
20			path_repelled - priest and recipient of "curse" gets this
21			path_denied - priest and recipient of "curse" gets this
22			msg - comma delimited list of descriptive terms (used by book code).
23
24			wc, ac, hp, dam, etc. - get used when the 'god' is summoned as an avatar.
25
26			last_eat, last_heal, last_sp, last_grace, & various flags - these are used to
27			pass on certain properties to the worshiping priest.
28
29			Treasure list reference:
30
31			Such a list is passed to create_treasure() with flag GT_STARTEQUIP.
32			The generated treasure is put into the followers inventory. The
33			follower can get unlimited amounts of this treasure just by praying
34			long enough. See below ("other visible items") for an alternative
35			way of giving items to followers.
36
37			Invisible books (with specific names):
38
39			Can be accessed through determine_holy_arch() which will return the
40			item's other_arch field. For example, such book with name "avatar"
41			determines the avatar archetype for the "summon avatar" prayer.
42
43			Invisible book with name "grace limit":
44
45			If follower doesn't have maximum grace, or follower's grace is less
46			than item->stats.grace, a "holy possession" prayer is invoked and the
47			function returns. Can be used to limit the lower part of the treasure
48			list to followers with much grace.
49
50			Invisible book with name "restore grace":
51
52			If the follower's grace is negative, sets the grace to a small
53			positive value and returns.
54
55			Invisible book with name "restore hitpoints":
56
57			If the follower's hitpoints are not at their maximum, sets hitpoints
58			to maximum and returns.
59
60			Invisible book with name "restore spellpoints":
61
62			Can restore the followers spellpoints. The maximum spellpoints for
63			this effect are calculated using this formula:
64
65			max = follower->stats.maxsp * (item->stats.maxsp / 100.0)
66
67			In other words, the item's stats.maxsp is the maximum in percent
68			relative to the followers normal spellpoint maximum. If the followers
69			current spellpoints are below 50% of 'max', they are set to a random
70			value between 50% and 100% of 'max', and the function returns.
71
72			Invisible book with name "heal spell":
73
74			Casts a heal spell (which spell is determined by item's slaying or
75			stats.sp field) and returns if the spell was successful.
76
77			Invisible book with name "remove curse":
78
79			Removes curse from all cursed (but not damned) items, returns if curse
80			was removed from at least one item.
81
82			Invisible book with name "remove damnation":
83
84			Removes curse and damnation from all cursed or damned items, returns
85			if curse or damnation was removed from at least one item.
86
87			Invisible book with name "heal depletion":
88
89			Removes all depletion effects and returns unless the follower's stats
90			were not depleted.
91
92			Invisible book with name "voice_behind":
93
94			The follower hears a voice from behind. item->msg is what the voice
95			says. Always returns.
96
97			Invisible book with name "message":
98
99			The follower receives item->msg as a simple message. Always returns.
100
101			Invisible book with name "enchant weapon":
102
103			The follower's weapon is enchanted in various ways. item->level
104			affects how much the weapon is enchanted, higher value means less
105			enchantment.
106
107			Invisible spellbooks:
108
109			If the prayer in the book is not yet known to the follower, and the
110			follower has the required level, teaches the prayer to the follower
111			and returns. The prayer is determined by item's slaying field.
112
113			Visible spellbooks:
114
115			If the prayer in the book is not yet known to the follower, the
116			follower has the required level, and the follower doesn't already have
117			a spellbook with that prayer, gives a copy of this spellbook to the
118			follower and returns. The item must have FLAG_STARTEQUIP. The prayer
119			is determined by item's slaying field.
120
121			Other visible items:
122
123			If the follower doesn't already have this or a similar item (with same
124			type, name, title, msg and slaying fields), gives a copy of this item
125			to the follower. You have to set FLAG_STARTEQUIP in the archetype
126			yourself if you wan't the copy to have this flag. This method (with
127			FLAG_STARTEQUIP set) should be prefered for giving items to followers,
128			because it is rather safe to use. The amount is limited, because if
129			the follower wants more of it he has to go back to an altar of his
130			god. He can't pray an hour over an altar and then go fighting with a
131			hundred potions of restoration.
132
133			Other invisible items:
134
135			If the follower doesn't already have it this item, gives it, similar
136			to visible items. Except, it ALWAYS gives it, upon conversion.
137			And on conversion to another religion, it is ALWAYS removed.
138			Signs and forces and skills may not be given/taken this way.