MiningOverlord | Overmind

Spawns miners to harvest from remote, owned, or sourcekeeper energy deposits. Standard mining actions have been heavily CPU-optimized

Hierarchy

Overlord
- MiningOverlord

Index

Constructors

constructor

Properties

Accessors

Object literals

settings

Constructors

constructor

new MiningOverlord(directive: DirectiveHarvest, priority: number): MiningOverlord

Overrides Overlord.constructor
- Defined in overlords/mining/miner.ts:48
Parameters
- directive: DirectiveHarvest
- priority: number
Returns MiningOverlord

Properties

allowDropMining

allowDropMining: boolean

colony

colony: Colony

constructionSite

constructionSite: ConstructionSite | undefined

container

container: StructureContainer | undefined

creepUsageReport

creepUsageReport: object

Type declaration

[roleName: string]: [number, number] | undefined

directive

directive: DirectiveHarvest

energyPerTick

energyPerTick: number

harvestPos

harvestPos: RoomPosition | undefined

Protected initializer

initializer: OverlordInitializer | Colony

link

link: StructureLink | undefined

miners

miners: Zerg[]

minersNeeded

minersNeeded: number

miningPowerNeeded

miningPowerNeeded: number

mode

mode: "early" | "SK" | "link" | "standard" | "double"

name

name: string

pos

pos: RoomPosition

priority

priority: number

ref

ref: string

room

room: Room | undefined

setup

setup: CreepSetup

source

source: Source | undefined

spawnGroup

spawnGroup: SpawnGroup | undefined

Accessors

distance

get distance(): number

- Defined in overlords/mining/miner.ts:98
Returns number

isSuspended

get isSuspended(): boolean

Inherited from Overlord.isSuspended
- Defined in overlords/Overlord.ts:93
Returns boolean

outpostIndex

get outpostIndex(): number

Inherited from Overlord.outpostIndex
- Defined in overlords/Overlord.ts:220
Returns number

print

get print(): string

Inherited from Overlord.print
- Defined in overlords/Overlord.ts:133
Returns string

Methods

Private addRemoveContainer

addRemoveContainer(): void

- Defined in overlords/mining/miner.ts:145
Returns void

autoRun

autoRun(roleCreeps: Zerg[], taskHandler: function, fleeCallback?: undefined | function): void

Inherited from Overlord.autoRun
- Defined in overlords/Overlord.ts:474
Parameters
- roleCreeps: Zerg[]
- taskHandler: function
  - - (creep: Zerg): void
    - Parameters
      - creep: Zerg
      Returns void
- Optional fleeCallback: undefined | function
Returns void

Private calculateContainerPos

calculateContainerPos(): RoomPosition

- Defined in overlords/mining/miner.ts:126
Returns RoomPosition

canBoostSetup

canBoostSetup(setup: CreepSetup): boolean

Inherited from Overlord.canBoostSetup
- Defined in overlords/Overlord.ts:370
Parameters
- setup: CreepSetup
Returns boolean

Protected combatZerg

combatZerg(role: string, opts?: ZergOptions): CombatZerg[]

Inherited from Overlord.combatZerg
- Defined in overlords/Overlord.ts:184
Parameters
- role: string
- Default value opts: ZergOptions = {}
Returns CombatZerg[]

Protected creepReport

creepReport(role: string, currentAmt: number, neededAmt: number): void

Inherited from Overlord.creepReport
- Defined in overlords/Overlord.ts:242
Parameters
- role: string
- currentAmt: number
- neededAmt: number
Returns void

Private earlyMiningActions

earlyMiningActions(miner: Zerg): undefined | number

- Defined in overlords/mining/miner.ts:195
Parameters
- miner: Zerg
Returns undefined | number

Private goToMiningSite

goToMiningSite(miner: Zerg): boolean

- Defined in overlords/mining/miner.ts:294
Parameters
- miner: Zerg
Returns boolean

Protected handleBoosting

handleBoosting(creep: Zerg): void

Inherited from Overlord.handleBoosting
- Defined in overlords/Overlord.ts:434
Parameters
- creep: Zerg
Returns void

Private handleMiner

handleMiner(miner: Zerg): number | void

- Defined in overlords/mining/miner.ts:310
Parameters
- miner: Zerg
Returns number | void

init

init(): void

Overrides Overlord.init
- Defined in overlords/mining/miner.ts:190
Returns void

lifetimeFilter

lifetimeFilter(creeps: (Zerg | Creep)[], prespawn?: number): (Zerg | Creep)[]

Inherited from Overlord.lifetimeFilter
- Defined in overlords/Overlord.ts:247
Parameters
- creeps: (Zerg | Creep)[]
- Default value prespawn: number = DEFAULT_PRESPAWN
Returns (Zerg | Creep)[]

Private linkMiningActions

linkMiningActions(miner: Zerg): void

- Defined in overlords/mining/miner.ts:237
Parameters
- miner: Zerg
Returns void

parkCreepsIfIdle

parkCreepsIfIdle(creeps: Zerg[], outsideHatchery?: boolean): void

Inherited from Overlord.parkCreepsIfIdle
- Defined in overlords/Overlord.ts:267
Parameters
- creeps: Zerg[]
- Default value outsideHatchery: boolean = true
Returns void

Private populateStructures

populateStructures(): void

- Defined in overlords/mining/miner.ts:102
Returns void

preInit

preInit(): void

Inherited from Overlord.preInit
- Defined in overlords/Overlord.ts:460
Returns void

Protected reassignIdleCreeps

reassignIdleCreeps(role: string): void

Inherited from Overlord.reassignIdleCreeps
- Defined in overlords/Overlord.ts:224
Parameters
- role: string
Returns void

recalculateCreeps

recalculateCreeps(): void

Inherited from Overlord.recalculateCreeps
- Defined in overlords/Overlord.ts:137
Returns void

refresh

refresh(): void

Overrides Overlord.refresh
- Defined in overlords/mining/miner.ts:114
Returns void

Private registerEnergyRequests

registerEnergyRequests(): void

- Defined in overlords/mining/miner.ts:170
Returns void

Protected requestCreep

requestCreep(setup: CreepSetup, opts?: CreepRequestOptions): void

Inherited from Overlord.requestCreep
- Defined in overlords/Overlord.ts:318
Parameters
- setup: CreepSetup
- Default value opts: CreepRequestOptions = {} as CreepRequestOptions
Returns void

Protected requestSquad

requestSquad(setups: CreepSetup[], opts?: CreepRequestOptions): void

Inherited from Overlord.requestSquad
- Defined in overlords/Overlord.ts:292
Parameters
- setups: CreepSetup[]
- Default value opts: CreepRequestOptions = {} as CreepRequestOptions
Returns void

run

run(): void

Overrides Overlord.run
- Defined in overlords/mining/miner.ts:344
Returns void

shouldBoost

shouldBoost(creep: Zerg, onlyBoostInSpawn?: boolean): boolean

Inherited from Overlord.shouldBoost
- Defined in overlords/Overlord.ts:391
Parameters
- creep: Zerg
- Default value onlyBoostInSpawn: boolean = false
Returns boolean

Private standardMiningActions

standardMiningActions(miner: Zerg): undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -5

- Defined in overlords/mining/miner.ts:254
Parameters
- miner: Zerg
Returns undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -5

suspendFor

suspendFor(ticks: number): void

Inherited from Overlord.suspendFor
- Defined in overlords/Overlord.ts:97
Parameters
- ticks: number
Returns void

suspendUntil

suspendUntil(untilTick: number): void

Inherited from Overlord.suspendUntil
- Defined in overlords/Overlord.ts:101
Parameters
- untilTick: number
Returns void

visuals

visuals(): void

Inherited from Overlord.visuals
- Defined in overlords/Overlord.ts:490
Returns void

Protected wishlist

wishlist(quantity: number, setup: CreepSetup, opts?: CreepRequestOptions): void

Inherited from Overlord.wishlist
- Defined in overlords/Overlord.ts:342
Parameters
- quantity: number
- setup: CreepSetup
- Default value opts: CreepRequestOptions = {} as CreepRequestOptions
Returns void

Protected zerg

zerg(role: string, opts?: ZergOptions): Zerg[]

Inherited from Overlord.zerg
- Defined in overlords/Overlord.ts:152
Parameters
- role: string
- Default value opts: ZergOptions = {}
Returns Zerg[]

Object literals

Static settings

settings: object

dropMineUntilRCL

dropMineUntilRCL: number = 3

minLinkDistance

minLinkDistance: number = 10

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

directive: DirectiveHarvest

priority: number

Returns MiningOverlord

Properties

allowDropMining

colony

constructionSite

container

creepUsageReport

Type declaration

[roleName: string]: [number, number] | undefined

directive

energyPerTick

harvestPos

Protected initializer

link

miners

minersNeeded

miningPowerNeeded

mode

name

pos

priority

ref

room

setup

source

spawnGroup

Accessors

distance

Returns number

isSuspended

Returns boolean

outpostIndex

Returns number

print

Returns string

Methods

Private addRemoveContainer

Returns void

autoRun

Parameters

roleCreeps: Zerg[]

taskHandler: function

Parameters

creep: Zerg

Returns void

Optional fleeCallback: undefined | function

Returns void

Private calculateContainerPos

Returns RoomPosition

canBoostSetup

Parameters

setup: CreepSetup

Returns boolean

Protected combatZerg

Parameters

role: string

Default value opts: ZergOptions = {}

Returns CombatZerg[]

Protected creepReport

Parameters

role: string

currentAmt: number

neededAmt: number

Returns void

Private earlyMiningActions

Parameters

miner: Zerg

Returns undefined | number