Diff for "getTravelTime" - NEAT Portal Wiki

Diff for "getTravelTime"

Differences between revisions 2 and 9 (spanning 7 versions)

this function will return the time in seconds it takes to march from point A to point B using a particular type of troops, taking into account player's relevant tech levels for compass or horseback riding.

usage:

city.getTravelTime(fieldId1,fieldId2,troopBean,type)

fieldId1 and fieldId2 are the fieldId's which represent coordinates for point A and B, troopBean is a special object representing a single wave of troops of any type or combination, and type can be 2 for transport or reinforcement waves or 5 for attack or scout waves.

example:

coords="123,456"
targetId =GetFieldId(coords)
// converts coords into fieldId

troops = "s:100k"
troopBean = GetTroops(troops)
// converts troop string into troopBean object

transTime = city.getTravelTime(city.fieldId, targetId, troopBean, 2)  // returns time to transport or reinforce target coords in seconds - from point A (city.fieldId) to point B (targetId) using specified troopBean

attackTime = city.getTravelTime(city.fieldId, targetId, troopBean, 5)  // returns time to send attack or scout to target coords in seconds - from point A (city.fieldId) to point B (targetId) using specified troopBean

Related Functions:

GetFieldId()

GetTroops()

CategoryFunctions

getTravelTime (last edited 2014-02-10 18:28:49 by Inanna)

-  ⇤ ← Revision 2 as of 2013-07-31 05:25:48 → 
  Size: 1077
  Editor: tech
  Comment:
+   ← Revision 9 as of 2013-08-04 21:37:00 → ⇥
  Size: 1319
  Editor: tech
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-this function will return the time in seconds it takes to march from point A to point B using a particular type of troops
+this function will return the time in seconds it takes to march from point A to point B using a particular type of troops, taking into account player's relevant tech levels for compass or horseback riding.
 Line 4:
-Line 7:
+Line 6:
-fieldId1 and fieldId2 are the fieldId's which represent coordinates for point A and B, troopBean is a special object representing a single wave of troops of any type or combination, and type can be 2 for transport or reinforcement waves or 5 for attack or scout waves.
+fieldId1 and fieldId2 are the [[FieldId|fieldId]]'s which represent coordinates for point A and B, troopBean is a special object representing a single wave of troops of any type or combination, and type can be 2 for transport or reinforcement waves or 5 for attack or scout waves.
-Line 11:
+Line 9:
+{{{
coords="123,456"
targetId =GetFieldId(coords)
// converts coords into fieldId
-Line 12:
+Line 14:
-coords="123,456"
targetId = GetFieldId(coords)
 Line 15:
-Line 19:
+Line 18:
-transTime = city.getTravelTime(city.fieldId, targetId, troopBean, 2)
// returns time to transport or reinforce target coords in seconds - from point A (city.fieldId) to point B (targetId) using specified troopBean
+transTime = city.getTravelTime(city.fieldId, targetId, troopBean, 2)  // returns time to transport or reinforce target coords in seconds - from point A (city.fieldId) to point B (targetId) using specified troopBean
-Line 22:
+Line 20:
-attackTime = city.getTravelTime(city.fieldId, targetId, troopBean, 5)
// returns time to send attack or scout to targeth coords in seconds - from point A (city.fieldId) to point B (targetId) using specified troopBean
+attackTime = city.getTravelTime(city.fieldId, targetId, troopBean, 5)  // returns time to send attack or scout to target coords in seconds - from point A (city.fieldId) to point B (targetId) using specified troopBean
}}}
== Related Functions: ==
[[GetFieldId|GetFieldId()]]

[[GetTroops|GetTroops()]]

----
CategoryFunctions