Difference between revisions of "EVENT TYPE APPLY EFFECT"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (sort key)
m
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
*<b>Sent When:</b> an effect is applied to the receiving object
+
{{needs review}}
*<b>Sent From:</b> engine
+
{{event
*<b>Sent To:</b> creatures, placeables
+
|sourcefile  = script.ldf
 +
|when        = an effect is applied to the receiving object
 +
|to          = creature, placeable
 +
|tocategory1 = creature
 +
|tocategory2 = placeable
 +
|from        = engine
 +
|creatordesc = {{undocumented}}
 +
|sortkey    = APPLY_EFFECT
 +
}}
 +
== Remarks ==
 +
Relevant Eclipse engine code:  
 +
<cpp>
 +
    pEvent->SetType(CSSCRIPTEVENT_EVENTTYPE_RULES_APPLYEFFECT);
 +
    pEvent->SetData(0, pEffect);
 +
</cpp>
  
Parameters:
+
Use [[GetCurrentEffect]] to get the effect that was just applied (there is no <code>GetEventEffect</code> function) which can be decomposed to get the effect's creator, type, etc.
*<b>Creator:</b> ???
+
*<b>Current Effect</b>: effect being applied
+
  
 
[[Category:Event types|APPLY_EFFECT]]
 
[[Category:Event types|APPLY_EFFECT]]
 +
[[Category:Effect events|APPLY_EFFECT]]

Latest revision as of 20:16, 10 March 2012

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:

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.