Difference between revisions of "EVENT TYPE TRANSITION TO WORLD MAP"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(split off of [[event][)
 
m (remove redundant category)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
*<b>Sent When:</b> Player uses the generic transition system to open the world map
+
{{event
*<b>Sent From:</b>
+
|sourcefile=events_h
*<b>Sent To:</b> module
+
|when=Player uses the generic transition system to open the world map
 +
|from=
 +
|to= [[module]]
 +
|tocategory1=module
 +
|sortkey=TRANSITION_TO_WORLD_MAP
 +
|string0name= sWorldMap
 +
|string0desc= the tag of the map to activate
 +
|string1name= sTransType
 +
|string1desc= will be "rand" when exiting random encounters
 +
|string2name= sWorldMapLoc1
 +
|string2desc= the tag of a map location to activate right before opening the map
 +
|string3name= sWorldMapLoc2
 +
|string3desc= the tag of a map location to activate right before opening the map
 +
|string4name= sWorldMapLoc3
 +
|string4desc= the tag of a map location to activate right before opening the map
 +
|string5name=sWorldMapLoc4
 +
|string5desc= the tag of a map location to activate right before opening the map
 +
|string6name= sWorldMapLoc5
 +
|string6desc= the tag of a map location to activate right before opening the map
 +
}}
  
Parameters:
+
The locations are equivalent to a plot flag in the world map plot or location ID
*  string sWorldMap = GetEventString(ev, 0);
+
*  string sTransType = GetEventString(ev, 1);
+
*  string sWorldMapLoc1 = GetEventString(ev, 2);
+
*  string sWorldMapLoc2 = GetEventString(ev, 3);
+
*  string sWorldMapLoc3 = GetEventString(ev, 4);
+
*  string sWorldMapLoc4 = GetEventString(ev, 5);
+
*  string sWorldMapLoc5 = GetEventString(ev, 6);
+
  
[[Category:Event types|TRANSITION_TO_WORLD_MAP]]
+
[[Category:Map events|TRANSITION_TO_WORLD_MAP]]
[[Category:Maps]]
+

Latest revision as of 00:49, 12 February 2010

Source:
events_h
Sent when:
Player uses the generic transition system to open the world map
Sent from:
Sent to:
module
Parameters:
  • String 0: the tag of the map to activate
  • String 1: will be "rand" when exiting random encounters
  • String 2: the tag of a map location to activate right before opening the map
  • String 3: the tag of a map location to activate right before opening the map
  • String 4: the tag of a map location to activate right before opening the map
  • String 5: the tag of a map location to activate right before opening the map
  • String 6: the tag of a map location to activate right before opening the map

Usage

case EVENT_TYPE_TRANSITION_TO_WORLD_MAP:
{
string sWorldMap = GetEventString(ev, 0); // the tag of the map to activate
string sTransType = GetEventString(ev, 1); // will be "rand" when exiting random encounters
string sWorldMapLoc1 = GetEventString(ev, 2); // the tag of a map location to activate right before opening the map
string sWorldMapLoc2 = GetEventString(ev, 3); // the tag of a map location to activate right before opening the map
string sWorldMapLoc3 = GetEventString(ev, 4); // the tag of a map location to activate right before opening the map
string sWorldMapLoc4 = GetEventString(ev, 5); // the tag of a map location to activate right before opening the map
string sWorldMapLoc5 = GetEventString(ev, 6); // the tag of a map location to activate right before opening the map

// insert event-handling code here

break;
}

The locations are equivalent to a plot flag in the world map plot or location ID