OnHit - ObjectReference

Member of: ObjectReference Script (Papyrus)

Event called when the object reference is hit by a weapon or projectile.

Syntax

Event OnHit(ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, \
  bool abBashAttack, bool abHitBlocked)

Parameters

• akAggressor: The ObjectReference that attacked this reference.
• akSource: The Weapon, Spell, Explosion, Ingredient, Potion, or Enchantment that hit this reference.
• akProjectile: The Projectile that hit this reference.
• abPowerAttack: Was the hit caused by a power attack?
• abSneakAttack: Was the hit caused by a sneak attack?
• abBashAttack: Was the hit caused by a bash attack?
• abHitBlocked: Was the hit blocked?

Examples

Event OnHit(ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, \
  bool abBashAttack, bool abHitBlocked)
  Debug.Trace("We were hit by " + akAggressor)
EndEvent

Notes

akSource and akProjectile can be None under various circumstances:

• This reference is an Actor:
  • akSource can be None if hit by a projectile attack where the projectile was not fired by a weapon or spell
  • akProjectile can be None if hit by a melee attack.
• This reference is not an Actor:
  • akWeapon can be None if hit by a projectile attack where the projectile was not fired by a weapon (for example, a magic spell with a projectile component).
  • akProjectile can be None if hit by a melee attack.

Also, if this reference is an Actor and the projectile was caused by a weapon enchant, the enchanted weapon will be in akWeapon.

See Also

• ObjectReference Script