Difference between revisions of "HandleEvent"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
m |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=HandleEvent | |name=HandleEvent | ||
Line 6: | Line 5: | ||
|param1name=evEvent | |param1name=evEvent | ||
|param1desc=The event to handle | |param1desc=The event to handle | ||
+ | |param1default= | ||
|param2type=resource | |param2type=resource | ||
|param2name=rScriptName | |param2name=rScriptName | ||
|param2desc=The script that will handle the event (*.ncs). If no script is specified then the object's default script will be run | |param2desc=The script that will handle the event (*.ncs). If no script is specified then the object's default script will be run | ||
+ | |param2default=R"" | ||
|returntype=void | |returntype=void | ||
|returndesc= | |returndesc= | ||
Line 17: | Line 18: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
− | Handles the specified event by passing it to the specified | + | Handles the specified event by passing it to the specified script for processing. You can access the event in the script by calling GetCurrentEvent() and doing all of your processing there. This function is executed inline. |
− | script for processing. You can access the event in the script | + | |
− | by calling GetCurrentEvent() and doing all of your processing | + | |
− | there. This function is executed inline. | + | |
− | + | == Remarks == | |
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
+ | The maximum level of event rerouteing is 8. | ||
<!-- == Examples == --> | <!-- == Examples == --> |
Latest revision as of 01:45, 6 December 2009
Handles the event.
- Parameters:
- evEvent
- The event to handle
- rScriptName
- The script that will handle the event (*.ncs). If no script is specified then the object's default script will be run
- Returns:
- Nothing.
- Source:
- script.ldf
Description
Handles the specified event by passing it to the specified script for processing. You can access the event in the script by calling GetCurrentEvent() and doing all of your processing there. This function is executed inline.
Remarks
The maximum level of event rerouteing is 8.