Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CombatZerg

CombatZerg is an extension of the Zerg class which contains additional combat-related methods

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new CombatZerg(creep: Creep, notifyWhenAttacked?: boolean): CombatZerg

Properties

actionLog

actionLog: object

Type declaration

  • [actionName: string]: boolean

blockMovement

blockMovement: boolean

body

body: BodyPartDefinition[]

carry

carry: StoreDefinition

carryCapacity

carryCapacity: number

creep

creep: Creep

fatigue

fatigue: number

hits

hits: number

hitsMax

hitsMax: number

id

id: string

isCombatZerg

isCombatZerg: boolean

lifetime

lifetime: number

memory

memory: CombatZergMemory

name

name: string

pos

pos: RoomPosition

ref

ref: string

roleName

roleName: string

room

room: Room

saying

saying: string

spawning

spawning: boolean

ticksToLive

ticksToLive: number | undefined

Accessors

boostCounts

  • get boostCounts(): object

boosts

  • get boosts(): _ResourceConstantSansEnergy[]

colony

hasMineralsInCarry

  • get hasMineralsInCarry(): boolean

hasValidTask

  • get hasValidTask(): boolean

inColonyRoom

  • get inColonyRoom(): boolean

inRampart

  • get inRampart(): boolean

isIdle

  • get isIdle(): boolean

isMoving

  • get isMoving(): boolean

needsBoosts

  • get needsBoosts(): boolean

overlord

  • get overlord(): Overlord | null
  • set overlord(newOverlord: Overlord | null): void

print

  • get print(): string

task

  • get task(): Task | null
  • set task(task: Task | null): void

ticksUntilSpawned

  • get ticksUntilSpawned(): number | undefined

Methods

attack

  • attack(target: Creep | Structure): 0 | -1 | -4 | -7 | -9 | -12 | -11

  • Parameters

    • target: Creep | Structure

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11

attackAndChase

  • attackAndChase(target: Creep | Structure): CreepActionReturnCode

  • Attack and chase the specified target

    Parameters

    • target: Creep | Structure

    Returns CreepActionReturnCode

attackController

  • attackController(controller: StructureController): 0 | -1 | -4 | -7 | -9 | -12 | -11

autoCombat

  • autoCombat(roomName: string, verbose?: boolean): undefined | number

  • Navigate to a room, then engage hostile creeps there, perform medic actions, etc.

    Parameters

    • roomName: string
    • Default value verbose: boolean = false

    Returns undefined | number

autoHeal

  • autoHeal(allowRangedHeal?: boolean, friendlies?: Creep[]): undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11

  • Parameters

    • Default value allowRangedHeal: boolean = true
    • Default value friendlies: Creep[] = this.room.creeps

    Returns undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11

autoMelee

  • autoMelee(possibleTargets?: Creep[]): undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11

  • Parameters

    • Default value possibleTargets: Creep[] = this.room.hostiles

    Returns undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11

autoRanged

  • autoRanged(possibleTargets?: Creep[], allowMassAttack?: boolean): undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11

  • Parameters

    • Default value possibleTargets: Creep[] = this.room.hostiles
    • Default value allowMassAttack: boolean = true

    Returns undefined | 0 | -1 | -4 | -7 | -9 | -12 | -11

autoSkirmish

  • autoSkirmish(roomName: string, verbose?: boolean): number

  • Navigate to a room, then engage hostile creeps there, perform medic actions, etc.

    Parameters

    • roomName: string
    • Default value verbose: boolean = false

    Returns number

build

  • build(target: ConstructionSite): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14

  • Parameters

    • target: ConstructionSite

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14

canExecute

  • canExecute(actionName: string): boolean

cancelOrder

  • cancelOrder(methodName: string): OK | ERR_NOT_FOUND

claimController

  • claimController(controller: StructureController): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -8 | -15

debug

  • debug(...args: any[]): void

dismantle

  • dismantle(target: Structure): CreepActionReturnCode

doMedicActions

  • doMedicActions(roomName: string): void

drop

  • drop(resourceType: ResourceConstant, amount?: undefined | number): 0 | -1 | -4 | -6

  • Parameters

    • resourceType: ResourceConstant
    • Optional amount: undefined | number

    Returns 0 | -1 | -4 | -6

findPartner

findSwarm

  • findSwarm(partners: CombatZerg[], maxByRole: object, tickDifference?: number): string | undefined

  • Parameters

    • partners: CombatZerg[]
    • maxByRole: object
      • [role: string]: number
    • Default value tickDifference: number = DEFAULT_SWARM_TICK_DIFFERENCE

    Returns string | undefined

flee

  • flee(avoidGoals?: (RoomPosition | HasPos)[], fleeOptions?: FleeOptions, moveOptions?: MoveOptions): boolean

  • Flee from hostiles in the room, while not repathing every tick

    Parameters

    • Default value avoidGoals: (RoomPosition | HasPos)[] = this.room.fleeDefaults
    • Default value fleeOptions: FleeOptions = {}
    • Default value moveOptions: MoveOptions = {}

    Returns boolean

generateSafeMode

  • generateSafeMode(target: StructureController): 0 | -1 | -4 | -7 | -9 | -12 | -11

getActiveBodyparts

  • getActiveBodyparts(type: BodyPartConstant): number

getBodyparts

  • getBodyparts(partType: BodyPartConstant): number

goBuild

  • goBuild(target: ConstructionSite): number

goDrop

  • goDrop(pos: RoomPosition, resourceType: ResourceConstant, amount?: undefined | number): number

  • Parameters

    • pos: RoomPosition
    • resourceType: ResourceConstant
    • Optional amount: undefined | number

    Returns number

goHarvest

  • goHarvest(source: Source | Mineral): number

goRepair

  • goRepair(target: Structure): number

goTo

  • goTo(destination: RoomPosition | HasPos, options?: MoveOptions): number

goToRoom

  • goToRoom(roomName: string, options?: MoveOptions): number

goTransfer

  • goTransfer(target: Creep | Zerg | Structure, resourceType?: ResourceConstant, amount?: undefined | number): number

  • Parameters

    • target: Creep | Zerg | Structure
    • Default value resourceType: ResourceConstant = RESOURCE_ENERGY
    • Optional amount: undefined | number

    Returns number

goWithdraw

  • goWithdraw(target: Structure | Tombstone, resourceType?: ResourceConstant, amount?: undefined | number): number

  • Parameters

    • target: Structure | Tombstone
    • Default value resourceType: ResourceConstant = RESOURCE_ENERGY
    • Optional amount: undefined | number

    Returns number

harvest

  • harvest(source: Source | Mineral): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -5

  • Parameters

    • source: Source | Mineral

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -5

heal

  • heal(target: Creep | Zerg, rangedHealInstead?: boolean): 0 | -1 | -4 | -7 | -9 | -12 | -11

  • Parameters

    • target: Creep | Zerg
    • Default value rangedHealInstead: boolean = false

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11

healSelfIfPossible

  • healSelfIfPossible(): CreepActionReturnCode | undefined

inSameRoomAs

  • inSameRoomAs(target: HasPos): boolean

kite

  • kite(avoidGoals?: (RoomPosition | HasPos)[], options?: MoveOptions): number | undefined

  • Kite around hostiles in the room

    Parameters

    • Default value avoidGoals: (RoomPosition | HasPos)[] = this.room.hostiles
    • Default value options: MoveOptions = {}

    Returns number | undefined

move

  • move(direction: DirectionConstant, force?: boolean): 0 | -1 | -4 | -12 | -11

  • Parameters

    • direction: DirectionConstant
    • Default value force: boolean = false

    Returns 0 | -1 | -4 | -12 | -11

moveOffCurrentPos

  • moveOffCurrentPos(): number | undefined

moveOffExit

  • moveOffExit(avoidSwamp?: boolean): ScreepsReturnCode

  • Moves off of an exit tile

    Parameters

    • Default value avoidSwamp: boolean = true

    Returns ScreepsReturnCode

moveOffExitToward

  • moveOffExitToward(pos: RoomPosition, detour?: boolean): number | undefined

moveOnExit

  • moveOnExit(): ScreepsReturnCode | undefined

needsToRecover

  • needsToRecover(recoverThreshold?: number, reengageThreshold?: number): boolean

  • Parameters

    • Default value recoverThreshold: number = CombatIntel.minimumDamageTakenMultiplier(this.creep) < 1 ? 0.85 : 0.75
    • Default value reengageThreshold: number = 1

    Returns boolean

notifyWhenAttacked

  • notifyWhenAttacked(enabled: boolean): 0 | -1 | -4 | -10

park

  • park(pos?: RoomPosition, maintainDistance?: boolean): number

  • Park the creep off-roads

    Parameters

    • Default value pos: RoomPosition = this.pos
    • Default value maintainDistance: boolean = false

    Returns number

pickup

  • pickup(resource: Resource): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -8

  • Parameters

    • resource: Resource

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11 | -8

rangedAttack

  • rangedAttack(target: Creep | Structure): 0 | -1 | -4 | -7 | -9 | -12 | -11

rangedHeal

  • rangedHeal(target: Creep | Zerg): 0 | -1 | -4 | -7 | -9 | -12 | -11

rangedMassAttack

  • rangedMassAttack(): 0 | -1 | -4 | -12

reassign

  • reassign(newOverlord: Overlord | null, newRole: string, invalidateTask?: boolean): void

recover

  • recover(): number

refresh

  • refresh(): void

  • Refresh all changeable properties of the creep or delete from Overmind and global when dead

    Returns void

repair

  • repair(target: Structure): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6

  • Parameters

    • target: Structure

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6

reserveController

  • reserveController(controller: StructureController): 0 | -1 | -4 | -7 | -9 | -12 | -11

run

  • run(): number | undefined

  • Execute the task you currently have.

    Returns number | undefined

safelyInRoom

  • safelyInRoom(roomName: string): boolean

say

  • say(message: string, pub?: undefined | false | true): 0 | -1 | -4

  • Parameters

    • message: string
    • Optional pub: undefined | false | true

    Returns 0 | -1 | -4

sayLoop

  • sayLoop(messageList: string[], pub?: undefined | false | true): 0 | -1 | -4

  • Parameters

    • messageList: string[]
    • Optional pub: undefined | false | true

    Returns 0 | -1 | -4

sayRandom

  • sayRandom(phrases: string[], pub?: undefined | false | true): 0 | -1 | -4

  • Parameters

    • phrases: string[]
    • Optional pub: undefined | false | true

    Returns 0 | -1 | -4

signController

  • signController(target: StructureController, text: string): 0 | -4 | -7 | -9

suicide

  • suicide(): 0 | -1 | -4

transfer

  • transfer(target: Creep | Zerg | Structure, resourceType?: ResourceConstant, amount?: undefined | number): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -8 | -15 | -2 | -3 | -5 | -10

  • Parameters

    • target: Creep | Zerg | Structure
    • Default value resourceType: ResourceConstant = RESOURCE_ENERGY
    • Optional amount: undefined | number

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -8 | -15 | -2 | -3 | -5 | -10

upgradeController

  • upgradeController(controller: StructureController): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -8 | -15 | -2 | -3 | -5 | -10

  • Parameters

    • controller: StructureController

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -8 | -15 | -2 | -3 | -5 | -10

withdraw

  • withdraw(target: Structure | Tombstone, resourceType?: ResourceConstant, amount?: undefined | number): 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -8 | -15 | -2 | -3 | -5 | -10

  • Parameters

    • target: Structure | Tombstone
    • Default value resourceType: ResourceConstant = RESOURCE_ENERGY
    • Optional amount: undefined | number

    Returns 0 | -1 | -4 | -7 | -9 | -12 | -11 | -6 | -14 | -8 | -15 | -2 | -3 | -5 | -10

Generated using TypeDoc