Class DirectiveHaul

Hauling directive: spawns hauler creeps to move large amounts of resourecs from a location (e.g. draining a storage)

Hierarchy

Directive
- DirectiveHaul

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DirectiveHaul(flag: Flag): DirectiveHaul

Overrides Directive.constructor
- Defined in directives/resource/haul.ts:25
Parameters
- flag: Flag
Returns DirectiveHaul

Properties

Private _drops

_drops: object

Type declaration

[resourceType: string]: Resource[]

Private _store

_store: StoreDefinition

colony

colony: Colony

memory

memory: DirectiveHaulMemory

name

name: string

overlords

overlords: object

Type declaration

[name: string]: Overlord

pos

pos: RoomPosition

ref

ref: string

requiredRCL

requiredRCL: number

room

room: Room | undefined

Static color

color: 6 = COLOR_YELLOW

Static directiveName

directiveName: string = "haul"

Static secondaryColor

secondaryColor: 3 = COLOR_BLUE

Accessors

drops

get drops(): object

- Defined in directives/resource/haul.ts:39
Returns object
- [resourceType: string]: Resource[]

flag

get flag(): Flag

Inherited from Directive.flag
- Defined in directives/Directive.ts:86
Returns Flag

hasDrops

get hasDrops(): boolean

- Defined in directives/resource/haul.ts:50
Returns boolean

print

get print(): string

Inherited from Directive.print
- Defined in directives/Directive.ts:118
Returns string

store

get store(): StoreDefinition

- Defined in directives/resource/haul.ts:63
Returns StoreDefinition

storeStructure

get storeStructure(): StructureStorage | StructureTerminal | StructureNuker | undefined

- Defined in directives/resource/haul.ts:54
Returns StructureStorage | StructureTerminal | StructureNuker | undefined

targetedBy

get targetedBy(): string[]

- Defined in directives/resource/haul.ts:35
Returns string[]

totalResources

get totalResources(): number

- Defined in directives/resource/haul.ts:93
Total amount of resources remaining to be transported; cached into memory in case room loses visibility

Returns number

Methods

alert

alert(message: string, priority?: NotifierPriority): void

Inherited from Directive.alert
- Defined in directives/Directive.ts:114
Parameters
- message: string
- Default value priority: NotifierPriority = NotifierPriority.Normal
Returns void

init

init(): void

Overrides Directive.init
- Defined in directives/resource/haul.ts:104
Returns void

refresh

refresh(): void

Inherited from Directive.refresh
- Defined in directives/Directive.ts:102
Returns void

remove

remove(force?: boolean): number | undefined

Inherited from Directive.remove
- Defined in directives/Directive.ts:212
Parameters
- Default value force: boolean = false
Returns number | undefined

run

run(): void

Overrides Directive.run
- Defined in directives/resource/haul.ts:108
Returns void

setColor

setColor(color: ColorConstant, secondaryColor?: ColorConstant): number

Inherited from Directive.setColor
- Defined in directives/Directive.ts:226
Parameters
- color: ColorConstant
- Optional secondaryColor: ColorConstant
Returns number

setPosition

setPosition(pos: RoomPosition): number

Inherited from Directive.setPosition
- Defined in directives/Directive.ts:234
Parameters
- pos: RoomPosition
Returns number

spawnMoarOverlords

spawnMoarOverlords(): void

Overrides Directive.spawnMoarOverlords
- Defined in directives/resource/haul.ts:31
Returns void

visuals

visuals(): void

Inherited from Directive.visuals
- Defined in directives/Directive.ts:368
Returns void

Static create

create(pos: RoomPosition, opts?: DirectiveCreationOptions): number | string

Inherited from Directive.create
- Defined in directives/Directive.ts:242
Parameters
- pos: RoomPosition
- Default value opts: DirectiveCreationOptions = {}
Returns number | string

Static createIfNotPresent

createIfNotPresent(pos: RoomPosition, scope: "room" | "pos", opts?: DirectiveCreationOptions): number | string | undefined

Inherited from Directive.createIfNotPresent
- Defined in directives/Directive.ts:303
Parameters
- pos: RoomPosition
- scope: "room" | "pos"
- Default value opts: DirectiveCreationOptions = {}
Returns number | string | undefined

Static filter

filter(flag: Flag): boolean

Inherited from Directive.filter
- Defined in directives/Directive.ts:349
Parameters
- flag: Flag
Returns boolean

Static find

find(flags: Flag[]): Directive[]

Inherited from Directive.find
- Defined in directives/Directive.ts:354
Parameters
- flags: Flag[]
Returns Directive[]

Static isPresent

isPresent(pos: RoomPosition, scope: "room" | "pos"): boolean

Inherited from Directive.isPresent
- Defined in directives/Directive.ts:263
Parameters
- pos: RoomPosition
- scope: "room" | "pos"
Returns boolean

Generated using TypeDoc