Difference between revisions of "OnHit - ObjectReference"

2,567 bytes removed ,  06:53, 29 January 2023
→‎Notes: Reverting changes while I test out to be sure.
imported>Thingy Person
(→‎Notes: Reverting changes while I test out to be sure.)
 
(4 intermediate revisions by 2 users not shown)
Line 28: Line 28:
EndEvent
EndEvent
</source>
</source>
To avoid the hits from enchantments running the code block one must compare the ''akSource'' to the actual reference that hit the actor/object.
For instance, say we have a weapon with 2 enchantments called "Fire/Ice Sword." When hit with this sword the hit registers as 3 separate hits, but you have code such as:
<source lang="papyrus">
Event OnHit(ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, \
  bool abBashAttack, bool abHitBlocked)
if(akSource as Weapon)
  Variable1 -= 100
EndEvent
</source>
This would actually subtract 300 from Variable1 since the event was called 3 times simultaneously, even though the akSource has been cast as a weapon papyrus counts the hit from the enchantments as "weapons" too so the enchantments are reference as (akSource as Weapon) as well. So the solution is to be more explicit.
<source lang="papyrus">
Event OnHit(ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, \
  bool abBashAttack, bool abHitBlocked)
Form RightHandSword = akAggressor.GetEquippedWeapon(0); this gets the sword that the enemy had in their right hand and stores it as an object variable
if((akSource as weapon) == RightHandSword
;do code stuff
EndEvent
</source>
This will still call the event 3 times, but the code will only fire once when (akSource as weapon) == RightHandSword
*1st hit: Sword: (akSource as weapon) == RightHandSword - fires code
*2nd hit: Enchant1: (akSource as weapon) == SomeEnchant1 - nothing happens
*3rd hit: Enchant2: (akSource as weapon) == SomeEnchant2 - nothing happens
If you had the exact same script but only want the code to run when the actor/object that has the script with the OnHit Event is hit with a certain enchantment, regardless of the sword then:
<source lang="papyrus">
Enchantment Property ''TheEnchantment'' Auto
Event OnHit(ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, \
  bool abBashAttack, bool abHitBlocked)
if((akSource as weapon) == ''TheEnchantment''
;do code stuff
EndEvent
</source>
With this code the Actor/Object with the OnHitEvent script could be hit by 5 different weapons but the onhit event will only fire when the weapon has ''TheEnchantment'' and it will only fire once.


== Notes ==
== Notes ==
akSource and akProjectile can be None under various circumstances:
akSource and akProjectile can be None under various circumstances:
*If specifying akSource, for example as a Weapon, akSource must be ''cast'' to the form that corresponds to the type. For instance, if(akSource ''as'' Weapon)...akSource = Weapon will yield a compiler error.
*This reference is an [[Actor Script|Actor]]:
*This reference is an [[Actor Script|Actor]]:
**akSource can be None if hit by a projectile attack where the projectile was not fired by a weapon or spell
**akSource can be None if hit by a projectile attack where the projectile was not fired by a weapon or spell
Line 97: Line 40:
**akProjectile can be None if hit by a melee attack.
**akProjectile can be None if hit by a melee attack.
Also, if this reference is an [[Actor Script|Actor]] and the projectile was caused by a weapon enchant, the enchanted weapon will be in akSource.
Also, if this reference is an [[Actor Script|Actor]] and the projectile was caused by a weapon enchant, the enchanted weapon will be in akSource.
*This event is called multiple times when akSource has associated magic effects. If a sword has an enchantment with 2 effects, OnHit will be called 3 times - once for the physical damage of the sword and once for each magic effect. In all cases, akSource is the sword and not the enchantment. This also applies to spells (one hit for the spell projectile, and one for each associated magic effect).
*This event is called multiple times when akSource has associated magic effects. If a sword has an enchantment with 2 effects, OnHit will be called 3 times - once for the physical damage of the sword and once for each magic effect. In all cases, akSource is the sword and not the enchantment. This also applies to spells (one hit for the spell projectile, and one for each associated magic effect).


== See Also ==
== See Also ==
*[[ObjectReference Script]]
*[[ObjectReference Script]]
22

edits