Skip to content

kbGetPopCapAddition

1. Description

Signature of kbGetPopCapAddition

1
int kbGetPopCapAddition(int playerID, int protoUnitID);

This function returns how much population space the given proto unit provides when it's on the map. If the proto unit doesn't provide any population space, the function returns 0.

2. Example

Example using kbGetPopCapAddition

Age3AI.xs
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
rule BuildHousesSpanish
active
minInterval 5
{
    // Try to always have at least 10 population slots available.

    // Get the current population capacity.
    int currentPopCap = kbGetPopCap();

    // Get the current population count.
    int currentPopCount = kbGetPop();

    // Get the population space provided by a house.
    int popCapAddition = kbGetPopCapAddition(cMyID, cUnitTypeHouseMed);

    // Calculate how many houses we need to build to have 10 population
    // slots available.
    int housesToBuild = (currentPopCount + popCapAddition - currentPopCap) / popCapAddition;

    // Don't continue if we don't need to build any houses.
    if (housesToBuild <= 0)
    {
        return;
    }

    // Here the rest of the rule for building houses (irrelevant for this example)
}