Difference between revisions of "EVENT TYPE ITEM ONHIT"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (|sourcefile=script.ldf)
m (Updating template)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{needs review}}
 
{{needs review}}
 
{{event
 
{{event
|sourcefile=script.ldf
+
|sourcefile   = script.ldf
|when=
+
|sourcemodule =
|from=
+
|sortkey      = ITEM_ONHIT
|to=
+
|when         = This event is only ever processed in [[GM_*|GM_COMBAT]].  That means that NPCs fighting NPCs while not visible to the player  (should never happen anyway) will not trigger OnHit item abilities.
 +
|from         =  
 +
|to           =
 +
|tocategory1  =
 +
|tocategory2  =
 +
|creatorname  = oAttacker
 +
|creatordesc  =
 +
|object0name  = oAttacker
 +
|object0desc  = {{undocumented}}
 +
|int0name    = iEffect
 +
|int0desc    = {{undocumented}}
 +
|int1name    = iPower
 +
|int1desc    = {{undocumented}}
 +
|object1name  = oItem
 +
|object1desc  = {{undocumented}}
 +
|targetname  = oTarget
 +
|targetdesc  = {{undocumented}}
 
}}
 
}}
 
+
== Remarks ==
[[Category:Event types|ITEM_ONHIT]]
+
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>

Latest revision as of 19:11, 21 August 2011

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:

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>