EVENT TYPE ITEM ONHIT

The documentation on this page is incomplete, obsolete, or otherwise in need of a thorough review. The current content may provide a good starting point for this, but do not rely on its accuracy when using it to design content.

Source:

script.ldf

Sent when:

This event is only ever processed in GM_COMBAT. That means that NPCs fighting NPCs while not visible to the player (should never happen anyway) will not trigger OnHit item abilities.

Sent from:

Sent to:

Parameters:

• Creator: ^{[Undocumented]}
• Target: ^{[Undocumented]}
• Integer 0: ^{[Undocumented]}
• Integer 1: ^{[Undocumented]}
• Object 0: ^{[Undocumented]}
• Object 1: ^{[Undocumented]}

Usage

case EVENT_TYPE_ITEM_ONHIT:
{
object oAttacker = GetEventCreator(ev); //
object oTarget = GetEventTarget(ev); // ^{[Undocumented]}
int iEffect = GetEventInteger(ev, 0); // ^{[Undocumented]}
int iPower = GetEventInteger(ev, 1); // ^{[Undocumented]}
object oAttacker = GetEventObject(ev, 0); // ^{[Undocumented]}
object oItem = GetEventObject(ev, 1); // ^{[Undocumented]}

// insert event-handling code here

break;
}

Remarks

Relevant Eclipse engine code: <cpp>

   pAttackerOnHitEvent->SetCreator(nAttackerId);
   pAttackerOnHitEvent->SetObjectId(0, nAttackerId);
   pAttackerOnHitEvent->SetInteger(0, pAttackerItem->GetOnHitEffectId());
   pAttackerOnHitEvent->SetInteger(1, pAttackerItem->GetOnHitPower());
   pAttackerOnHitEvent->SetObjectId(1, pAttackerItem->GetId());
   pAttackerOnHitEvent->SetTarget(a_pEventData->m_nTargetId);

</cpp>