Difference between revisions of "EVENT TYPE WORLDMAP PRETRANSITION"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (Updating template)
 
Line 1: Line 1:
 
{{needs review}}
 
{{needs review}}
 
{{event
 
{{event
−
|sourcefile=script.ldf
+
|sourcefile   = script.ldf
−
|when= Game begins the map trail animation
+
|sourcemodule =
−
|from=
+
|sortkey      = WORLDMAP_PRETRANSITION
−
|to=[[module]]
+
|when         = Game begins the map trail animation
−
|tocategory1=module
+
|from         = [[module]]
 +
|to          =
 +
|tocategory1 = Map
 +
|tocategory2  = Module
 
}}
 
}}
  
 
== Remarks ==
 
== Remarks ==
  
−
This is where you want to call UT_DoAreaTransition(); the level will begin loading in the background as the map trail animation plays.
+
When the [[UT_DoAreaTransition]] function is called the level will begin loading in the background as the map trail animation plays.
  
−
Note that since this event doesn't have parameters attached to it, you'll need to get the target area and waypoint tags from some other source. The main campaign manages this via the WM_STORED_AREA and WM_STORED_WP module [[local variable]]s. For example:
+
Since this event does not have parameters attached to it the target area and waypoint tags must be obtained from another source. The Single Player campaign manages this via the WM_STORED_AREA and WM_STORED_WP module [[local variable]]s.  
 +
 
 +
For example:
  
 
<dascript>
 
<dascript>
Line 24: Line 29:
 
</dascript>
 
</dascript>
  
−
[[Category:Map events|WORLDMAP_PRETRANSITION]]
+
[[Category:Pages with example scripts]]
−
[[Category:pages with example scripts]]
+

Latest revision as of 19:12, 21 August 2011

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:
Game begins the map trail animation
Sent from:
module
Sent to:
Parameters:
None.

Usage

case EVENT_TYPE_WORLDMAP_PRETRANSITION:
{

// insert event-handling code here

break;
}

Remarks

When the UT_DoAreaTransition function is called the level will begin loading in the background as the map trail animation plays.

Since this event does not have parameters attached to it the target area and waypoint tags must be obtained from another source. The Single Player campaign manages this via the WM_STORED_AREA and WM_STORED_WP module local variables.

For example: 

case EVENT_TYPE_WORLDMAP_PRETRANSITION:
{
    string sArea = GetLocalString(GetModule(), "WM_STORED_AREA"); //retrieve the target area tag stored in EVENT_TYPE_BEGIN_TRAVEL
    string sWP = GetLocalString(GetModule(), "WM_STORED_WP"); //retrieve the target waypoint tag
    UT_DoAreaTransition(sArea, sWP); //execute the area transition to that target.
    break;
}
Retrieved from "http://www.datoolset.net/mw/index.php?title=EVENT_TYPE_WORLDMAP_PRETRANSITION&oldid=17113"