Templates

Object
- Templates

```
public abstract class Templates
extends Object
```
This class provides a collection Templates that can be used in certain UI gadgets, such as the FormatTextGadget. At runtime, these templates are parsed and their actual value is shown to the user. The syntax is as follows: {template_name(param)}.

I'm not 100% sure that this list is complete, but the most useful ones are certainly present.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Note

Chats use a FormatTextGadget, so these templates can be used there.
,
Nesting commands won't work properly.
,
String arguments may be passed without quotes.
,
The results of these function calls isn't stored anywhere, so with every new screen refresh the functions are recalculated and might have a different value. On top of that the result isn't necessarily the same for every player, e.g. {playerName(-1)} shows the nickname of the player looking at the text.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`string`	`aiDifficulty()` The current difficulty level, i.e.
`string`	`areaDebugText()` AI area debug text
`string`	`areaGroupDebugText()` AI area group debug text
`string`	`attackRouteDebugText()` AI attack route debug text
`string`	`baseDebugText()` AI base info text
`string`	`buildingPlacementDebugText()` AI BP debug text
`string`	`colorizeCost()`
`bool`	`configDefined(int configIndex)` True if the given config is defined.
`string`	`countdown()` Holds the text for the current countdown.
`int`	`currentPlayerNum()` The current player's number.
`int`	`currentPlayerTeam()` The current player's team.
`int`	`currentUnitArmor(int type)` The current unit's armor.
`float`	`currentUnitArmorFloat(int type)` The current unit's armor.
`string`	`currentUnitArmorList()` Shows the current armor values.
`int`	`currentUnitAttack(int type)` The current unit's attack.
`float`	`currentUnitAttackFloat(int type)` The current unit's attack.
`string`	`currentUnitAttackList()` The current unit's attack values.
`int`	`currentUnitAttackRange()` The current unit's range.
`float`	`currentUnitAttackRangeFloat()` The current unit's range.
`string`	`currentUnitAttackstring()` The current unit's attack possibilities, including bonuses.
`string`	`currentUnitAttackText(int type)` The current unit's attack values.
`float`	`currentUnitBounty(string type)`
`float`	`currentUnitBountyFactor(string type)`
`int`	`currentUnitBuildingWorkRate()`
`float`	`currentUnitBuildingWorkRateFloat()`
`int`	`currentUnitBuildPoints()`
`float`	`currentUnitBuildPointsFloat()`
`int`	`currentUnitBuildRate()`
`float`	`currentUnitBuildRateFloat()`
`int`	`currentUnitCapacity()` The current unit's capacity details, i.e.
`int`	`currentUnitCurrentAnimLength()` The current unit's animation length.
`int`	`currentUnitGatherRate(string resource)` The current unit's gather rate for the given resource: Fish, Huntable, WildCrops, Herdable, Farm, Wood, Gaia Forest tree, Gold.
`float`	`currentUnitGatherRateFloat(string resource)` Same as `currentUnitGatherRate`, but with float values.
`string`	`currentUnitGatherRateString()` A string representation of the current gather rates of the selected unit.
`int`	`currentUnitGroup()`
`int`	`currentUnitHP()` The current unit's (starting) hit points.
`float`	`currentUnitHPFloat()` Same as `currentUnitHP`, but with float values.
`int`	`currentUnitID()` The current unit's (in-game) ID number.
`string`	`currentUnitIFFcolor()` Friend-foe colors?
`int`	`currentUnitInv()`
`float`	`currentUnitInvFloat()`
`string`	`currentUnitInvList()`
`int`	`currentUnitLogicalGroupID()`
`string`	`currentUnitLogicalGroupName()`
`int`	`currentUnitLOS()` The current unit's Line of Sight.
`float`	`currentUnitLOSFloat()` Same as `currentUnitLOS`, but with float values.
`int`	`currentUnitMaximumHP()` The current unit's maximum hit points.
`float`	`currentUnitMaximumHPFloat()` Same as `currentUnitMaximumHP`, but with float values.
`int`	`currentUnitMaxVelocity()` The current unit's speed (in m/s).
`float`	`currentUnitMaxVelocityFloat()` Same as `currentUnitMaxVelocity`, but with float values.
`int`	`currentUnitMinAttackRange()` The current unit's minimum attack range.
`float`	`currentUnitMinAttackRangeFloat()` Same as `currentUnitMinAttackRange`, but with float values.
`string`	`currentUnitName()` The current unit's name.
`int`	`currentUnitOwnerID()` The playerID of the player that owns the current unit.
`string`	`currentUnitPlayerIFF()`
`float`	`currentUnitRecharge()` The current unit's recharge time meter.
`string`	`currentUnitScenarioName()` The current unit's scenario name, as can be chosen in the `trUnitCreate()` function.
`int`	`currentUnitTrainPoints()` The current unit's train points.
`float`	`currentUnitTrainPointsFloat()` Same as `currentUnitTrainPoints`, but with float values.
`string`	`escrowDebugText()` AI escrow debug text
`string`	`FavorHelp()` Text on favor mouse over
`string`	`gamespeed()`
`string`	`gametime()` The current game time, in milliseconds if the configuration option `showMilliseconds` is activated.
`string`	`gameVersion()` Shows the current game version.
`string`	`GPRechargeTimeRemaining(int index)`
`string`	`kbArmyDebugText()`
`string`	`kbResourcesDebugText()` AI resources debug text
`string`	`kbunitDebugText(int unitID)` AI unit debug text
`string`	`kbUnitPickDebugText()` AI unit pick debug text
`int`	`marketBuy(string resourceType)` Current market buy rates
`int`	`marketSell(string resourceType)` Current market sell rates
`int`	`maxResource(string resourceType)` Maximum amount of a resource, used to display total availble favor (100 or 200).
`int`	`numGatherers(string resourceType)` The number of villagers currently working on the given resource type.
`int`	`numIdle(string protoUnit)` The number of units of given type that are idle.
`string`	`planDebugLines()` AI plan debug text
`bool`	`playerActive(int playerNumber)` Use -1 for current player
`string`	`playerAge(int playerNumber)` The current player's age, e.g.
`string`	`playerCivilization(int playerNumber)` The current player's civilization name.
`string`	`playerColor(int playerNumber)` The RGB-colorvalues of the current player.
`string`	`playerCulture(int playerNumber)` The current player's culture name.
`string`	`PlayerIDNameString()`
`string`	`playerName(int playerNumber)` The given player's nickname.
`string`	`PlayerNamestring(int playerNumber)`
`int`	`playerScore(int playerNumber)` The given player's score.
`int`	`playerTeam(int playerNumber)` The given player's team.
`int`	`playerTeamScore(int playerNumber)` The given player's team score.
`int`	`pop()` The current player's population in use.
`int`	`popcap()` The current player's population cap.
`string`	`populationHelp()` The population help text, showing #houses, #TCs etc.
`string`	`productID()` Your personal productID.
`string`	`progressionDebugText()` AI progression debug text
`int`	`resource(string resourceType)` The current amount of resources of the current player.
`string`	`techResearchName(int techID)` The string version of a given technology ID.
`int`	`techResearchPercentage(int techID)` The percentage the given technology ID is researched so far.
`string`	`techResearchPercentageText(int techID)`
`int`	`trainUnitPercentage(int unitID)` The percentage the given unitID is trained so far.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - aiDifficulty
```
public string aiDifficulty()
```
    The current difficulty level, i.e. Easy, Moderate, ...
  - areaDebugText
```
public string areaDebugText()
```
    AI area debug text
  - areaGroupDebugText
```
public string areaGroupDebugText()
```
    AI area group debug text
  - attackRouteDebugText
```
public string attackRouteDebugText()
```
    AI attack route debug text
  - baseDebugText
```
public string baseDebugText()
```
    AI base info text
  - buildingPlacementDebugText
```
public string buildingPlacementDebugText()
```
    AI BP debug text
  - colorizeCost
```
public string colorizeCost()
```
  - configDefined
```
public bool configDefined(int configIndex)
```
    True if the given config is defined.
  - countdown
```
public string countdown()
```
    Holds the text for the current countdown.
  - currentPlayerNum
```
public int currentPlayerNum()
```
    The current player's number.
  - currentPlayerTeam
```
public int currentPlayerTeam()
```
    The current player's team.
  - currentUnitArmor
```
public int currentUnitArmor(int type)
```
    The current unit's armor.
    Parameters:
    type -
    
    crush
    
    ?
    
    hack
    
    pierce
  - currentUnitArmorFloat
```
public float currentUnitArmorFloat(int type)
```
    The current unit's armor.
    Parameters:
    type -
    
    crush
    
    ?
    
    hack
    
    pierce
  - currentUnitArmorList
```
public string currentUnitArmorList()
```
    Shows the current armor values.
    Example
    AbstractVillager: Armor: Hack 25% Armor: Pierce: 35%
  - currentUnitAttack
```
public int currentUnitAttack(int type)
```
    The current unit's attack.
  - currentUnitAttackFloat
```
public float currentUnitAttackFloat(int type)
```
    The current unit's attack.
  - currentUnitAttackList
```
public string currentUnitAttackList()
```
    The current unit's attack values.
    Example
    AbstractVillager: 8 Hack
  - currentUnitAttackRange
```
public int currentUnitAttackRange()
```
    The current unit's range.
  - currentUnitAttackRangeFloat
```
public float currentUnitAttackRangeFloat()
```
    The current unit's range.
  - currentUnitAttackstring
```
public string currentUnitAttackstring()
```
    The current unit's attack possibilities, including bonuses.
  - currentUnitAttackText
```
public string currentUnitAttackText(int type)
```
    The current unit's attack values.
  - currentUnitBounty
```
public float currentUnitBounty(string type)
```
    Returns:
    
    if(type == "favor") favor gathered by Norse if unit killed.
  - currentUnitBountyFactor
```
public float currentUnitBountyFactor(string type)
```
  - currentUnitBuildingWorkRate
```
public int currentUnitBuildingWorkRate()
```
  - currentUnitBuildingWorkRateFloat
```
public float currentUnitBuildingWorkRateFloat()
```
  - currentUnitBuildPoints
```
public int currentUnitBuildPoints()
```
  - currentUnitBuildPointsFloat
```
public float currentUnitBuildPointsFloat()
```
  - currentUnitBuildRate
```
public int currentUnitBuildRate()
```
  - currentUnitBuildRateFloat
```
public float currentUnitBuildRateFloat()
```
  - currentUnitCapacity
```
public int currentUnitCapacity()
```
    The current unit's capacity details, i.e. current/max number of units garrisoned.
  - currentUnitCurrentAnimLength
```
public int currentUnitCurrentAnimLength()
```
    The current unit's animation length.
  - currentUnitGatherRate
```
public int currentUnitGatherRate(string resource)
```
    The current unit's gather rate for the given resource: Fish, Huntable, WildCrops, Herdable, Farm, Wood, Gaia Forest tree, Gold.
  - currentUnitGatherRateFloat
```
public float currentUnitGatherRateFloat(string resource)
```
    Same as currentUnitGatherRate, but with float values.
  - currentUnitGatherRateString
```
public string currentUnitGatherRateString()
```
    A string representation of the current gather rates of the selected unit.
  - currentUnitGroup
```
public int currentUnitGroup()
```
  - currentUnitHP
```
public int currentUnitHP()
```
    The current unit's (starting) hit points.
  - currentUnitHPFloat
```
public float currentUnitHPFloat()
```
    Same as currentUnitHP, but with float values.
  - currentUnitID
```
public int currentUnitID()
```
    The current unit's (in-game) ID number.
  - currentUnitIFFcolor
```
public string currentUnitIFFcolor()
```
    Friend-foe colors?
  - currentUnitInv
```
public int currentUnitInv()
```
  - currentUnitInvFloat
```
public float currentUnitInvFloat()
```
  - currentUnitInvList
```
public string currentUnitInvList()
```
  - currentUnitLogicalGroupID
```
public int currentUnitLogicalGroupID()
```
  - currentUnitLogicalGroupName
```
public string currentUnitLogicalGroupName()
```
  - currentUnitLOS
```
public int currentUnitLOS()
```
    The current unit's Line of Sight.
  - currentUnitLOSFloat
```
public float currentUnitLOSFloat()
```
    Same as currentUnitLOS, but with float values.
  - currentUnitMaximumHP
```
public int currentUnitMaximumHP()
```
    The current unit's maximum hit points.
  - currentUnitMaximumHPFloat
```
public float currentUnitMaximumHPFloat()
```
    Same as currentUnitMaximumHP, but with float values.
  - currentUnitMaxVelocity
```
public int currentUnitMaxVelocity()
```
    The current unit's speed (in m/s).
  - currentUnitMaxVelocityFloat
```
public float currentUnitMaxVelocityFloat()
```
    Same as currentUnitMaxVelocity, but with float values.
  - currentUnitMinAttackRange
```
public int currentUnitMinAttackRange()
```
    The current unit's minimum attack range.
  - currentUnitMinAttackRangeFloat
```
public float currentUnitMinAttackRangeFloat()
```
    Same as currentUnitMinAttackRange, but with float values.
  - currentUnitName
```
public string currentUnitName()
```
    The current unit's name. This can be set with trUnitChangeName(string name).
  - currentUnitOwnerID
```
public int currentUnitOwnerID()
```
    The playerID of the player that owns the current unit.
  - currentUnitPlayerIFF
```
public string currentUnitPlayerIFF()
```
  - currentUnitRecharge
```
public float currentUnitRecharge()
```
    The current unit's recharge time meter.
  - currentUnitScenarioName
```
public string currentUnitScenarioName()
```
    The current unit's scenario name, as can be chosen in the trUnitCreate() function.
  - currentUnitTrainPoints
```
public int currentUnitTrainPoints()
```
    The current unit's train points.
  - currentUnitTrainPointsFloat
```
public float currentUnitTrainPointsFloat()
```
    Same as currentUnitTrainPoints, but with float values.
  - escrowDebugText
```
public string escrowDebugText()
```
    AI escrow debug text
  - FavorHelp
```
public string FavorHelp()
```
    Text on favor mouse over
  - gamespeed
```
public string gamespeed()
```
  - gametime
```
public string gametime()
```
    The current game time, in milliseconds if the configuration option showMilliseconds is activated.
  - gameVersion
```
public string gameVersion()
```
    Shows the current game version.
  - GPRechargeTimeRemaining
```
public string GPRechargeTimeRemaining(int index)
```
    Parameters:
    
    index - range: 0 - 3
  - kbArmyDebugText
```
public string kbArmyDebugText()
```
  - kbResourcesDebugText
```
public string kbResourcesDebugText()
```
    AI resources debug text
  - kbunitDebugText
```
public string kbunitDebugText(int unitID)
```
    AI unit debug text
  - kbUnitPickDebugText
```
public string kbUnitPickDebugText()
```
    AI unit pick debug text
  - marketBuy
```
public int marketBuy(string resourceType)
```
    Current market buy rates
    Parameters:
    resourceType -
    
    food
    
    wood
  - marketSell
```
public int marketSell(string resourceType)
```
    Current market sell rates
    Parameters:
    resourceType -
    
    food
    
    wood
  - maxResource
```
public int maxResource(string resourceType)
```
    Maximum amount of a resource, used to display total availble favor (100 or 200).
    
    Parameters:
    
    resourceType - the type of resource, i.e. favor.
  - numGatherers
```
public int numGatherers(string resourceType)
```
    The number of villagers currently working on the given resource type.
  - numIdle
```
public int numIdle(string protoUnit)
```
    The number of units of given type that are idle.
  - planDebugLines
```
public string planDebugLines()
```
    AI plan debug text
  - playerActive
```
public bool playerActive(int playerNumber)
```
    Use -1 for current player
  - playerAge
```
public string playerAge(int playerNumber)
```
    The current player's age, e.g. "Classic Age".
  - playerCivilization
```
public string playerCivilization(int playerNumber)
```
    The current player's civilization name. This can be set with trSetCivilizationNameOverride(long playerID, string civName).
  - playerColor
```
public string playerColor(int playerNumber)
```
    The RGB-colorvalues of the current player.
  - playerCulture
```
public string playerCulture(int playerNumber)
```
    The current player's culture name.
  - PlayerIDNameString
```
public string PlayerIDNameString()
```
  - playerName
```
public string playerName(int playerNumber)
```
    The given player's nickname.
  - PlayerNamestring
```
public string PlayerNamestring(int playerNumber)
```
  - playerScore
```
public int playerScore(int playerNumber)
```
    The given player's score.
  - playerTeam
```
public int playerTeam(int playerNumber)
```
    The given player's team.
  - playerTeamScore
```
public int playerTeamScore(int playerNumber)
```
    The given player's team score.
  - pop
```
public int pop()
```
    The current player's population in use.
  - popcap
```
public int popcap()
```
    The current player's population cap.
  - populationHelp
```
public string populationHelp()
```
    The population help text, showing #houses, #TCs etc.
  - productID
```
public string productID()
```
    Your personal productID.
  - progressionDebugText
```
public string progressionDebugText()
```
    AI progression debug text
  - resource
```
public int resource(string resourceType)
```
    The current amount of resources of the current player.
    Parameters:
    resourceType -
    
    food
    
    wood
    
    gold
    
    favor
  - techResearchName
```
public string techResearchName(int techID)
```
    The string version of a given technology ID.
  - techResearchPercentage
```
public int techResearchPercentage(int techID)
```
    The percentage the given technology ID is researched so far.
  - techResearchPercentageText
```
public string techResearchPercentageText(int techID)
```
  - trainUnitPercentage
```
public int trainUnitPercentage(int unitID)
```
    The percentage the given unitID is trained so far.

Class Templates

Method Summary

Methods inherited from class Object

Method Detail

aiDifficulty

areaDebugText

areaGroupDebugText

attackRouteDebugText

baseDebugText

buildingPlacementDebugText

colorizeCost

configDefined

countdown

currentPlayerNum

currentPlayerTeam

currentUnitArmor

currentUnitArmorFloat

currentUnitArmorList

currentUnitAttack

currentUnitAttackFloat

currentUnitAttackList

currentUnitAttackRange

currentUnitAttackRangeFloat

currentUnitAttackstring

currentUnitAttackText

currentUnitBounty

currentUnitBountyFactor

currentUnitBuildingWorkRate

currentUnitBuildingWorkRateFloat

currentUnitBuildPoints

currentUnitBuildPointsFloat

currentUnitBuildRate

currentUnitBuildRateFloat

currentUnitCapacity

currentUnitCurrentAnimLength

currentUnitGatherRate

currentUnitGatherRateFloat

currentUnitGatherRateString

currentUnitGroup

currentUnitHP

currentUnitHPFloat

currentUnitID

currentUnitIFFcolor

currentUnitInv

currentUnitInvFloat

currentUnitInvList

currentUnitLogicalGroupID

currentUnitLogicalGroupName

currentUnitLOS

currentUnitLOSFloat

currentUnitMaximumHP

currentUnitMaximumHPFloat

currentUnitMaxVelocity

currentUnitMaxVelocityFloat

currentUnitMinAttackRange

currentUnitMinAttackRangeFloat

currentUnitName

currentUnitOwnerID

currentUnitPlayerIFF

currentUnitRecharge

currentUnitScenarioName

currentUnitTrainPoints

currentUnitTrainPointsFloat

escrowDebugText

FavorHelp

gamespeed

gametime

gameVersion

GPRechargeTimeRemaining

kbArmyDebugText

kbResourcesDebugText

kbunitDebugText

kbUnitPickDebugText

marketBuy

marketSell

maxResource

numGatherers

numIdle

planDebugLines

playerActive