1.x/Healer: Difference between revisions

Revision as of 17:08, 2 September 2011

Healers can provide a health boost when you run out of food. You can heal yourself by right-clicking one with a take-health item (default is a diamond sword). Healers aren't immortal though, they will run out of health eventually. To give health back, right-click one with the give-health item (default is a wool block). Additionally, you can increase a healer's level and therefore increase its maximum health. A healer starts at Level 1 with a maximum of 10 health points. Health will regenerate 1 health point (this can be turned off in citizens.yml) at a calculated interval. For more on that, see the Health Regeneration section.

Configuration Nodes

These nodes can be found in citizens.yml.

Setting - path of the setting
Default Value - default value of the setting
Description - short description of the setting

Setting	Default Value	Description
economy.prices.healer.creation	100	Amount that is charged when an NPC is toggled to a healer for the first time
economy.prices.healer.levelup	100	Base price that is charged when a healer is leveled up, multiplied based on amount of levels you level-up a healer	economy.prices.healer.heal	100	Amount that is charged when you get healed by a healer
healers.give-health-item	35	ID of the item used to give health to a healer
healers.take-health-item	276	ID of the item used to take health from a healer (i.e. heal yourself)
healers.health-regen-increment	12000	Tick multiplier used in equation to determine delay between each health regeneration
wizards.interact-item	288	ID of the item that a player must use to interact with a wizard

Commands

[] - Mandatory
() - Optional

Command - command's syntax
Args Description - description of the command's arguments
Require Selected - whether the command requires an NPC to be selected
Require Ownership - whether the commands requires you to be the owner of the NPC
Permission - command's permission node
Description - short description of the command

Command	Args Description	Require Selected	Require Ownership	Permission	Description
/healer help	None	false	false	citizens.healer.use.help	View the help page for healers
/healer status	None	true	true	citizens.healer.use.status	View the current level and health of a healer
/healer level-up (levels)	levels - amount of levels to level-up a healer	true	true	citizens.healer.modify.levelup	Level-up a healer the specified amount of levels

Health Regeneration

If a healer isn't at full health, their health will regenerate every X ticks based on their level. Here is the equation for calculating the regeneration delay:

regen ticks = level * increment

level: Level of the healer increment: Tick multiplier, can be changed in citizens.yml

Other Permissions

Permission - permission node
Description - description of permission node

Permission	Description
citizens.healer.use.heal	Ability to interact with a healer (heal and give health)

Future

Cooldowns between each heal

FAQ

Why isn't my healer healing when I left-click hi?! I am sure that I am using the correct heal-item.
In 1.1, healers were changed to heal when right-clicked.

Why isn't my healer healing when I right-click it?
Make sure that you are using the correct item. You can give health with a block of wool and take health with a diamond sword. Both of these are configurable in citizens.yml.

@@ Line 1: / Line 1: @@
-Description here.
+Healers can provide a health boost when you run out of food. You can heal yourself by right-clicking one with a take-health item (default is a diamond sword). Healers aren't immortal though, they will run out of health eventually. To give health back, right-click one with the give-health item (default is a wool block). Additionally, you can increase a healer's level and therefore increase its maximum health. A healer starts at Level 1 with a maximum of 10 health points. Health will regenerate 1 health point (this can be turned off in ''citizens.yml'') at a calculated interval. For more on that, see the Health Regeneration section.
 == Configuration Nodes ==
+These nodes can be found in ''citizens.yml''.
+'''Setting''' - path of the setting
+<br>'''Default Value''' - default value of the setting
+<br>'''Description''' - short description of the setting
+{| class="wikitable" style="text-align: center;"
+! style="width: 250px;" | Setting
+! style="width: 200px;" | Default Value
+! Description
+|-
+| economy.prices.healer.creation
+| 100
+| Amount that is charged when an NPC is toggled to a healer for the first time
+|-
+| economy.prices.healer.levelup
+| 100
+| Base price that is charged when a healer is leveled up, multiplied based on amount of levels you level-up a healer
+|
+| economy.prices.healer.heal
+| 100
+| Amount that is charged when you get healed by a healer
+|-
+| healers.give-health-item
+| 35
+| ID of the item used to give health to a healer
+|-
+| healers.take-health-item
+| 276
+| ID of the item used to take health from a healer (i.e. heal yourself)
+|-
+| healers.health-regen-increment
+| 12000
+| Tick multiplier used in equation to determine delay between each health regeneration
+|-
+| wizards.interact-item
+| 288
+| ID of the item that a player must use to interact with a wizard
+|}
 == Commands ==
+'''[]''' - Mandatory
+<br>'''()''' - Optional
+'''Command''' - command's syntax
+<br>'''Args Description''' - description of the command's arguments
+<br>'''Require Selected''' - whether the command requires an NPC to be selected
+<br>'''Require Ownership''' - whether the commands requires you to be the owner of the NPC
+<br>'''Permission''' - command's permission node
+<br>'''Description''' - short description of the command
+{| class="wikitable" style="text-align: center;"
+! style="width: 250px;" | Command
+! style="width: 200px;" | Args Description
+! style="width: 150px;" | Require Selected
+! style="width: 150px;" | Require Ownership
+! style="width: 170px;" | Permission
+! Description
+|-
+| /healer help
+| ''None''
+| false
+| false
+| citizens.healer.use.help
+| View the help page for healers
+|-
+| /healer status
+| ''None''
+| true
+| true
+| citizens.healer.use.status
+| View the current level and health of a healer
+|-
+| /healer level-up (levels)
+| ''levels'' - amount of levels to level-up a healer
+| true
+| true
+| citizens.healer.modify.levelup
+| Level-up a healer the specified amount of levels
+|}
+== Health Regeneration ==
+If a healer isn't at full health, their health will regenerate every X ticks based on their level. Here is the equation for calculating the regeneration delay:
+<pre>regen ticks = level * increment</pre>
+level: Level of the healer
+increment: Tick multiplier, can be changed in ''citizens.yml''
+== Other Permissions ==
+'''Permission''' - permission node
+<br>'''Description''' - description of permission node
+{| class="wikitable" style="text-align: center;"
+! style="width: 250px;" | Permission
+! style="width: 500px;" | Description
+|-
+| citizens.healer.use.heal
+| Ability to interact with a healer (heal and give health)
+|}
+== Future ==
+* Cooldowns between each heal
 == FAQ ==
-'''My healer isn't healing when I left-click him! I am using the correct heal-item I am sure of this ZOMGGG!!!!!1111'''
+'''Why isn't my healer healing when I left-click hi?! I am sure that I am using the correct heal-item.'''
-<br>Healers do not work in areas where PvP is disabled. Make sure your healer is not in one of those areas and that PvP is set to true for your world. This is a Bukkit bug.
+<br>In 1.1, healers were changed to heal when right-clicked.
+'''Why isn't my healer healing when I right-click it?'''
+<br>Make sure that you are using the correct item. You can give health with a block of wool and take health with a diamond sword. Both of these are configurable in ''citizens.yml''.