Difference between revisions of "EVENT TYPE REMOVE EFFECT"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (sort key)
m
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
*<b>Sent When:</b> an effect is removed from the receiving object
+
{{needs review}}
*<b>Sent From:</b> engine
+
{{Event
*<b>Sent To:</b> creatures, placeables
+
|sourcefile  = script.ldf
 
+
|when        = an effect is removed from the receiving object
Parameters:
+
|from        = [[engine]]
*<b>Creator:</b> ???
+
|tocategory1 = creature
*<b>Current Effect</b>: effect being removed
+
|tocategory2 = placeable
 
+
|sortkey    = REMOVE_EFFECT
 +
}}
 +
== Remarks ==
 +
Relevant Eclipse engine code:
 +
<cpp>
 +
pEvent->SetType(CSSCRIPTEVENT_EVENTTYPE_RULES_REMOVEEFFECT);
 +
pEvent->SetData(0, pEffect);
 +
</cpp>
 
[[Category:Event types|REMOVE_EFFECT]]
 
[[Category:Event types|REMOVE_EFFECT]]
 +
[[Category:Creature events|REMOVE_EFFECT]]
 +
[[Category:Effect events|REMOVE_EFFECT]]
 +
[[Category:Placeable events|REMOVE_EFFECT]]

Latest revision as of 20:17, 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 removed from the receiving object
Sent from:
engine
Sent to:
Parameters:
None.

Usage

case EVENT_TYPE_REMOVE_EFFECT:
{

// insert event-handling code here

break;
}

Remarks

Relevant Eclipse engine code: <cpp> pEvent->SetType(CSSCRIPTEVENT_EVENTTYPE_RULES_REMOVEEFFECT); pEvent->SetData(0, pEffect); </cpp>