View source for A Explode

__NOTOC__{{codepointer|Generic Attack}}
{{doomwiki|A_Explode}}

'''{{class|Actor}}'''

int '''A_Explode'''(int ''damage'' = -1, int ''distance'' = -1, int ''flags'' = XF_HURTSOURCE, bool ''alert'' = false, int ''fulldamagedistance'' = 0, int ''nails'' = 0, int ''naildamage'' = 10, class<Actor> ''pufftype'' = "BulletPuff", name ''damagetype'' = "none")

== Usage ==
Performs an explosive (radius) attack.

=== Parameters ===

*{{c|int '''damage'''}}
:How much damage is inflicted at the center of the explosion. If this is set to a value that is less than 0, the {{c|{{Property|ExplosionDamage}}}} property is used for the damage. Default is -1.
:Note: The default value of the {{c|{{Property|ExplosionDamage}}}} property is 128.
*{{c|int '''distance'''}}
:The area covered by the damage (damage inflicted drop linearly with distance). Note that a radius larger than 32767 extends beyond ZDoom's map space limitations, and will overflow with undesired results (such as becoming too small and damaging nothing). If {{c|distance}} is less than 0, the {{c|{{Property|ExplosionRadius}}}} property is used for the radius. In this case, if the {{c|{{Property|ExplosionRadius}}}} property is set to a value less than 0, it'll use the same value as the {{c|{{Property|ExplosionDamage}}}} property. 
:Note: The default value of the {{c|{{Property|ExplosionRadius}}}} property is -1, which means it uses the same value as {{c|{{Property|ExplosionDamage}}}}.
*{{c|int '''flags'''}}
:Allows the alteration of the function's behavior. This parameter is ignored in favor of using the {{c|{{Property|DontHurtShooter}}}} property if {{c|damage}} is less than 0. The following flags can be combined by using the <code>|</code> character between the constant names: 
:* {{c|XF_HURTSOURCE}} — '''This flag is set by default.''' Hurts the source: if set, the source can be damaged by the explosion. Note that the source is not necessarily the calling actor. To unset the flag, either use <code>0</code> for the {{c|flags}} argument, or pass other flags to it without passing this one.
:* {{c|XF_NOTMISSILE}} — Not a missile: if set, the calling actor is considered to be the source. By default, the calling actor is assumed to be a projectile, and the source is therefore considered to be the calling actor's [[actor pointer|target]].
:* {{c|XF_EXPLICITDAMAGETYPE}} — If set, the {{c|damagetype}} parameter will never change to the actor's {{Property|DamageType|damage type}}.
:* {{c|XF_NOSPLASH}} — Disables splash: if set, the explosion does not create any [[TERRAIN]] splashes.
:* {{c|XF_THRUSTZ}} — Applies vertical thrust: if set, the attack pushes the victim vertically, in addition to horizontally. Normally, vertical thrust is applied without the need of this flag, but it could be disabled by setting the {{c|{{CVAR|C|compat_explode1}}}} compatibility flag. This flag overrides the compatibility flag.
:* {{c|XF_THRUSTLESS}} — The explosion produces no thrust whatsoever, only dealing pure damage. This can be used to supplement the native thrusting with a custom implementation. {{new|4.11.0}}
:* {{c|XF_NOALLIES}} — The explosion does not affect any actors friendly to the source of the explosion. Only works with {{flag|FRIENDLY}} monsters and players. Keep in mind that ''XF_HURTSOURCE'' still needs to be off to not affect the source. {{new|4.11.0}}
:* {{c|XF_CIRCULAR}} — Changes the shape of the explosion from the vanilla cuboid shape into a spherical shape. {{new|4.11.0}}
*{{c|bool '''alert'''}}
:Whether or not the explosion rings the alarm. This parameter is always set to <code>false</code> if {{c|damage}} is less than 0, regardless of what is passed to it. Default is <code>false</code>.
*{{c|int '''fulldamagedistance'''}}
:The area within which full damage is inflicted. Default is <code>0</code>.
*{{c|int '''nails'''}}
:The number of horizontal [[hitscan]] attacks performed in a ring, originating from the actor's center. A value of <code>30</code> emulates the [[A_NailBomb]] function from [[SMMU]], while still allowing to modify all other parameters from {{c|A_Explode}}. Default is <code>0</code>.
*{{c|int '''naildamage'''}}
:The amount of damage inflicted by the nail attack, if any. Default is <code>10</code>. If {{c|nails}} is <code>0</code>, this, obviously, has no effect.
*{{c|class<Actor> '''pufftype'''}}
:The name of the [[Puff|puff]] class to use for the nail attack. If nothing is supplied, {{c|{{Class|BulletPuff}}}} is used. Default is <code>"BulletPuff"</code>.
*{{c|name '''damagetype'''}}
:The [[damage type]] to use for the damage of this function rather than the actor's own {{Property|DamageType|damage type}}. If left as is without {{c|XF_EXPLICITDAMAGETYPE}}, will use the actor's damage type instead. Default is <code>"none"</code>.

=== Return value ===

Returns the number of actors damaged. Actors that absorb the damage completely are not counted.

== Examples ==

 actor MyGrenade : {{Class|Grenade}}
 {
     {{Property|Speed}} 17
     {{Property|BounceFactor}} 0.4
     {{Property|BounceCount}} 6
 
     States
     {
     Death:
         QEX1 A 0 [[A_PlaySound]]("Weapon/GenericExplode", {{const|CHAN_WEAPON}})
         QEX1 A 5 [[A_Explode]](100, 128)
         QEX1 BCDE 5
         Stop
     }
 }


Whenever this rocket explodes, it logs the number of actors which got damaged by its splash effect.
 actor SmartRocket : {{Class|Rocket}}
 {
     States
     {
     Death:
         MISL B 8 Bright [[A_LogInt]]([[A_Explode]])
         Goto Super::Death+1
     }
 }

== See also ==
*[[A_RadiusThrust]]