LuaAPI: Point to HealHog
authorWuzzy
Thu, 03 May 2018 00:08:47 +0100
changeset 1381 6695b6e1d39a
parent 1380 a43703093ab0
child 1382 8d6310a05033
LuaAPI: Point to HealHog
LuaAPI.wiki
--- a/LuaAPI.wiki	Thu May 03 00:03:42 2018 +0100
+++ b/LuaAPI.wiki	Thu May 03 00:08:47 2018 +0100
@@ -819,6 +819,8 @@
 === <tt>!SetHealth(gearUid, health)</tt> ===
 Sets the health of the specified gear. The “health” of a gear can refer to many things, depending on the gear type.
 
+*Hint*: If you like to increase the health of a hedgehog with nice visual effects, consider using `HealHog` instead.
+
 Use cases:
 
   * Setting the health of a hedgehog (`gtHedgehog`) to 99
@@ -849,9 +851,9 @@
     end</code>
 
 === `HealHog(gearUid, healthBoost[, showMessage[, tint]])` (0.9.24) ===
-Convenience function to increase the health of hogs with default effects.
+Convenience function to increase the health of a hedgehog with default visual effects.
 
-Increases the health of the hedgehog gear with the given ID `gearUid` by `healthBoost`, displays some healing particles at the hedgehog and shows the health increae as a message. This is similar to the behavour after taking a health crate, or getting a health boost from vampirism.
+Specifically, this increases the health of the hedgehog gear with the given ID `gearUid` by `healthBoost`, displays some healing particles at the hedgehog and shows the health increae as a message. This is similar to the behavour after taking a health crate, or getting a health boost from vampirism.
 
 If `showMessage` is false, no message is shown. With `tint` you can set the RGBA color of the particles (default: `0x00FF00FF`).