Classes:PowerDrain

From ZDoom Wiki
Jump to navigation Jump to search
Note: Wait! Stop! You do not need to copy this actor's code into your project! Here's why:
  1. This actor is already defined in GZDoom, there's no reason to define it again.
  2. In fact, trying to define an actor with the same name will cause an error (because it already exists).
  3. If you want to make your own version of this actor, use inheritance.
  4. Definitions for existing actors are put on the wiki for reference purpose only.
Health drain power
Actor type Power Game MiniZDoomLogoIcon.png (ZDoom)
DoomEd Number None Class Name PowerDrain


Classes: InventoryPowerupPowerDrain
   (more)

One of the many powerups, i.e. items based on the Powerup class. While an item of this class is placed in an actor's inventory, the actor will be affected by it. Usually powerups are given through a PowerupGiver, but they can be given directly as well (see here for more details).

PowerDrain heals its owner whenever it deals damage to another actor. The amount healed is determined by its Power.Strength property, which is equal to 0.5 by default (50% of damage).

Note: The effects of this powerup are NOT handled by the powerup itself. Instead, they're handled fully internally, in the C++ side of the engine (as can be seen here). However, a similar effect could be achieved manually by creating a powerup with a ModifyDamage override that calls GiveBody to heal its owner whenever they're about to deal damage.

ZScript definition

Note: The ZScript definition below is for reference and may be different in the current version of GZDoom.The most up-to-date version of this code can be found on GZDoom GitHub.
class PowerDrain : Powerup
{
	Default
	{
		Powerup.Strength 0.5;
		Powerup.Duration -60;
	}
}

DECORATE definition

Note: This is legacy code, kept for archival purposes only. DECORATE is deprecated in GZDoom and is completely superseded by ZScript. GZDoom internally uses the ZScript definition above.
ACTOR PowerDrain : Powerup native
{
  Powerup.Duration -60
}

See also