ThreatGrid Maintains spatial threat information for enemy units. Uses a grid-based system to efficiently query danger levels at any position, allowing units to avoid unsafe areas. More...

#include <ThreatGrid.h>

Classes
struct	EnemyStamp
struct	GridData

Public Member Functions
void	onStart ()
	Initializes threat grids based on map dimensions.
void	onFrameStart (int frame)
	Updates the current frame reference for the grid.
void	addOrUpdateEnemy (int id, BWAPI::UnitType type, BWAPI::Position pos, bool completed, bool burrowed, bool immobile)
	Adds or updates an enemy unit's contribution to the threat grid.
void	removeEnemy (int id)
	Removes an enemy unit from the threat grid.
int	groundThreatAt (BWAPI::Position p) const
	Returns the ground threat value at a given position.
int	detectionAt (BWAPI::Position p) const
	Returns the detection threat value at a given position.
int	airThreatAt (BWAPI::Position p) const
	Returns the air threat value at a given position.
int	getAirThreat (BWAPI::Position p) const
int	getDetection (BWAPI::Position p) const
	Wrapper for retrieving detection threat at a position.
int	airThreatValue (BWAPI::UnitType t) const
int	airThreatRangePx (BWAPI::UnitType t) const

Private Member Functions
void	paintDisc (GridData &g, BWAPI::Position center, int rangePx, int delta)
void	stampEnemy (const EnemyStamp &s, int delta)
int	detectorRadiusPx (BWAPI::UnitType t) const
int	groundThreatValue (BWAPI::UnitType t) const
int	groundThreatRangePx (BWAPI::UnitType t) const

Static Private Member Functions
static int	toWalkX (BWAPI::Position p)
static int	toWalkY (BWAPI::Position p)

Private Attributes
int	currentFrame_ = 0
int	rangeBufferPx_ = 16
GridData	groundThreat_
GridData	airThreat_
GridData	detection_
std::unordered_map< int, EnemyStamp >	stamps_

Detailed Description

ThreatGrid Maintains spatial threat information for enemy units. Uses a grid-based system to efficiently query danger levels at any position, allowing units to avoid unsafe areas.

Tracks and updates:

Ground threat values (damage potential vs ground units)
Air threat values (damage potential vs air units)
Detection coverage (invisible unit detection zones)

Definition at line 18 of file ThreatGrid.h.

Member Function Documentation

◆ addOrUpdateEnemy()

void ThreatGrid::addOrUpdateEnemy	(	int	id,
		BWAPI::UnitType	type,
		BWAPI::Position	pos,
		bool	completed,
		bool	burrowed,
		bool	immobile )

Adds or updates an enemy unit's contribution to the threat grid.

If the unit state has changed, its previous contribution is removed and recalculated.

Parameters

id	Unique unit ID
type	Unit type
pos	Unit position
completed	Whether the unit is complete
burrowed	Whether the unit is burrowed
immobile	Whether the unit is immobile

Definition at line 94 of file ThreatGrid.cpp.

{
    EnemyStamp next;
    next.type = type;
    next.pos = pos;
    next.completed = completed;
    next.burrowed = burrowed;
    next.immobile = immobile;
 
    auto it = stamps_.find(id);
    if (it == stamps_.end())
    {
        stamps_.emplace(id, next);
        stampEnemy(next, +1);
        return;
    }
 
    EnemyStamp& prev = it->second;
 
    const bool changed =
        prev.type != next.type ||
        prev.pos != next.pos ||
        prev.completed != next.completed ||
        prev.burrowed != next.burrowed ||
        prev.immobile != next.immobile;
 
    if (!changed)
    {
        return;
    }
 
    stampEnemy(prev, -1);
    prev = next;
    stampEnemy(prev, +1);
}

◆ airThreatAt()

int ThreatGrid::airThreatAt ( BWAPI::Position p ) const

Returns the air threat value at a given position.

Parameters

p	World position

Returns: Accumulated air threat value

Definition at line 62 of file ThreatGrid.cpp.

{
    return airThreat_.get(toWalkX(p), toWalkY(p));
}

◆ airThreatRangePx()

int ThreatGrid::airThreatRangePx ( BWAPI::UnitType t ) const

Definition at line 242 of file ThreatGrid.cpp.

{
    BWAPI::UnitType weaponType = t;
 
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        weaponType = BWAPI::UnitTypes::Terran_Marine;
    }
 
    BWAPI::WeaponType w = weaponType.airWeapon();
    if (w == BWAPI::WeaponTypes::None)
    {
        return 0;
    }
 
    int range = w.maxRange();
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        range += 48;
    }
 
    return range + rangeBufferPx_;
}

◆ airThreatValue()

int ThreatGrid::airThreatValue ( BWAPI::UnitType t ) const

Definition at line 266 of file ThreatGrid.cpp.

{
    BWAPI::UnitType weaponType = t;
 
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        weaponType = BWAPI::UnitTypes::Terran_Marine;
    }
 
    BWAPI::WeaponType w = weaponType.airWeapon();
    if (w == BWAPI::WeaponTypes::None)
    {
        return 0;
    }
 
    int dmg = w.damageAmount() * w.damageFactor();
    int hits = weaponType.maxAirHits();
 
    int mult = 1;
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        mult = 4;
    }
 
    return dmg * hits * mult;
}

◆ detectionAt()

int ThreatGrid::detectionAt ( BWAPI::Position p ) const

Returns the detection threat value at a given position.

Parameters

p	World position

Returns: Detection intensity value

Definition at line 51 of file ThreatGrid.cpp.

{
    return detection_.get(toWalkX(p), toWalkY(p));
}

◆ detectorRadiusPx()

int ThreatGrid::detectorRadiusPx ( BWAPI::UnitType t ) const

private

Definition at line 178 of file ThreatGrid.cpp.

{
    if (t == BWAPI::UnitTypes::Terran_Missile_Turret) return 224;
    if (t == BWAPI::UnitTypes::Protoss_Photon_Cannon) return 224;
    if (t == BWAPI::UnitTypes::Zerg_Spore_Colony) return 224;
    if (t == BWAPI::UnitTypes::Terran_Science_Vessel) return 224;
    if (t == BWAPI::UnitTypes::Protoss_Observer) return 224;
 
    int r = t.sightRange();
    if (r <= 0) r = 224;
    return r;
}

◆ getAirThreat()

int ThreatGrid::getAirThreat ( BWAPI::Position p ) const

Definition at line 67 of file ThreatGrid.cpp.

{
    return airThreatAt(p);
}

◆ getDetection()

int ThreatGrid::getDetection ( BWAPI::Position p ) const

Wrapper for retrieving detection threat at a position.

Definition at line 76 of file ThreatGrid.cpp.

{
    return detectionAt(p);
}

◆ groundThreatAt()

int ThreatGrid::groundThreatAt ( BWAPI::Position p ) const

Returns the ground threat value at a given position.

Parameters

p	World position

Returns: Accumulated ground threat value

Definition at line 40 of file ThreatGrid.cpp.

{
    return groundThreat_.get(toWalkX(p), toWalkY(p));
}

◆ groundThreatRangePx()

int ThreatGrid::groundThreatRangePx ( BWAPI::UnitType t ) const

private

Definition at line 191 of file ThreatGrid.cpp.

{
    BWAPI::UnitType weaponType = t;
 
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        weaponType = BWAPI::UnitTypes::Terran_Marine;
    }
 
    BWAPI::WeaponType w = weaponType.groundWeapon();
    if (w == BWAPI::WeaponTypes::None)
    {
        return 0;
    }
 
    int range = w.maxRange();
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        range += 48;
    }
 
    return range + rangeBufferPx_;
}

◆ groundThreatValue()

int ThreatGrid::groundThreatValue ( BWAPI::UnitType t ) const

private

Definition at line 215 of file ThreatGrid.cpp.

{
    BWAPI::UnitType weaponType = t;
 
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        weaponType = BWAPI::UnitTypes::Terran_Marine;
    }
 
    BWAPI::WeaponType w = weaponType.groundWeapon();
    if (w == BWAPI::WeaponTypes::None)
    {
        return 0;
    }
 
    int dmg = w.damageAmount() * w.damageFactor();
    int hits = weaponType.maxGroundHits();
 
    int mult = 1;
    if (t == BWAPI::UnitTypes::Terran_Bunker)
    {
        mult = 4;
    }
 
    return dmg * hits * mult;
}

◆ onFrameStart()

void ThreatGrid::onFrameStart ( int frame )

Updates the current frame reference for the grid.

Parameters

frame Current game frame

Definition at line 29 of file ThreatGrid.cpp.

{
    currentFrame_ = frame;
}

◆ onStart()

void ThreatGrid::onStart ( )

Initializes threat grids based on map dimensions.

Creates walk-tile resolution grids for:

Ground threat
Air threat
Detection coverage

Definition at line 13 of file ThreatGrid.cpp.

{
    const int walkW = BWAPI::Broodwar->mapWidth() * 4;
    const int walkH = BWAPI::Broodwar->mapHeight() * 4;
 
    groundThreat_.init(walkW, walkH);
    detection_.init(walkW, walkH);
 
    stamps_.clear();
}

◆ paintDisc()

void ThreatGrid::paintDisc	(	GridData &	g,
		BWAPI::Position	center,
		int	rangePx,
		int	delta )

private

Definition at line 149 of file ThreatGrid.cpp.

{
    const int cx = toWalkX(center);
    const int cy = toWalkY(center);
 
    const int rWalk = (rangePx >> 3) + 1;
    const int r2 = rangePx * rangePx;
 
    for (int dx = -rWalk; dx <= rWalk; ++dx)
    {
        for (int dy = -rWalk; dy <= rWalk; ++dy)
        {
            const int wx = cx + dx;
            const int wy = cy + dy;
 
            const int px = (wx << 3) + 4;
            const int py = (wy << 3) + 4;
 
            const int ddx = px - center.x;
            const int ddy = py - center.y;
 
            if (ddx * ddx + ddy * ddy <= r2)
            {
                g.add(wx, wy, delta);
            }
        }
    }
}

◆ removeEnemy()

void ThreatGrid::removeEnemy ( int id )

Removes an enemy unit from the threat grid.

Clears its previously stamped threat values.

Parameters

id Unit ID

Definition at line 137 of file ThreatGrid.cpp.

{
    auto it = stamps_.find(id);
    if (it == stamps_.end())
    {
        return;
    }
 
    stampEnemy(it->second, -1);
    stamps_.erase(it);
}

◆ stampEnemy()

void ThreatGrid::stampEnemy	(	const EnemyStamp &	s,
		int	delta )

private

Definition at line 294 of file ThreatGrid.cpp.

{
    if (!s.completed)
    {
        return;
    }
 
    const BWAPI::UnitType t = s.type;
 
    if (t.isDetector())
    {
        const int r = detectorRadiusPx(t) + rangeBufferPx_;
        paintDisc(detection_, s.pos, r, delta);
    }
 
    if (s.immobile)
    {
        return;
    }
 
    const bool isLurker = (t == BWAPI::UnitTypes::Zerg_Lurker);
 
    if (isLurker && !s.burrowed)
    {
        return;
    }
 
    if (!isLurker && s.burrowed)
    {
        return;
    }
 
    const int range = groundThreatRangePx(t);
    const int value = groundThreatValue(t);
 
    if (range > 0 && value > 0)
    {
        paintDisc(groundThreat_, s.pos, range, value * delta);
    }
 
    const int airRange = airThreatRangePx(t);
    const int airValue = airThreatValue(t);
 
    if (airRange > 0 && airValue > 0)
    {
        paintDisc(airThreat_, s.pos, airRange, airValue * delta);
    }
}

◆ toWalkX()

int ThreatGrid::toWalkX ( BWAPI::Position p )

inlinestaticprivate

Definition at line 92 of file ThreatGrid.h.

    {
        return p.x >> 3;
    }

◆ toWalkY()

int ThreatGrid::toWalkY ( BWAPI::Position p )

inlinestaticprivate

Definition at line 97 of file ThreatGrid.h.

    {
        return p.y >> 3;
    }

Member Data Documentation

◆ airThreat_

GridData ThreatGrid::airThreat_

private

Definition at line 86 of file ThreatGrid.h.

◆ currentFrame_

int ThreatGrid::currentFrame_ = 0

private

Definition at line 82 of file ThreatGrid.h.

◆ detection_

GridData ThreatGrid::detection_

private

Definition at line 87 of file ThreatGrid.h.

◆ groundThreat_

GridData ThreatGrid::groundThreat_

private

Definition at line 85 of file ThreatGrid.h.

◆ rangeBufferPx_

int ThreatGrid::rangeBufferPx_ = 16

private

Definition at line 83 of file ThreatGrid.h.

◆ stamps_

std::unordered_map<int, EnemyStamp> ThreatGrid::stamps_

private

Definition at line 90 of file ThreatGrid.h.

The documentation for this class was generated from the following files:

src/protobot/ThreatGrid.h
src/protobot/ThreatGrid.cpp

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addOrUpdateEnemy()

◆ airThreatAt()

◆ airThreatRangePx()

◆ airThreatValue()

◆ detectionAt()

◆ detectorRadiusPx()

◆ getAirThreat()

◆ getDetection()

◆ groundThreatAt()

◆ groundThreatRangePx()

◆ groundThreatValue()

◆ onFrameStart()

◆ onStart()

◆ paintDisc()

◆ removeEnemy()

◆ stampEnemy()

◆ toWalkX()

◆ toWalkY()

Member Data Documentation

◆ airThreat_

◆ currentFrame_

◆ detection_

◆ groundThreat_

◆ rangeBufferPx_

◆ stamps_