TechTree

Object
- TechTree

```
public class TechTree
extends Object
```
This class provides a collection of KB commands concerning Technologies.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

See Also:

AoM Reference or AoT Reference for a complete list of all technology constants and more.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cTechStatusActive`
`int`	`cTechStatusAvailable`
`int`	`cTechStatusObtainable`
`int`	`cTechStatusPersistent`
`int`	`cTechStatusResearching`
`int`	`cTechStatusUnobtainable`
`int`	`cUpgradeTypeAny`
`int`	`cUpgradeTypeArmor`
`int`	`cUpgradeTypeAttack`
`int`	`cUpgradeTypeHitpoints`
`int`	`cUpgradeTypeSpeed`
`int`	`cUpgradeTypeTrainPoints`
`int`	`cUpgradeTypeWorkRate`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`bool`	`kbCanAffordTech(int techID, int escrowID)` Returns true if the player can afford the technology.
`string`	`kbGetCivName(int civID)` Returns the civilization name for the given civilization.
`string`	`kbGetCulture(int cultureID)` Returns the culture name for the given culture.
`float`	`kbGetTechAICost(int techID)` Returns the AI cost for the given technology ID.
`string`	`kbGetTechName(int techID)` Returns the name of the technology ID.
`float`	`kbGetTechPercentComplete(int techID)` Returns the percent complete for the the requested tech of the current player.
`int`	`kbGetTechStatus(int techID)` Returns the current technology status for the current player of the requested tech.
`float`	`kbTechCostPerResource(int techID, int resourceID)` Returns the cost of the technology for the given resource.
`bool`	`kbTechTreeAddDropsiteUnitIDByResource(int resourceID)` Adds the base unit type ID as a dropsite for the given resource.
`bool`	`kbTechTreeAddMinorGodPref(int techID)` Have progressions preference for this minor god selection.
`bool`	`kbTechTreeClearDropsiteUnitIDsByResource(int resourceID)` Clears the list of dropsites for the given resource type.
`int`	`kbTechTreeGetCheapestUnitUpgrade(int protoUnitID, int upgradeQueryType, int resourceFilterID, int buildingFilterID, bool echoResults, int affectedUnitType)` Returns the ID of the cheapest unit upgrade technology.
`int`	`kbTechTreeGetDropsiteUnitIDByResource(int resourceID, int index)` Returns the index'th unitID of the dropsite that takes the given resource.
`int`	`kbTechTreeGetGPTechID(int minorGodTechID)` Returns the GP techID that is enabled by minorGodTechID.
`int`	`kbTechTreeGetMatrixUnitTypeIDByIndex(int index)` Returns the matrix unit typeID at the given index.
`int`	`kbTechTreeGetMinorGodChoices(int index, int age)` Returns the minorGodTechID of the given index, given the age, -1 means the next age.
`int`	`kbTechTreeGetMinorGodMythUnitByIndex(int minorGodTechID, int index)` Returns the protoID of a myth unit
`int`	`kbTechTreeGetMinorGodMythUnitTotal(int minorGodTechID)` Returns the total number of myth units enabled by this minor god.
`int`	`kbTechTreeGetNumberDropsiteUnitIDsByResource(int resourceID)` Returns the number of unit typeIDs for dropsites that take the given resource.
`int`	`kbTechTreeGetNumberMatrixUnitTypeIDs()` Returns the number of matrix unit type IDs.
`int`	`kbTechTreeGetNumberObtainProtos(int techID)` Returns the number of protos that the given techID can be obtained from.
`int`	`kbTechTreeGetNumberTrainProtos(int unitTypeID)` Returns the number of protos that can train the given unitTypeID.
`int`	`kbTechTreeGetRandomUnitUpgrade()` Returns the ID of a randomly chosen unit upgrade technology.
`int`	`kbTechTreeGetTotalUnitIDsByFunction(int functionID)` Returns the total number of unitIDs that performs the given function.
`int`	`kbTechTreeGetTotalUnitIDsByMatrix(long mainUnitTypeID, int counterUnitTypeID)` Returns the total number of unitIDs matching the main type that has the given counter type.
`int`	`kbTechTreeGetUnitIDByMatrixIndex(long mainUnitTypeID, int counterUnitTypeID, int index)` Returns the index'th unitID matching the main type that has the given counter type.
`int`	`kbTechTreeGetUnitIDByObtainIndex(int techID, int obtainProtoIndex)` Returns index'th unitTypeID of the unit that the given techID, can be obtained from.
`int`	`kbTechTreeGetUnitIDByTrain(int unitTypeID, int civID)` Returns the unitTypeID of the unit that can train the given unitTypeID.
`int`	`kbTechTreeGetUnitIDByTrainIndex(int unitTypeID, int trainProtoIndex)` Returns index'th unitTypeID of the unit that can train the given unitTypeID.
`int`	`kbTechTreeGetUnitIDTypeByFunctionIndex(int functionID, int index)` Returns the index'th unitID of the unit that performs the given function.
`int`	`kbTechTreeGetUnitUpgradeTech(int unitTypeID, int index)` Returns the index'th upgrade technologies of the unit type.
`int`	`kbTechTreeGetUnitUpgradeTechTotal(int unitTypeID)` Returns the total number of upgrade technologies of the unit type.
`bool`	`kbTechTreeIsMinorGod(int techID)` Returns true if techID is a minor god technology.
`bool`	`kbTechTreeRemoveMinorGodPref(int techID)` Removes this minor god as preference in Progressions.

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

- Field Detail
  - cTechStatusUnobtainable
```
public final int cTechStatusUnobtainable
```
    See Also:
    
    Constant Field Values
  - cTechStatusObtainable
```
public final int cTechStatusObtainable
```
    See Also:
    
    Constant Field Values
  - cTechStatusAvailable
```
public final int cTechStatusAvailable
```
    See Also:
    
    Constant Field Values
  - cTechStatusResearching
```
public final int cTechStatusResearching
```
    See Also:
    
    Constant Field Values
  - cTechStatusActive
```
public final int cTechStatusActive
```
    See Also:
    
    Constant Field Values
  - cTechStatusPersistent
```
public final int cTechStatusPersistent
```
    See Also:
    
    Constant Field Values
  - cUpgradeTypeAttack
```
public final int cUpgradeTypeAttack
```
    See Also:
    
    Constant Field Values
  - cUpgradeTypeArmor
```
public final int cUpgradeTypeArmor
```
    See Also:
    
    Constant Field Values
  - cUpgradeTypeHitpoints
```
public final int cUpgradeTypeHitpoints
```
    See Also:
    
    Constant Field Values
  - cUpgradeTypeSpeed
```
public final int cUpgradeTypeSpeed
```
    See Also:
    
    Constant Field Values
  - cUpgradeTypeWorkRate
```
public final int cUpgradeTypeWorkRate
```
    See Also:
    
    Constant Field Values
  - cUpgradeTypeTrainPoints
```
public final int cUpgradeTypeTrainPoints
```
    See Also:
    
    Constant Field Values
  - cUpgradeTypeAny
```
public final int cUpgradeTypeAny
```
    See Also:
    
    Constant Field Values
- Method Detail
  - kbGetCulture
```
public string kbGetCulture(int cultureID)
```
    Returns the culture name for the given culture.
    
    Note
    
    Is this supposed to be called kbGetCultureName(int cultureID)? AFAIK XS does not support overloading.
    
    See Also:
    
    kbGetCulture()
  - kbGetCivName
```
public string kbGetCivName(int civID)
```
    Returns the civilization name for the given civilization.
  - kbGetTechAICost
```
public float kbGetTechAICost(int techID)
```
    Returns the AI cost for the given technology ID.
  - kbGetTechStatus
```
public int kbGetTechStatus(int techID)
```
    Returns the current technology status for the current player of the requested tech.
  - kbGetTechPercentComplete
```
public float kbGetTechPercentComplete(int techID)
```
    Returns the percent complete for the the requested tech of the current player.
  - kbTechCostPerResource
```
public float kbTechCostPerResource(int techID,
                                   int resourceID)
```
    Returns the cost of the technology for the given resource.
  - kbCanAffordTech
```
public bool kbCanAffordTech(int techID,
                            int escrowID)
```
    Returns true if the player can afford the technology.
  - kbGetTechName
```
public string kbGetTechName(int techID)
```
    Returns the name of the technology ID.
  - kbTechTreeGetUnitUpgradeTechTotal
```
public int kbTechTreeGetUnitUpgradeTechTotal(int unitTypeID)
```
    Returns the total number of upgrade technologies of the unit type.
  - kbTechTreeGetUnitUpgradeTech
```
public int kbTechTreeGetUnitUpgradeTech(int unitTypeID,
                                        int index)
```
    Returns the index'th upgrade technologies of the unit type.
  - kbTechTreeGetCheapestUnitUpgrade
```
public int kbTechTreeGetCheapestUnitUpgrade(int protoUnitID,
                                            int upgradeQueryType,
                                            int resourceFilterID,
                                            int buildingFilterID,
                                            bool echoResults,
                                            int affectedUnitType)
```
    Returns the ID of the cheapest unit upgrade technology.
  - kbTechTreeGetRandomUnitUpgrade
```
public int kbTechTreeGetRandomUnitUpgrade()
```
    Returns the ID of a randomly chosen unit upgrade technology.
  - kbTechTreeIsMinorGod
```
public bool kbTechTreeIsMinorGod(int techID)
```
    Returns true if techID is a minor god technology.
  - kbTechTreeGetGPTechID
```
public int kbTechTreeGetGPTechID(int minorGodTechID)
```
    Returns the GP techID that is enabled by minorGodTechID.
  - kbTechTreeAddMinorGodPref
```
public bool kbTechTreeAddMinorGodPref(int techID)
```
    Have progressions preference for this minor god selection.
  - kbTechTreeRemoveMinorGodPref
```
public bool kbTechTreeRemoveMinorGodPref(int techID)
```
    Removes this minor god as preference in Progressions.
  - kbTechTreeGetMinorGodMythUnitTotal
```
public int kbTechTreeGetMinorGodMythUnitTotal(int minorGodTechID)
```
    Returns the total number of myth units enabled by this minor god.
  - kbTechTreeGetMinorGodMythUnitByIndex
```
public int kbTechTreeGetMinorGodMythUnitByIndex(int minorGodTechID,
                                                int index)
```
    Returns the protoID of a myth unit
  - kbTechTreeGetMinorGodChoices
```
public int kbTechTreeGetMinorGodChoices(int index,
                                        int age)
```
    Returns the minorGodTechID of the given index, given the age, -1 means the next age.
  - kbTechTreeGetNumberMatrixUnitTypeIDs
```
public int kbTechTreeGetNumberMatrixUnitTypeIDs()
```
    Returns the number of matrix unit type IDs.
  - kbTechTreeGetMatrixUnitTypeIDByIndex
```
public int kbTechTreeGetMatrixUnitTypeIDByIndex(int index)
```
    Returns the matrix unit typeID at the given index.
  - kbTechTreeGetTotalUnitIDsByMatrix
```
public int kbTechTreeGetTotalUnitIDsByMatrix(long mainUnitTypeID,
                                             int counterUnitTypeID)
```
    Returns the total number of unitIDs matching the main type that has the given counter type.
  - kbTechTreeGetUnitIDByMatrixIndex
```
public int kbTechTreeGetUnitIDByMatrixIndex(long mainUnitTypeID,
                                            int counterUnitTypeID,
                                            int index)
```
    Returns the index'th unitID matching the main type that has the given counter type.
  - kbTechTreeGetTotalUnitIDsByFunction
```
public int kbTechTreeGetTotalUnitIDsByFunction(int functionID)
```
    Returns the total number of unitIDs that performs the given function.
  - kbTechTreeGetUnitIDTypeByFunctionIndex
```
public int kbTechTreeGetUnitIDTypeByFunctionIndex(int functionID,
                                                  int index)
```
    Returns the index'th unitID of the unit that performs the given function.
  - kbTechTreeGetNumberDropsiteUnitIDsByResource
```
public int kbTechTreeGetNumberDropsiteUnitIDsByResource(int resourceID)
```
    Returns the number of unit typeIDs for dropsites that take the given resource.
  - kbTechTreeClearDropsiteUnitIDsByResource
```
public bool kbTechTreeClearDropsiteUnitIDsByResource(int resourceID)
```
    Clears the list of dropsites for the given resource type.
  - kbTechTreeAddDropsiteUnitIDByResource
```
public bool kbTechTreeAddDropsiteUnitIDByResource(int resourceID)
```
    Adds the base unit type ID as a dropsite for the given resource.
  - kbTechTreeGetDropsiteUnitIDByResource
```
public int kbTechTreeGetDropsiteUnitIDByResource(int resourceID,
                                                 int index)
```
    Returns the index'th unitID of the dropsite that takes the given resource.
  - kbTechTreeGetUnitIDByTrain
```
public int kbTechTreeGetUnitIDByTrain(int unitTypeID,
                                      int civID)
```
    Returns the unitTypeID of the unit that can train the given unitTypeID.
  - kbTechTreeGetNumberTrainProtos
```
public int kbTechTreeGetNumberTrainProtos(int unitTypeID)
```
    Returns the number of protos that can train the given unitTypeID.
  - kbTechTreeGetUnitIDByTrainIndex
```
public int kbTechTreeGetUnitIDByTrainIndex(int unitTypeID,
                                           int trainProtoIndex)
```
    Returns index'th unitTypeID of the unit that can train the given unitTypeID.
  - kbTechTreeGetNumberObtainProtos
```
public int kbTechTreeGetNumberObtainProtos(int techID)
```
    Returns the number of protos that the given techID can be obtained from.
  - kbTechTreeGetUnitIDByObtainIndex
```
public int kbTechTreeGetUnitIDByObtainIndex(int techID,
                                            int obtainProtoIndex)
```
    Returns index'th unitTypeID of the unit that the given techID, can be obtained from.

Class TechTree

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cTechStatusUnobtainable

cTechStatusObtainable

cTechStatusAvailable

cTechStatusResearching

cTechStatusActive

cTechStatusPersistent

cUpgradeTypeAttack

cUpgradeTypeArmor

cUpgradeTypeHitpoints

cUpgradeTypeSpeed

cUpgradeTypeWorkRate

cUpgradeTypeTrainPoints

cUpgradeTypeAny

Method Detail

kbGetCulture

kbGetCivName

kbGetTechAICost

kbGetTechStatus

kbGetTechPercentComplete

kbTechCostPerResource

kbCanAffordTech

kbGetTechName

kbTechTreeGetUnitUpgradeTechTotal

kbTechTreeGetUnitUpgradeTech

kbTechTreeGetCheapestUnitUpgrade

kbTechTreeGetRandomUnitUpgrade

kbTechTreeIsMinorGod

kbTechTreeGetGPTechID

kbTechTreeAddMinorGodPref

kbTechTreeRemoveMinorGodPref

kbTechTreeGetMinorGodMythUnitTotal

kbTechTreeGetMinorGodMythUnitByIndex

kbTechTreeGetMinorGodChoices

kbTechTreeGetNumberMatrixUnitTypeIDs

kbTechTreeGetMatrixUnitTypeIDByIndex

kbTechTreeGetTotalUnitIDsByMatrix

kbTechTreeGetUnitIDByMatrixIndex

kbTechTreeGetTotalUnitIDsByFunction

kbTechTreeGetUnitIDTypeByFunctionIndex

kbTechTreeGetNumberDropsiteUnitIDsByResource

kbTechTreeClearDropsiteUnitIDsByResource

kbTechTreeAddDropsiteUnitIDByResource

kbTechTreeGetDropsiteUnitIDByResource

kbTechTreeGetUnitIDByTrain

kbTechTreeGetNumberTrainProtos

kbTechTreeGetUnitIDByTrainIndex

kbTechTreeGetNumberObtainProtos

kbTechTreeGetUnitIDByObtainIndex