Difference between revisions of "EVENT TYPE REMOVE EFFECT"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (Fixing category)
Line 1: Line 1:
 
{{needs review}}
 
{{needs review}}
 
{{Event
 
{{Event
|sourcefile=script.ldf
+
|sourcefile = script.ldf
|when= an effect is removed from the receiving object
+
|when       = an effect is removed from the receiving object
|from= [[engine]]
+
|from       = [[engine]]
|tocategory1= creature
+
|tocategory1 = creature
|tocategory2= placeable
+
|tocategory2 = placeable
|sortkey=REMOVE_EFFECT
+
|sortkey     = REMOVE_EFFECT
 
}}
 
}}
 
+
== Remarks ==
from SEffectHandler.cpp:
+
Eclipse code from SEffectHandler.cpp:
 
+
<pre>
 
:pEvent->SetType( CSSCRIPTEVENT_EVENTTYPE_RULES_REMOVEEFFECT );
 
:pEvent->SetType( CSSCRIPTEVENT_EVENTTYPE_RULES_REMOVEEFFECT );
 
:pEvent->SetData(0, pEffect);
 
:pEvent->SetData(0, pEffect);
 
+
</pre>
 
[[Category:Event types|REMOVE_EFFECT]]
 
[[Category:Event types|REMOVE_EFFECT]]
 
[[Category:Creature events|REMOVE_EFFECT]]
 
[[Category:Creature events|REMOVE_EFFECT]]
 +
[[Category:Effect events|REMOVE_EFFECT]]
 
[[Category:Placeable events|REMOVE_EFFECT]]
 
[[Category:Placeable events|REMOVE_EFFECT]]
[[Category:Effects]]
 

Revision as of 20:15, 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

Eclipse code from SEffectHandler.cpp:

:pEvent->SetType( CSSCRIPTEVENT_EVENTTYPE_RULES_REMOVEEFFECT );
:pEvent->SetData(0, pEffect);