Area

Object
- Area

```
public class Area
extends Object
```
This class provides a collection of KB commands concerning Areas and Locations on the map in general.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cAreaGroupTypeLand`
`int`	`cAreaGroupTypeWater`
`int`	`cAreaTypeForest`
`int`	`cAreaTypeGold`
`int`	`cAreaTypeImpassableLand`
`int`	`cAreaTypeSettlement`
`int`	`cAreaTypeWater`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`kbAreaCalculate()` Creates areas and area groups.
`int`	`kbAreaFindBestGatherAreaID(int unitTypeID)` Returns the Area ID of the best area to gather the given unit type.
`int`	`kbAreaGetBorderAreaID(int areaID, long index)` Returns the Area ID of the index'th border area in the given area.
`vector`	`kbAreaGetCenter(int areaID)` Returns the center of the given area.
`int`	`kbAreaGetClosetArea(vector position, int areaType, int areaType1, float minDistance)` Returns the Area ID of the closest area, of the given types, to given position.
`int`	`kbAreaGetIDByPosition(vector position)` Returns the ID of the given area.
`int`	`kbAreaGetNumber()` Returns the number of areas.
`int`	`kbAreaGetNumberBlackTiles(int areaID)` Returns the number of black tiles in the given area.
`int`	`kbAreaGetNumberBorderAreas(int areaID)` Returns the number of border areas for the given area.
`int`	`kbAreaGetNumberFogTiles(int areaID)` Returns the number of fog tiles in the given area.
`int`	`kbAreaGetNumberTiles(int areaID)` Returns the number of tiles in the given area.
`int`	`kbAreaGetNumberUnits(int areaID)` Returns the number of units in the given area.
`int`	`kbAreaGetNumberVisibleTiles(int areaID)` Returns the number of visible tiles in the given area.
`int`	`kbAreaGetType(int areaID)` Returns the Type of area.
`int`	`kbAreaGetUnitID(int areaID, long index)` Returns the Unit ID of the index'th unit in the given area.
`int`	`kbAreaGetVisibilityChangeTime(int areaID)` Returns the game time of the last visibility change for the given area.
`int`	`kbAreaGroupGetIDByPosition(vector position)` Returns the ID of the given area group.
`int`	`kbFindAreaGroup(int groupType, float surfaceAreaRatio, int compareAreaID)` Returns the visible area group that matches the given criteria.
`int`	`kbFindAreaGroupByLocation(int groupType, float relativeX, float relativeZ)` Returns the visible area group that matches the given criteria.
`vector`	`kbGetMapCenter()` Returns the center vector of the map.
`float`	`kbGetMapXSize()` Returns the X size of the map.
`float`	`kbGetMapZSize()` Returns the Z size of the map.
`int`	`kbGetTownAreaID()` Returns the area ID of the main town.
`vector`	`kbGetTownLocation()` Returns the location of the main town.
`bool`	`kbLocationVisible(vector location)` Returns true if the location is currently visible to the player.
`bool`	`kbSetTownLocation(vector location)` Sets the location of the main town.

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

- Field Detail
  - cAreaTypeForest
```
public final int cAreaTypeForest
```
    See Also:
    
    Constant Field Values
  - cAreaTypeWater
```
public final int cAreaTypeWater
```
    See Also:
    
    Constant Field Values
  - cAreaTypeImpassableLand
```
public final int cAreaTypeImpassableLand
```
    See Also:
    
    Constant Field Values
  - cAreaTypeGold
```
public final int cAreaTypeGold
```
    See Also:
    
    Constant Field Values
  - cAreaTypeSettlement
```
public final int cAreaTypeSettlement
```
    See Also:
    
    Constant Field Values
  - cAreaGroupTypeLand
```
public final int cAreaGroupTypeLand
```
    See Also:
    
    Constant Field Values
  - cAreaGroupTypeWater
```
public final int cAreaGroupTypeWater
```
    See Also:
    
    Constant Field Values
- Method Detail
  - kbGetMapCenter
```
public vector kbGetMapCenter()
```
    Returns the center vector of the map.
  - kbGetMapXSize
```
public float kbGetMapXSize()
```
    Returns the X size of the map.
  - kbGetMapZSize
```
public float kbGetMapZSize()
```
    Returns the Z size of the map.
  - kbGetTownLocation
```
public vector kbGetTownLocation()
```
    Returns the location of the main town.
  - kbGetTownAreaID
```
public int kbGetTownAreaID()
```
    Returns the area ID of the main town.
  - kbSetTownLocation
```
public bool kbSetTownLocation(vector location)
```
    Sets the location of the main town.
  - kbLocationVisible
```
public bool kbLocationVisible(vector location)
```
    Returns true if the location is currently visible to the player.
  - kbFindAreaGroup
```
public int kbFindAreaGroup(int groupType,
                           float surfaceAreaRatio,
                           int compareAreaID)
```
    Returns the visible area group that matches the given criteria.
  - kbFindAreaGroupByLocation
```
public int kbFindAreaGroupByLocation(int groupType,
                                     float relativeX,
                                     float relativeZ)
```
    Returns the visible area group that matches the given criteria.
  - kbAreaCalculate
```
public void kbAreaCalculate()
```
    Creates areas and area groups. Call this functions before any other call that needs areas.
  - kbAreaGetNumber
```
public int kbAreaGetNumber()
```
    Returns the number of areas.
  - kbAreaGetIDByPosition
```
public int kbAreaGetIDByPosition(vector position)
```
    Returns the ID of the given area.
  - kbAreaGroupGetIDByPosition
```
public int kbAreaGroupGetIDByPosition(vector position)
```
    Returns the ID of the given area group.
  - kbAreaGetCenter
```
public vector kbAreaGetCenter(int areaID)
```
    Returns the center of the given area.
  - kbAreaGetNumberTiles
```
public int kbAreaGetNumberTiles(int areaID)
```
    Returns the number of tiles in the given area.
  - kbAreaGetNumberBlackTiles
```
public int kbAreaGetNumberBlackTiles(int areaID)
```
    Returns the number of black tiles in the given area.
  - kbAreaGetNumberVisibleTiles
```
public int kbAreaGetNumberVisibleTiles(int areaID)
```
    Returns the number of visible tiles in the given area.
  - kbAreaGetNumberFogTiles
```
public int kbAreaGetNumberFogTiles(int areaID)
```
    Returns the number of fog tiles in the given area.
  - kbAreaGetVisibilityChangeTime
```
public int kbAreaGetVisibilityChangeTime(int areaID)
```
    Returns the game time of the last visibility change for the given area.
  - kbAreaGetNumberUnits
```
public int kbAreaGetNumberUnits(int areaID)
```
    Returns the number of units in the given area.
  - kbAreaGetUnitID
```
public int kbAreaGetUnitID(int areaID,
                           long index)
```
    Returns the Unit ID of the index'th unit in the given area.
  - kbAreaGetNumberBorderAreas
```
public int kbAreaGetNumberBorderAreas(int areaID)
```
    Returns the number of border areas for the given area.
  - kbAreaGetBorderAreaID
```
public int kbAreaGetBorderAreaID(int areaID,
                                 long index)
```
    Returns the Area ID of the index'th border area in the given area.
  - kbAreaGetType
```
public int kbAreaGetType(int areaID)
```
    Returns the Type of area.
  - kbAreaFindBestGatherAreaID
```
public int kbAreaFindBestGatherAreaID(int unitTypeID)
```
    Returns the Area ID of the best area to gather the given unit type.
  - kbAreaGetClosetArea
```
public int kbAreaGetClosetArea(vector position,
                               int areaType,
                               int areaType1,
                               float minDistance)
```
    Returns the Area ID of the closest area, of the given types, to given position.
    
    Note
    
    Yes, that's an official typo right there.

Class Area

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cAreaTypeForest

cAreaTypeWater

cAreaTypeImpassableLand

cAreaTypeGold

cAreaTypeSettlement

cAreaGroupTypeLand

cAreaGroupTypeWater

Method Detail

kbGetMapCenter

kbGetMapXSize

kbGetMapZSize

kbGetTownLocation

kbGetTownAreaID

kbSetTownLocation

kbLocationVisible

kbFindAreaGroup

kbFindAreaGroupByLocation

kbAreaCalculate

kbAreaGetNumber

kbAreaGetIDByPosition

kbAreaGroupGetIDByPosition

kbAreaGetCenter

kbAreaGetNumberTiles

kbAreaGetNumberBlackTiles

kbAreaGetNumberVisibleTiles

kbAreaGetNumberFogTiles

kbAreaGetVisibilityChangeTime

kbAreaGetNumberUnits

kbAreaGetUnitID

kbAreaGetNumberBorderAreas

kbAreaGetBorderAreaID

kbAreaGetType

kbAreaFindBestGatherAreaID

kbAreaGetClosetArea