Difference between revisions of "WorldMapStartTravelling"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=WorldMapStartTravelling | |name=WorldMapStartTravelling | ||
| − | |brief=Start traveling on the world map to the location clicked. If a random encounter area tag and waypoint tag were specified then travel on the world map and have a random encounter at the specified location. Otherwise, sends the | + | |brief=Start traveling on the world map to the location clicked. If a random encounter area tag and waypoint tag were specified then travel on the world map and have a random encounter at the specified location. Otherwise, sends the [[EVENT_TYPE_FINISH_TRAVEL]] event when completed. |
|param1type=string | |param1type=string | ||
|param1name=sRandomEncounterArea | |param1name=sRandomEncounterArea | ||
|param1desc=tag of the random encounter target area | |param1desc=tag of the random encounter target area | ||
| + | |param1default="" | ||
|param2type=string | |param2type=string | ||
|param2name=sRandomEncounterWaypointTag | |param2name=sRandomEncounterWaypointTag | ||
|param2desc=tag of the random encounter target waypoint | |param2desc=tag of the random encounter target waypoint | ||
| + | |param2default="" | ||
|param3type=object | |param3type=object | ||
|param3name=oSourceLocationOverride | |param3name=oSourceLocationOverride | ||
|param3desc=map pin override object to start travelling from on the world map | |param3desc=map pin override object to start travelling from on the world map | ||
| + | |param3default=OBJECT_INVALID | ||
|returntype=void | |returntype=void | ||
|returndesc= | |returndesc= | ||
| Line 30: | Line 32: | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
| − | [[Category: | + | [[Category:Map functions]] |
Latest revision as of 23:25, 9 February 2010
Start traveling on the world map to the location clicked. If a random encounter area tag and waypoint tag were specified then travel on the world map and have a random encounter at the specified location. Otherwise, sends the EVENT_TYPE_FINISH_TRAVEL event when completed.
void WorldMapStartTravelling(
string sRandomEncounterArea = "",
string sRandomEncounterWaypointTag = "",
object oSourceLocationOverride = OBJECT_INVALID
);
string sRandomEncounterArea = "",
string sRandomEncounterWaypointTag = "",
object oSourceLocationOverride = OBJECT_INVALID
);
- Parameters:
- sRandomEncounterArea
- tag of the random encounter target area
- sRandomEncounterWaypointTag
- tag of the random encounter target waypoint
- oSourceLocationOverride
- map pin override object to start travelling from on the world map
- Returns:
- Nothing.
- Source:
- script.ldf
