Constructors
constructor
Parameters
name: string
priority: number
Properties
Private _combatZerg _combatZerg: object
Private _creeps_creeps: object
Type declaration
[ roleName: string ]: Creep []
Private _zerg_zerg: object
Type declaration
[ roleName: string ]: Zerg []
Private boostsboosts: object
Type declaration
[ roleName: string ]: _ResourceConstantSansEnergy [] | undefined
creepUsageReport
creepUsageReport: object
Type declaration
[ roleName: string ]: [ number , number ] | undefined
priority
priority: number
room
room: Room | undefined
Accessors
isSuspended
get isSuspended( ) : boolean
outpostIndex
get outpostIndex( ) : number
Methods
autoRun
autoRun( roleCreeps: Zerg [] , taskHandler: function , fleeCallback?: undefined | function ) : void
Parameters
roleCreeps: Zerg []
taskHandler: function
Optional fleeCallback: undefined | function
Returns void
canBoostSetup
Parameters
Returns boolean
Protected combatZerg
combatZerg( role: string , opts?: ZergOptions ) : CombatZerg []
Parameters
role: string
Default value opts: ZergOptions = {}
Protected creepReport
creepReport( role: string , currentAmt: number , neededAmt: number ) : void
Parameters
role: string
currentAmt: number
neededAmt: number
Returns void
Protected handleBoosting
handleBoosting( creep: Zerg ) : void
lifetimeFilter
lifetimeFilter( creeps: ( Zerg | Creep ) [] , prespawn?: number ) : ( Zerg | Creep ) []
Parameters
creeps: ( Zerg | Creep ) []
Default value prespawn: number = DEFAULT_PRESPAWN
Returns ( Zerg | Creep ) []
parkCreepsIfIdle
parkCreepsIfIdle( creeps: Zerg [] , outsideHatchery?: boolean ) : void
Parameters
creeps: Zerg []
Default value outsideHatchery: boolean = true
Returns void
Protected reassignIdleCreeps
reassignIdleCreeps( role: string ) : void
recalculateCreeps
recalculateCreeps( ) : void
Private requestBoosts
requestBoosts( creeps: Zerg [] ) : void
Private requestBoostsForCreep
requestBoostsForCreep( creep: Zerg ) : void
shouldBoost
shouldBoost( creep: Zerg , onlyBoostInSpawn?: boolean ) : boolean
Parameters
Default value onlyBoostInSpawn: boolean = false
Returns boolean
suspendFor
suspendFor( ticks: number ) : void
suspendUntil
suspendUntil( untilTick: number ) : void
Private synchronizeCombatZerg
synchronizeCombatZerg( role: string , notifyWhenAttacked?: undefined | false | true ) : void
Parameters
role: string
Optional notifyWhenAttacked: undefined | false | true
Returns void
Private synchronizeZerg
synchronizeZerg( role: string , notifyWhenAttacked?: undefined | false | true ) : void
Parameters
role: string
Optional notifyWhenAttacked: undefined | false | true
Returns void
Protected zerg
zerg( role: string , opts?: ZergOptions ) : Zerg []
Parameters
role: string
Default value opts: ZergOptions = {}
Returns Zerg []
Legend
Module Object literal Variable Function Function with type parameter Index signature Type alias
Enumeration Enumeration member Property Method
Interface Interface with type parameter Constructor Property Method Index signature
Class Class with type parameter Constructor Property Method Accessor Index signature
Inherited constructor Inherited property Inherited method Inherited accessor
Protected property Protected method Protected accessor
Private property Private method Private accessor
Static property Static method
An Overlord is roughly analogous to a process in an OS: it is a generalization of a set of related things that need to be done in a colony, like mining from a site, bootstrapping a new colony, guarding against invaders, or building construction sites. Overlords handle spawning or obtaining suitable creeps to do these things and contain the actual implementation of doing them.