EVENT TYPE APPLY EFFECT

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:

an effect is applied to the receiving object

Sent from:

engine

Sent to:

creature, placeable

Parameters:

• Creator: ^{[Undocumented]}

Usage

case EVENT_TYPE_APPLY_EFFECT:
{

// insert event-handling code here

break;
}

Remarks

Relevant Eclipse engine code: <cpp>

   pEvent->SetType(CSSCRIPTEVENT_EVENTTYPE_RULES_APPLYEFFECT);
   pEvent->SetData(0, pEffect);

</cpp>

Use GetCurrentEffect to get the effect that was just applied (there is no GetEventEffect function) which can be decomposed to get the effect's creator, type, etc.