EVENT DAMAGESPRITE - Revision history

Doom64hunter at 19:41, 5 February 2022

2022-02-05T19:41:08Z

← Older revision		Revision as of 12:41, 5 February 2022
Line 36:		Line 36:
	:; userdef.return 5		:; userdef.return 5
	:: Contains the damage dealt in the innermost blast radius area. (usually defined to be the highest)		:: Contains the damage dealt in the innermost blast radius area. (usually defined to be the highest)

			[[Category:Events]]

Doom64hunter at 14:17, 5 February 2022

2022-02-05T14:17:14Z

← Older revision		Revision as of 07:17, 5 February 2022
Line 2:		Line 2:

	'''EVENT_DAMAGESPRITE''' is a [[EDuke32_event_list\|Game Event]].		'''EVENT_DAMAGESPRITE''' is a [[EDuke32_event_list\|Game Event]].

			This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage is actually accumulated in [[htextra]].

	This event is only executed if the tilenum was set with [[damageeventtile]] and [[damageeventtilerange]].		This event is only executed if the tilenum was set with [[damageeventtile]] and [[damageeventtilerange]].

	~~This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage is actually accumulated in [[htextra]].~~

	[[THISACTOR]] equals the spriteNum of the projectile or source of damage.		[[THISACTOR]] equals the spriteNum of the projectile or source of damage.

Doom64hunter at 11:50, 4 February 2022

2022-02-04T11:50:22Z

← Older revision		Revision as of 04:50, 4 February 2022
Line 1:		Line 1:
			{{EventTable\|1=EVENT_DAMAGESPRITE\|2=-1\|3=Damage Source\|4=2-6 values}}

	'''EVENT_DAMAGESPRITE''' is a [[EDuke32_event_list\|Game Event]].		'''EVENT_DAMAGESPRITE''' is a [[EDuke32_event_list\|Game Event]].

Line 5:		Line 7:
	This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage is actually accumulated in [[htextra]].		This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage is actually accumulated in [[htextra]].

	[[THISACTOR]] equals the ID of the projectile or source of damage.		[[THISACTOR]] equals the spriteNum of the projectile or source of damage.

	[[RETURN]] contains the ID of the sprite that is being damaged. If you set this to -1, you can skip damage application entirely, in which case no damage is accumulated in [[htextra]], and [[EVENT_POSTDAMAGESPRITE]] will not occur.		[[RETURN]] contains the spriteNum of the sprite that is being damaged. If you set this to -1, you can skip damage application entirely, in which case no damage is accumulated in [[htextra]], and [[EVENT_POSTDAMAGESPRITE]] will not occur.

	See also [[EVENT_DAMAGEFLOOR]], [[EVENT_DAMAGECEILING]], [[EVENT_DAMAGEWALL]] and [[EVENT_POSTDAMAGESPRITE]].		See also [[EVENT_DAMAGEFLOOR]], [[EVENT_DAMAGECEILING]], [[EVENT_DAMAGEWALL]] and [[EVENT_POSTDAMAGESPRITE]].
Line 13:		Line 15:
	== Return Values ==		== Return Values ==

	The return values of this event are only set if the damage type is RADIUSDAMAGE.		The additional return values of this event are only set if the damage type is RADIUSDAMAGE, i.e. explosive damage. If the damage was not caused by an explosion, only `userdef.return 0` is set, and `userdef.return 1` will be set to -1.

	Note that radius damage is hard-coded to override all previously accumulated damage in a single tic. To bypass this, set RETURN to -1 and use the following values to apply the radius damage manually.		Note that radius damage is hard-coded to override all previously accumulated damage in a single tic. To bypass this, set RETURN to -1 and use the following values to apply the radius damage manually.

Doom64hunter: Document return values in more detail

2021-12-18T10:18:41Z

Document return values in more detail

← Older revision		Revision as of 03:18, 18 December 2021
Line 1:		Line 1:
	'''EVENT_DAMAGESPRITE''' is a [[EDuke32_event_list\|Game Event]].		'''EVENT_DAMAGESPRITE''' is a [[EDuke32_event_list\|Game Event]].

	This event is ~~triggered whenever a sprite is hit by a weapon, however it is~~ executed ~~before~~ the ~~damage~~.		This event is only executed if the tilenum was set with [[damageeventtile]] and [[damageeventtilerange]].

	This event is ~~only~~ executed if the ~~tilenum was set with~~ [[~~damageeventtile]] and [[damageeventtilerange~~]].		This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage is actually accumulated in [[htextra]].

	[[THISACTOR]] equals the ID of the projectile or source of damage.		[[THISACTOR]] equals the ID of the projectile or source of damage.

	[[RETURN]] or the ~~userdef~~ [[return (userdef)\|return]] 0 ~~equals~~ the ID of ~~what is~~ being damaged.		[[RETURN]] contains the ID of the sprite that is being damaged. If you set this to -1, you can skip damage application entirely, in which case no damage is accumulated in [[htextra]], and [[EVENT_POSTDAMAGESPRITE]] will not occur.

			See also [[EVENT_DAMAGEFLOOR]], [[EVENT_DAMAGECEILING]], [[EVENT_DAMAGEWALL]] and [[EVENT_POSTDAMAGESPRITE]].

			== Return Values ==

			The return values of this event are only set if the damage type is RADIUSDAMAGE.

			Note that radius damage is hard-coded to override all previously accumulated damage in a single tic. To bypass this, set RETURN to -1 and use the following values to apply the radius damage manually.

			:; userdef.return 0 (alias RETURN)
			:: Is set to the spritenum of the sprite being damaged. Set to -1 to skip applying the damage entirely. Cannot be used to change the destination of the damage.

			:; userdef.return 1
			:: Contains the blast radius if the damage type was radius damage. This value is set to -1 if no radius damage occurred.

			:; userdef.return 2
			:: Contains the damage dealt in the outermost blast radius area. (usually defined to be the lowest)

	~~The~~ userdef return ~~1 through 5 equals~~ the ~~[[hitradius]] parameters. If there's no~~ radius ~~damage, return 1 equals -1~~.		:; userdef.return 3
			:: Contains the damage dealt in the second to outermost blast radius area.

	~~See also [[EVENT_DAMAGEFLOOR]], [[EVENT_DAMAGECEILING]], [[EVENT_DAMAGEWALL]] and [[EVENT_POSTDAMAGESPRITE]]~~.		:; userdef.return 4
			:: Contains the damage dealt in the second to innermost blast radius area.

			:; userdef.return 5
			:: Contains the damage dealt in the innermost blast radius area. (usually defined to be the highest)

Fox: Created page with "'''EVENT_DAMAGESPRITE''' is a Game Event. This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage. This..."

2020-02-20T12:51:11Z

Created page with "'''EVENT_DAMAGESPRITE''' is a Game Event. This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage. This..."

New page

'''EVENT_DAMAGESPRITE''' is a [[EDuke32_event_list|Game Event]].

This event is triggered whenever a sprite is hit by a weapon, however it is executed before the damage.

This event is only executed if the tilenum was set with [[damageeventtile]] and [[damageeventtilerange]].

[[THISACTOR]] equals the ID of the projectile or source of damage.

[[RETURN]] or the userdef [[return (userdef)|return]] 0 equals the ID of what is being damaged.

The userdef return 1 through 5 equals the [[hitradius]] parameters. If there's no radius damage, return 1 equals -1.

See also [[EVENT_DAMAGEFLOOR]], [[EVENT_DAMAGECEILING]], [[EVENT_DAMAGEWALL]] and [[EVENT_POSTDAMAGESPRITE]].