Search
Preparing search index...
The search index is not available
Overmind
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
ClaimingOverlord
Class ClaimingOverlord
Claim an unowned room
Hierarchy
Overlord
ClaimingOverlord
Index
Constructors
constructor
Properties
claimers
colony
creep
Usage
Report
initializer
name
pos
priority
ref
room
spawn
Group
Accessors
is
Suspended
outpost
Index
print
Methods
auto
Run
can
Boost
Setup
combat
Zerg
creep
Report
handle
Boosting
handle
Claimer
init
lifetime
Filter
park
Creeps
IfIdle
pre
Init
reassign
Idle
Creeps
recalculate
Creeps
refresh
request
Creep
request
Squad
run
should
Boost
suspend
For
suspend
Until
visuals
wishlist
zerg
Constructors
constructor
new
Claiming
Overlord
(
directive
:
Directive
, priority
?:
number
)
:
ClaimingOverlord
Parameters
directive:
Directive
Default value
priority:
number
= OverlordPriority.colonization.claim
Returns
ClaimingOverlord
Properties
claimers
claimers
:
Zerg
[]
colony
colony
:
Colony
creep
Usage
Report
creep
Usage
Report
:
object
Type declaration
[
roleName:
string
]:
[
number
,
number
]
|
undefined
Protected
initializer
initializer
:
OverlordInitializer
|
Colony
name
name
:
string
pos
pos
:
RoomPosition
priority
priority
:
number
ref
ref
:
string
room
room
:
Room
|
undefined
spawn
Group
spawn
Group
:
SpawnGroup
|
undefined
Accessors
is
Suspended
get
isSuspended
(
)
:
boolean
Returns
boolean
outpost
Index
get
outpostIndex
(
)
:
number
Returns
number
print
get
print
(
)
:
string
Returns
string
Methods
auto
Run
auto
Run
(
roleCreeps
:
Zerg
[]
, taskHandler
:
function
, fleeCallback
?:
undefined
|
function
)
:
void
Parameters
roleCreeps:
Zerg
[]
taskHandler:
function
(
creep
:
Zerg
)
:
void
Parameters
creep:
Zerg
Returns
void
Optional
fleeCallback:
undefined
|
function
Returns
void
can
Boost
Setup
can
Boost
Setup
(
setup
:
CreepSetup
)
:
boolean
Parameters
setup:
CreepSetup
Returns
boolean
Protected
combat
Zerg
combat
Zerg
(
role
:
string
, opts
?:
ZergOptions
)
:
CombatZerg
[]
Parameters
role:
string
Default value
opts:
ZergOptions
= {}
Returns
CombatZerg
[]
Protected
creep
Report
creep
Report
(
role
:
string
, currentAmt
:
number
, neededAmt
:
number
)
:
void
Parameters
role:
string
currentAmt:
number
neededAmt:
number
Returns
void
Protected
handle
Boosting
handle
Boosting
(
creep
:
Zerg
)
:
void
Parameters
creep:
Zerg
Returns
void
Private
handle
Claimer
handle
Claimer
(
claimer
:
Zerg
)
:
void
Parameters
claimer:
Zerg
Returns
void
init
init
(
)
:
void
Returns
void
lifetime
Filter
lifetime
Filter
(
creeps
:
(
Zerg
|
Creep
)
[]
, prespawn
?:
number
)
:
(
Zerg
|
Creep
)
[]
Parameters
creeps:
(
Zerg
|
Creep
)
[]
Default value
prespawn:
number
= DEFAULT_PRESPAWN
Returns
(
Zerg
|
Creep
)
[]
park
Creeps
IfIdle
park
Creeps
IfIdle
(
creeps
:
Zerg
[]
, outsideHatchery
?:
boolean
)
:
void
Parameters
creeps:
Zerg
[]
Default value
outsideHatchery:
boolean
= true
Returns
void
pre
Init
pre
Init
(
)
:
void
Returns
void
Protected
reassign
Idle
Creeps
reassign
Idle
Creeps
(
role
:
string
)
:
void
Parameters
role:
string
Returns
void
recalculate
Creeps
recalculate
Creeps
(
)
:
void
Returns
void
refresh
refresh
(
)
:
void
Returns
void
Protected
request
Creep
request
Creep
(
setup
:
CreepSetup
, opts
?:
CreepRequestOptions
)
:
void
Parameters
setup:
CreepSetup
Default value
opts:
CreepRequestOptions
= {} as CreepRequestOptions
Returns
void
Protected
request
Squad
request
Squad
(
setups
:
CreepSetup
[]
, opts
?:
CreepRequestOptions
)
:
void
Parameters
setups:
CreepSetup
[]
Default value
opts:
CreepRequestOptions
= {} as CreepRequestOptions
Returns
void
run
run
(
)
:
void
Returns
void
should
Boost
should
Boost
(
creep
:
Zerg
, onlyBoostInSpawn
?:
boolean
)
:
boolean
Parameters
creep:
Zerg
Default value
onlyBoostInSpawn:
boolean
= false
Returns
boolean
suspend
For
suspend
For
(
ticks
:
number
)
:
void
Parameters
ticks:
number
Returns
void
suspend
Until
suspend
Until
(
untilTick
:
number
)
:
void
Parameters
untilTick:
number
Returns
void
visuals
visuals
(
)
:
void
Returns
void
Protected
wishlist
wishlist
(
quantity
:
number
, setup
:
CreepSetup
, opts
?:
CreepRequestOptions
)
:
void
Parameters
quantity:
number
setup:
CreepSetup
Default value
opts:
CreepRequestOptions
= {} as CreepRequestOptions
Returns
void
Protected
zerg
zerg
(
role
:
string
, opts
?:
ZergOptions
)
:
Zerg
[]
Parameters
role:
string
Default value
opts:
ZergOptions
= {}
Returns
Zerg
[]
Globals
Claiming
Overlord
constructor
claimers
colony
creep
Usage
Report
initializer
name
pos
priority
ref
room
spawn
Group
is
Suspended
outpost
Index
print
auto
Run
can
Boost
Setup
combat
Zerg
creep
Report
handle
Boosting
handle
Claimer
init
lifetime
Filter
park
Creeps
IfIdle
pre
Init
reassign
Idle
Creeps
recalculate
Creeps
refresh
request
Creep
request
Squad
run
should
Boost
suspend
For
suspend
Until
visuals
wishlist
zerg
Generated using
TypeDoc
Claim an unowned room