LogisticsNetwork | Overmind

Logistics Group: efficiently partners resource requests with transporters using a stable matching algorithm to provide general-purpose resource transport. For a better explanation of how this system works, see my blog post: https://bencbartlett.wordpress.com/2018/03/28/screeps-4-hauling-is-np-hard/

Hierarchy

LogisticsNetwork

Index

Constructors

constructor

Properties

Accessors

matching

Object literals

settings

Constructors

constructor

new LogisticsNetwork(colony: Colony): LogisticsNetwork

- Defined in logistics/LogisticsNetwork.ts:90
Parameters
- colony: Colony
Returns LogisticsNetwork

Properties

Private _matching

_matching: object | undefined

buffers

buffers: BufferTarget[]

Private cache

cache: object

Type declaration

colony

colony: Colony

memory

memory: LogisticsNetworkMemory

requests

requests: LogisticsRequest[]

Private targetToRequest

targetToRequest: object

Type declaration

[targetRef: string]: number

Accessors

matching

get matching(): object

- Defined in logistics/LogisticsNetwork.ts:643
Returns object
- [creepName: string]: LogisticsRequest | undefined

Methods

bufferChoices

bufferChoices(transporter: Zerg, request: LogisticsRequest): object[]

- Defined in logistics/LogisticsNetwork.ts:435
Parameters
- transporter: Zerg
- request: LogisticsRequest
Returns object[]

Private computeNextAvailability

computeNextAvailability(transporter: Zerg): [number, RoomPosition]

- Defined in logistics/LogisticsNetwork.ts:290
Parameters
- transporter: Zerg
Returns [number, RoomPosition]

Private computePredictedTransporterCarry

computePredictedTransporterCarry(transporter: Zerg, nextAvailability?: [number, RoomPosition]): StoreDefinition

- Defined in logistics/LogisticsNetwork.ts:339
Parameters
- transporter: Zerg
- Optional nextAvailability: [number, RoomPosition]
Returns StoreDefinition

Private getInputAmount

getInputAmount(target: LogisticsTarget, resourceType: ResourceConstant): number

- Defined in logistics/LogisticsNetwork.ts:201
Parameters
- target: LogisticsTarget
- resourceType: ResourceConstant
Returns number

Private getOutputAmount

getOutputAmount(target: LogisticsTarget, resourceType: ResourceConstant | "all"): number

- Defined in logistics/LogisticsNetwork.ts:241
Parameters
- target: LogisticsTarget
- resourceType: ResourceConstant | "all"
Returns number

invalidateCache

invalidateCache(transporter: Zerg, request: LogisticsRequest): void

- Defined in logistics/LogisticsNetwork.ts:552
Parameters
- transporter: Zerg
- request: LogisticsRequest
Returns void

Private nextAvailability

nextAvailability(transporter: Zerg): [number, RoomPosition]

- Defined in logistics/LogisticsNetwork.ts:323
Parameters
- transporter: Zerg
Returns [number, RoomPosition]

predictedRequestAmount

predictedRequestAmount(transporter: Zerg, request: LogisticsRequest, nextAvailability?: [number, RoomPosition]): number

- Defined in logistics/LogisticsNetwork.ts:389
Parameters
- transporter: Zerg
- request: LogisticsRequest
- Optional nextAvailability: [number, RoomPosition]
Returns number

Private predictedTransporterCarry

predictedTransporterCarry(transporter: Zerg): StoreDefinition

- Defined in logistics/LogisticsNetwork.ts:381
Parameters
- transporter: Zerg
Returns StoreDefinition

refresh

refresh(): void

- Defined in logistics/LogisticsNetwork.ts:112
Returns void

requestInput

requestInput(target: LogisticsTarget, opts?: RequestOptions): void

- Defined in logistics/LogisticsNetwork.ts:127
Parameters
- target: LogisticsTarget
- Default value opts: RequestOptions = {} as RequestOptions
Returns void

requestOutput

requestOutput(target: LogisticsTarget, opts?: RequestOptions): void

- Defined in logistics/LogisticsNetwork.ts:159
Parameters
- target: LogisticsTarget
- Default value opts: RequestOptions = {} as RequestOptions
Returns void

requestOutputMinerals

requestOutputMinerals(target: StoreStructure, opts?: RequestOptions): void

- Defined in logistics/LogisticsNetwork.ts:190
Parameters
- target: StoreStructure
- Default value opts: RequestOptions = {} as RequestOptions
Returns void

requestPreferences

requestPreferences(request: LogisticsRequest, transporters: Zerg[]): Zerg[]

- Defined in logistics/LogisticsNetwork.ts:540
Parameters
- request: LogisticsRequest
- transporters: Zerg[]
Returns Zerg[]

Private resourceChangeRate

resourceChangeRate(transporter: Zerg, request: LogisticsRequest): number

- Defined in logistics/LogisticsNetwork.ts:527
Parameters
- transporter: Zerg
- request: LogisticsRequest
Returns number

Private stableMatching

stableMatching(transporters: Zerg[]): object

- Defined in logistics/LogisticsNetwork.ts:651
Parameters
- transporters: Zerg[]
Returns object
- [creepName: string]: LogisticsRequest | undefined

summarize

summarize(): void

- Defined in logistics/LogisticsNetwork.ts:584
Returns void

summarizeMatching

summarizeMatching(): void

- Defined in logistics/LogisticsNetwork.ts:559
Returns void

transporterPreferences

transporterPreferences(transporter: Zerg): LogisticsRequest[]

- Defined in logistics/LogisticsNetwork.ts:546
Parameters
- transporter: Zerg
Returns LogisticsRequest[]

Static targetingTransporters

targetingTransporters(target: LogisticsTarget, excludedTransporter?: Zerg): Zerg[]

- Defined in logistics/LogisticsNetwork.ts:330
Parameters
- target: LogisticsTarget
- Optional excludedTransporter: Zerg
Returns Zerg[]

Object literals

Static settings

settings: object

carryThreshold

carryThreshold: number = 800

droppedEnergyThreshold

droppedEnergyThreshold: number = 200

flagDropAmount

flagDropAmount: number = 1000

rangeToPathHeuristic

rangeToPathHeuristic: number = 1.1

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

colony: Colony

Returns LogisticsNetwork

Properties

Private _matching

buffers

Private cache

Type declaration

colony

memory

requests

Private targetToRequest

Type declaration

[targetRef: string]: number

Accessors

matching

Returns object

[creepName: string]: LogisticsRequest | undefined

Methods

bufferChoices

Parameters

transporter: Zerg

request: LogisticsRequest

Returns object[]

Private computeNextAvailability

Parameters

transporter: Zerg

Returns [number, RoomPosition]

Private computePredictedTransporterCarry

Parameters

transporter: Zerg

Optional nextAvailability: [number, RoomPosition]

Returns StoreDefinition

Private getInputAmount

Parameters

target: LogisticsTarget

resourceType: ResourceConstant

Returns number

Private getOutputAmount

Parameters

target: LogisticsTarget

resourceType: ResourceConstant | "all"

Returns number

invalidateCache

Parameters

transporter: Zerg

request: LogisticsRequest

Returns void

Private nextAvailability

Parameters

transporter: Zerg

Returns [number, RoomPosition]

predictedRequestAmount

Parameters

transporter: Zerg

request: LogisticsRequest

Optional nextAvailability: [number, RoomPosition]

Returns number

Private predictedTransporterCarry

Parameters

transporter: Zerg

Returns StoreDefinition

refresh

Returns void

requestInput

Parameters

target: LogisticsTarget

Default value opts: RequestOptions = {} as RequestOptions

Returns void

requestOutput

Parameters