screeps-pathfinding v2.0.9

A pathfinding solution for screeps. Inspired by Traveler.

Installation

Copy pathing.js and pathing.utils.js into your screeps brunch directory.

Npm

npm i screeps-pathfinding

Implemented features

• Most options that original creep.moveTo supports
• Traffic management (push creeps out of the way or swap with them)
• Priority option (higher priority moves will execute first)
• Correct pathing to a range of target that is in another room (with default moveTo it not completes the path if pathing distance to target satisfies range)
• Power creeps support
• Find route for efficient long range movement
• Move off exit behavior (enabled by default, can be turned off)
• Move off road behavior (disabled by default, can be turned on) and separate function
• Fix path (for heuristicHeight > 1, can be turned off)
• onRoomEnter event
• Correct account of swamp roads for ignoreRoads and offRoads options
• Avoid rooms list (specified globally or by options)
• Prefer pushed creeps move closer to target or stay in range of target if working
• Caching of terrain and cost matrices
• Possibility to run moves by room

Implemneted fixes

• When moveTo as called multiple times for creep during the tick, it will overwrite previous move (no extra intent cost)

Not implemented (maybe will be in a future)

• Hostile avoidance (not just local avoidance)
• Swap with slow moving creep (> 1 ticks per tile) if it moves the same direction
• Support for multiple targets
• Reuse current path when stepped off path (instead of searching path again)
• Option to force the search of potentially blocking creeps each tick (more precise, but more CPU cost)
• Fix the issue with deadlock. Rarely happen when creeps issue moves in specific order if they use same priority. Workaround: use different priority for creeps targeted to specific job compare to those that are returning back

Usage

Note: By default pathfinder uses range: 1.

(Can change this value in the configuration section of pathing.js, at the bottom: const DEFAULT_RANGE = ...)

const Pathing = require('pathing');

module.exports.loop = function() {

	// issuing moves
	const pos = Game.flags['flag1'].pos;
	const creep1 = Game.creeps['creep1'];
	if (creep1.moveTo(pos, {range: 1, priority: 5}) === IN_RANGE) {
		// do work
	}

	const pos2 = Game.flags['flag2'].pos;
	const creep2 = Game.creeps['creep2'];
	if (creep2.moveTo(pos2, {range: 1}) === IN_RANGE) {
		// do work
	}

	// running all creep moves
	Pathing.runMoves();
};

Note: Ensure you use higher priority for miners like priority: 5, especially if they are slow (moving 1 tile per multiple ticks on road).

Move to room

const creep1 = Game.creeps['creep1'];
if (creep1.moveToRoom('E30N30') === IN_ROOM) {
	// search target logic, move and work
}

Move off road

const creep1 = Game.creeps['creep1'];
creep1.moveOffRoad();

const creep2 = Game.creeps['creep2'];
creep2.moveOffRoad(target2, {range: 3}); // will try to move off road staying in range 3 of target

const creep3 = Game.creeps['creep3'];
if (creep3.moveTo(target3, {range: 3, moveOffRoad: true}) === IN_RANGE) {
	// do work
}

Clearing working target

When creep stopped working call clearWorkingTarget (maybe not needed if you use own implementation of getCreepWorkingTarget).

This will prevent traffic manager from pushing the creep towards it's last target if creep is not working anymore.

const creep1 = Game.creeps['creep1'];
creep1.clearWorkingTarget();

Seaching path

findRoute is false for better accuracy.

const PathingUtils = require('pathing.utils');

let containerPos;
const lookContainer = PathingUtils.lookInRange(source.pos, source.room, LOOK_STRUCTURES, 1)
	.find(item => (item.structure.structureType === STRUCTURE_CONTAINER));
if (lookContainer) {
	containerPos = lookContainer.structure.pos;
}

const res = Pathing.findPath(remoteSourcePos, room.storage.pos, {
	heuristicWeight: 1,
	maxOps: 6000,
	findRoute: false,
	containerCost: 5, // path around other containers
	costCallback(roomName, matrix) {
		if (containerPos && roomName === containerPos.roomName) {
			matrix.set(containerPos.x, containerPos.y, 1);
		}
	}
});

Pathing.findPath result

Object with following fields:

path - array of RoomPosition objects opts - number of operations performed to find the path cost - cost of the path incomplete - true if path is incomplete

Running moves by room

module.exports.loop = function() {

	// issuing moves
	// ...

	// run for one room
	Pathing.runMovesRoom('E30N30');
	
	// run for another room
	Pathing.runMovesRoom('E31N30');
};

Configuration

There is a configuration section at the bottom of pathing.js file.

Feel free to change the values of DEFAULT_RANGE, DEFAULT_PATH_STYLE and getCreepWorkingTarget implementation.

// default visualize path style:
const DEFAULT_PATH_STYLE = {stroke: '#fff', lineStyle: 'dashed', opacity: 0.5};

// default range:
const DEFAULT_RANGE = 1;

const Pathing = new PathingManager({

	// list of rooms to avoid globally:
	/* avoidRooms: [], */

	// this event will be called every time creep enters new room:
	/* onRoomEnter(creep, roomName) {
		console.log(`Creep ${creep.name} entered room ${roomName}`);
	}, */

	// manager will use this function to make creeps stay in range of their target
	getCreepWorkingTarget(creep) {
		const target = creep.memory._t;
		if (!target) {
			return;
		}
		const [x, y, roomName] = target.pos;
		return {
			pos: new RoomPosition(x, y, roomName),
			range: target.range,
			priority: target.priority,
		};
	}

});

Pathing.moveTo(creep, target, ?options) / Creep.moveTo(target, ?options)

Will try to move creep towards the target using specified options.

Return values:

OK - successfully scheduled moving to target

ERR_NO_PATH - found path is empty or incomplete (if allowIncomplete is set to false)

if called via overrided Creep.moveTo

IN_RANGE - creep is in range of target and not on exit tile, if moveOffExit option is not disabled

target

RoomPosition or object with pos RoomPosition property

moveTo options

Not includes this options from original creep.moveTo:

• reusePath
• serializeMemory
• noPathFinding
• ignoreCreeps
• ignoreDestructibleStructures (renamed to ignoreStructures)
• ignore
• avoid

range

Default: 1

Find path to position that is in specified range of a target. Supports set range to 0 for unpathable target. In that case range 1 will be used and add target position to the end of the path.

priority

Default: 0

Priority for creep movement. Movement for creep with higher priority is preferred, lower priority creeps will be pushed away if possible (this can happen in a sequence). Can accept negative values.

moveOffExit

Default: true

Forces path finish position to be on non-exit tile. Only works if specified range is greater than 0. Can be turned off.

moveOffRoad

Default: false

Only available if called via Creep.moveTo.

If set to true, tries to move creep off road if it is finished moving and in range of target. Will only move off road if stay in range of target. Target is determined by getCreepWorkingTarget. If no target just tries to move off road.

Turned off by default. To enable globaly for all creeps uncomment the line moveOffRoad: true in method Creep.prototype.moveTo in configuration section.

moveOffContainer

Default: true

Will be used when moveOffRoad behavior is enabled. Will treat containers as roads. Can be turned off.

visualizePathStyle

Default: undefined

Works as original option. But additional line is displaying from path end to target position using same style but with changed color to light blue.

avoidRooms

Default: []

Exclude rooms from pathfinding completely. Creeps will not enter these rooms.

findRoute

Default: true

Use find route if room distance >= 3.

ignoreStructures

Default: false

ignoreRoads

Default: false

offRoads

Default: false

ignoreTunnels

Default: false

ignoreContainers

Default: false

plainCost

Default: (ignoreRoads || offRoads) ? 1 : 2

Can be overwritten with another value. Works as original option.

swampCost

Default: (ignoreRoads || offRoads) ? 5 : 10

Can be overwritten with another value. Works as original option.

containerCost

Default: 5

Pathing cost for container. Takes no effect when ignoreContainers is set. Default value helps to avoid potential creeps that are working there. Setting it to 1 useful to prioritize container when generating path to a source.

costCallback(roomName, matrix)

Default: undefined

Works as original option.

routeCallback(roomName)

Default: (roomName) => isHighwayRoom(roomName) ? 1 : 2.5

Will be used for find route between rooms if room distance is >= 3. Higher values increate cost, that means less priority. To exclude a room use Infinity.

avoidRooms will also be applied to find route (both global and specified in moveTo).

heuristicWeight

Default: offRoads ? 1 : 1.2

Can be overwritten with another value. Works as original option.

fixPath

Default: true

If set, fixes the path after finding (those annoying one tile step out of the road on turns). Only does it for one current room, so relatively cheap. Takes no effect if heuristicWeight is 1 or ignoreRoads is set or offRoads is set or resulting path length is 3 or shorter. Can be turned off.

allowIncomplete

Default: true

If set to false and unable to find complete path: function will return ERR_NO_PATH and creep move intent will not be scheduled.

maxOps

Default: 2000

Works as original option.

maxRooms

Default: 16

Works as original option.

maxCost

Default: undefined

Works as original option.

flee

Default: false

Should work as original option (but have not tested).

Pathing.moveOffRoad(creep, ?options) / Creep.moveOffRoad(target, ?options)

Will try to move creep off road.

Returns true if creep is not fatigued and is on road. In this case moveOffRoad behavior will be scheduled.

target

Default: undefined

Only available if called via Creep.moveOffRoad.

Target to stay in range with. If no target will just move off road in any direction.

moveOffRoad options

priority

Default: -1000

Creeps with higher priority will be moved first.

moveOffExit

Default: true

If set to true will prefer non-exit tiles.

moveOffContainer

Default: true

Will treat containers as roads.

PathingManager.constructor options

avoidRooms

Default: []

Rooms thats should be excluded from pathfinding. Same as PathingManager.moveTo avoidRooms option but global. In case of both options are set (in PathingManager.moveTo and constructor) array will be concatenated and used both sets of rooms to be excluded.

onRoomEnter(creep, roomName)

Default: undefined

If specified will be called when creep enters a new room (different from previous position). For example can be used for check if hostiles are in the room, or check if need to be added in healCreeps array to be healed by towers.

getCreepWorkingTarget(creep)

Default (in constructor argument): undefined

Note: configuration section contains default implementation of getCreepWorkingTarget. You can change it to preferred one.

Shuold return an object with target info {pos, range, ?priority}. Will be used for push creeps or avoiding obstacles movement to prioritize positions that are in rnage of the target if creep moves towards it or works near it. If priority is not set or undefined will always be pushed if other creep will try to move there. In case of no target to prefer return undefined or false.

getCreepInstance(creep)

Default: (creep) => creep

If you specify this function, you can use creep wrapper object instead of creep GameObject in Pathing.moveTo.

getCreepEntity(instance)

Default: (instance) => instance

Need to provide this function if you specified getCreepInstance(creep), to get wrapper object from creeps that were obtained by room.find.

Wrapper objects

It is possible to use wrapper objects with Pathing.moveTo. It will require it to have properties:

• name - should contain creep's name
• memory - should refer to creep's memory

It is also good if you define _moveTime property initialized with 0 or undefined (but it is not mandatory). The reason is to prevent hidden class change if you will store wrapper object between tick.

Example:

// pathing.js
...
// ============================
// PathingManager configuration

const Pathing = new PathingManager({

	// list of rooms to avoid globally:
	/* avoidRooms: [], */

	// this event will be called every time creep enters new room:
	/* onRoomEnter(creep, roomName) {
		console.log(`Creep ${creep.name} entered room ${roomName}`);
	}, */

	// manager will use this function to make creeps stay in range of their target
	getCreepWorkingTarget(creep) {
		if (creep.target) {
			return {
				pos: creep.target.pos,
				range: creep.targetRange,
				priority: creep.targetPriority,
			};
		}
	},

	// get creep GameObject from creep wrapper object
	getCreepInstance(creep) {
		return creep.instance;
	},

	// get creep wrapper object from creep GameObject
	getCreepEntity(instance) {
		return Creeps.get(instance.name);
	},

});
module.exports = Pathing;


// creeps.js
const Pathing = require('pathing');
const PathingUtils = require('pathing.utils');

const PATH_STYLE = {stroke: '#fff', lineStyle: 'dashed', opacity: 0.5};

global.IN_RANGE = 1;
global.IN_ROOM = 2;

global.Creeps = new Map();

class CreepEntity {

	constructor(creep) {
		this.name = creep.name;
		this.instance = creep;
		tihs._moveTime = 0;

		Creeps.set(this.name, this);
	}
	
	died() {
		// cleanup memory
		Memory.creeps[this.name] = undefined;
		Creeps.delete(this.name);
	}

	load() {
		this.instance = Game.creeps[this.name] || this.died();
	}

	// can override it via class inheritance
	getMoveOptions(options) {
		return options;
	}

	setTarget(target) {
		this.target = target;
	}

	get hasMove() {
		return this._moveTime === Game.time;
	}

	moveTo(target, options) {
		const options = {
			priority: 0,
			range: 1,
			visualizePathStyle: PATH_STYLE,
			...getMoveOptions(defaultOptions)
		};
		this.targetRange = options.range;
		this.targetPriority = options.priority;
		if (
			this.instance.pos.inRangeTo(target, options.range) &&
			(options.moveOffExit === false || !PathingUtils.isPosExit(this.pos))
		) {
			return IN_RANGE;
		}
		return Pathing.moveTo(this, target, options);
	}

	moveToRoom(target, options = {}) {
		const options = {
			priority: 0,
			range: 23,
			visualizePathStyle: PATH_STYLE,
			...getMoveOptions(defaultOptions)
		};
		const targetPos = target.pos || target;
		this.targetRange = options.range;
		this.targetPriority = options.priority;
		if (
			this.instance.room.name === targetPos.roomName &&
			!PathingUtils.isPosExit(this.instance.pos)
		) {
			return IN_ROOM;
		}
		return Pathing.moveTo(this, target, options);
	}

}
module.exports = CreepEntity;


// main.js
const CreepEntity = require('creeps');
const Pathing = require('pathing');

const creep1 = new CreepEntity(Game.creeps['creep1']);
const creep2 = new CreepEntity(Game.creeps['creep2']);

const controller = Game.rooms['E30N30'].controller;

creep1.setTarget({
	pos: controller.pos,
	id: controller.id
});
creep2.setTarget({
 	// structure to repair
	pos: new RoomPosition(15, 23, 'E30N30'),
	id: '5cd9f723e350f83bc9e02d47'
});

module.exports.loop = function() {

	creep1.load();
	if (creep1.moveTo(creep1.target, {range: 3}) === IN_RANGE) {
		creep1.instance.upgradeController(creep1.instance.room.controller);
	}

	creep2.load();
	if (creep2.moveTo(creep2.target, {range: 3, priority: 5}) === IN_RANGE) {
		//                 ^ ----- can skip .pos, because moveTo accepts object
		//                         with .pos RoomPosition property
		const structure = Game.getObjectById(creep2.target.id);
		if (structure) {
			creep1.instance.repair(structure);
		}
	}

	Pathing.runMoves();
}