Classes:PowerInfiniteAmmo

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.
Infinite ammunitions power
Actor type Power Game MiniZDoomLogoIcon.png (ZDoom)
DoomEd Number None Class Name PowerInfiniteAmmo


Classes: InventoryPowerupPowerInfiniteAmmo

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).

PowerInfiniteAmmo prevents its owner's weapons from consuming ammo. The powerup itself, however, functions as a simpler marker; its effects are provided by the weapon virtual function CheckAmmo, using this:

...
// If player is using an infinite ammo cheat, or has a PowerInfiniteAmmo
// item, do not consume ammo and return true, signalling that the weapon
// is allowed to fire:
if (sv_infiniteammo || (Owner.FindInventory ('PowerInfiniteAmmo', true) != null))
{
	return true;
}
...
Error.gif
Warning: Any custom function that consumes ammo has to manually check for the presence of this powerup via FindInventory. The powerup itself can NOT prevent ammo from being taken unless the author of the script accounts for it!

For this reasons, any ammo depletion operations should be performed by calling DepleteAmmo on a weapon rathern than taking it manually with A_TakeInventory or similar.


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 PowerInfiniteAmmo : Powerup
{
	Default
	{
		Powerup.Duration -30;
	}
}

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 PowerInfiniteAmmo : Powerup native
{
  Powerup.Duration -30
}