Difference between revisions of "EVENT TYPE WORLDMAP PRETRANSITION"
From Dragon Age Toolset Wiki
KigenBarzhad (Talk | contribs) |
m (Updating template) |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{needs review}} | {{needs review}} | ||
{{event | {{event | ||
− | |sourcefile=script.ldf | + | |sourcefile = script.ldf |
− | | | + | |sourcemodule = |
− | | | + | |sortkey = WORLDMAP_PRETRANSITION |
− | | | + | |when = Game begins the map trail animation |
− | |tocategory1= | + | |from = [[module]] |
+ | |to = | ||
+ | |tocategory1 = Map | ||
+ | |tocategory2 = Module | ||
}} | }} | ||
− | [[Category: | + | == 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 variable]]s. | ||
+ | |||
+ | For example: | ||
+ | |||
+ | <dascript> | ||
+ | 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; | ||
+ | } | ||
+ | </dascript> | ||
+ | |||
+ | [[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
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; }