Classes:ArtiPoisonBagGiver

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.
Generic giver fléchette
Actor type Artifact Game MiniZDoomLogoIcon.png (ZDoom)
DoomEd Number None Class Name ArtiPoisonBagGiver


Classes: InventoryArtiPoisonBagArtiPoisonBagGiver

A generic fléchette class from which to derive custom actors to create new types of fléchettes. When used, the fléchette will add to the player's inventory an inventory item corresponding to its MissileType. This can be combined with CustomInventory items as the missile type to achieve many sorts of powerful effects.

To assign a flechette type to a player class, use the Player.FlechetteType property in the code for the player class.

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 ArtiPoisonBagGiver : ArtiPoisonBag
{
	Default
	{
		Inventory.Icon "ARTIPSB4";
	}
	
	override bool Use (bool pickup)
	{
		Class<Actor> missiletype = MissileName;
		if (missiletype != null)
		{
			Actor mo = Spawn (missiletype, Owner.Pos, ALLOW_REPLACE);
			if (mo != null)
			{
				Inventory inv = Inventory(mo);
				if (inv && inv.CallTryPickup(Owner)) return true;
				mo.Destroy();	// Destroy if not inventory or couldn't be picked up
			}
		}
		return false;
	}
	
}

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 ArtiPoisonBagGiver : ArtiPoisonBag native
{
  Inventory.Icon "ARTIPSB4"
}