mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-26 06:05:54 +08:00
add typings for screeps
This commit is contained in:
Adam Laycock
3799
types/screeps/index.d.ts
vendored
Normal file
3799
types/screeps/index.d.ts
vendored
Normal file
File diff suppressed because it is too large
Load Diff
511
types/screeps/screeps-tests.ts
Normal file
511
types/screeps/screeps-tests.ts
Normal file
@@ -0,0 +1,511 @@
|
||||
// This file exists solely to test whether or not the typings actually work.
|
||||
// After working on your changes, make sure to run `npm run compile` to build
|
||||
// the declarations before opening this file.
|
||||
//
|
||||
// If you open this file and see no red squiggly lines, then you're good!
|
||||
// Feel free to add more test cases in the form of a sample code.
|
||||
|
||||
// TODO: add more test cases.
|
||||
|
||||
// Sample inputs
|
||||
|
||||
const creep: Creep = Game.creeps.sampleCreep;
|
||||
const room: Room = Game.rooms.W10S10;
|
||||
const flag: Flag = Game.flags.Flag1;
|
||||
const spawn: StructureSpawn = Game.spawns.Spawn1;
|
||||
const body: BodyPartConstant[] = [WORK, WORK, CARRY, MOVE];
|
||||
|
||||
// Sample inputs for Game.map.findRoute testing
|
||||
const anotherRoomName: Room = Game.rooms.W10S11;
|
||||
|
||||
// Sample memory extensions
|
||||
interface CreepMemory {
|
||||
sourceId: string;
|
||||
lastHits: number;
|
||||
}
|
||||
|
||||
// Game.creeps
|
||||
|
||||
{
|
||||
for (const i in Game.creeps) {
|
||||
Game.creeps[i].moveTo(flag);
|
||||
}
|
||||
}
|
||||
|
||||
// Game.flags
|
||||
|
||||
{
|
||||
creep.moveTo(Game.flags.Flag1);
|
||||
}
|
||||
|
||||
// Game.spawns
|
||||
|
||||
{
|
||||
for (const i in Game.spawns) {
|
||||
Game.spawns[i].createCreep(body);
|
||||
}
|
||||
}
|
||||
|
||||
// Game.time
|
||||
|
||||
{
|
||||
let time = Game.time;
|
||||
time += 1;
|
||||
}
|
||||
|
||||
// Game.cpu.getUsed()
|
||||
|
||||
{
|
||||
if (Game.cpu.getUsed() > Game.cpu.tickLimit / 2) {
|
||||
// Half CPU Usged
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
for (const name in Game.creeps) {
|
||||
const startCpu = Game.cpu.getUsed();
|
||||
|
||||
// creep logic goes here
|
||||
|
||||
const elapsed = Game.cpu.getUsed() - startCpu;
|
||||
}
|
||||
}
|
||||
|
||||
// Game.cpu.setShardLimits()
|
||||
|
||||
{
|
||||
Game.cpu.setShardLimits({ shard0: 20, shard1: 10 });
|
||||
}
|
||||
|
||||
// Game.getObjectById(id)
|
||||
|
||||
{
|
||||
creep.memory.sourceId = creep.pos.findClosestByRange(FIND_SOURCES).id;
|
||||
const source = Game.getObjectById<Source>(creep.memory.sourceId);
|
||||
}
|
||||
|
||||
// Game.notify(message, [groupInterval])
|
||||
|
||||
{
|
||||
if (creep.hits < creep.memory.lastHits) {
|
||||
Game.notify(`Creep ${creep} has been attacked at ${creep.pos}!`);
|
||||
}
|
||||
creep.memory.lastHits = creep.hits;
|
||||
}
|
||||
|
||||
{
|
||||
if (Game.spawns["Spawn1"].energy === 0) {
|
||||
Game.notify(
|
||||
"Spawn1 is out of energy",
|
||||
180 // group these notifications for 3 hours
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Game.map.describeExits()
|
||||
|
||||
{
|
||||
const exits = Game.map.describeExits("W8N3");
|
||||
}
|
||||
|
||||
// Game.map.findExit()
|
||||
|
||||
{
|
||||
if (creep.room !== anotherRoomName) {
|
||||
const exitDir = Game.map.findExit(creep.room, anotherRoomName);
|
||||
const exit = creep.pos.findClosestByRange(exitDir as FindConstant);
|
||||
creep.moveTo(exit);
|
||||
} else {
|
||||
// go to some place in another room
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
creep.moveTo(new RoomPosition(25, 25, anotherRoomName.name));
|
||||
}
|
||||
|
||||
// Game.map.findRoute()
|
||||
|
||||
{
|
||||
const route = Game.map.findRoute(creep.room, anotherRoomName);
|
||||
|
||||
if (route !== ERR_NO_PATH && route.length > 0) {
|
||||
const exit = creep.pos.findClosestByRange(route[0].exit);
|
||||
creep.moveTo(exit);
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
const route = Game.map.findRoute(creep.room, anotherRoomName, {
|
||||
routeCallback(roomName, fromRoomName) {
|
||||
if (roomName === "W10S10") {
|
||||
// avoid this room
|
||||
return Infinity;
|
||||
}
|
||||
return 1;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
{
|
||||
const from = new RoomPosition(25, 25, "E1N1");
|
||||
const to = new RoomPosition(25, 25, "E4N1");
|
||||
|
||||
// Use `findRoute` to calculate a high-level plan for this path,
|
||||
// prioritizing highways and owned rooms
|
||||
const allowedRooms = { [from.roomName]: true };
|
||||
const route = Game.map.findRoute(from.roomName, to.roomName, {
|
||||
routeCallback(roomName) {
|
||||
const parsed = /^[WE]([0-9]+)[NS]([0-9]+)$/.exec(roomName);
|
||||
if (parsed !== null) {
|
||||
const isHighway = (parseInt(parsed[1], 10) % 10 === 0) ||
|
||||
(parseInt(parsed[2], 10) % 10 === 0);
|
||||
const isMyRoom = Game.rooms[roomName] &&
|
||||
Game.rooms[roomName].controller &&
|
||||
Game.rooms[roomName].controller!.my;
|
||||
if (isHighway || isMyRoom) {
|
||||
return 1;
|
||||
} else {
|
||||
return 2.5;
|
||||
}
|
||||
} else {
|
||||
return 2.5;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
if (route !== ERR_NO_PATH) {
|
||||
route.forEach((info) => {
|
||||
allowedRooms[info.room] = true;
|
||||
});
|
||||
}
|
||||
|
||||
// Invoke PathFinder, allowing access only to rooms from `findRoute`
|
||||
const ret = PathFinder.search(from, [to], {
|
||||
roomCallback: (roomName) => {
|
||||
if (allowedRooms[roomName] === undefined) {
|
||||
return false;
|
||||
} else {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Game.map.getRoomLinearDistance(roomName1, roomName2, [continuous])
|
||||
|
||||
{
|
||||
Game.map.getRoomLinearDistance("W1N1", "W4N2"); // 3
|
||||
Game.map.getRoomLinearDistance("E65S55", "W65S55", false); // 131
|
||||
Game.map.getRoomLinearDistance("E65S55", "W65S55", true); // 11
|
||||
}
|
||||
|
||||
// Game.map.getTerrainAt(x, y, roomName)
|
||||
// Game.map.getTerrainAt(pos)
|
||||
|
||||
{
|
||||
Game.map.getTerrainAt(25, 20, "W10N10");
|
||||
}
|
||||
|
||||
{
|
||||
Game.map.getTerrainAt(new RoomPosition(25, 20, "W10N10"));
|
||||
}
|
||||
|
||||
// Game.map.isRoomAvailable(roomName)
|
||||
|
||||
{
|
||||
if (Game.map.isRoomAvailable(room.name)) {
|
||||
creep.moveTo(room.getPositionAt(25, 25)!);
|
||||
}
|
||||
}
|
||||
|
||||
// Game.market
|
||||
|
||||
{
|
||||
// Game.market.calcTransactionCost(amount, roomName1, roomName2)
|
||||
const cost = Game.market.calcTransactionCost(1000, "W0N0", "W10N5");
|
||||
|
||||
// Game.market.cancelOrder(orderId)
|
||||
for (const id in Game.market.orders) {
|
||||
Game.market.cancelOrder(id);
|
||||
}
|
||||
|
||||
// Game.market.changeOrderPrice(orderId, newPrice)
|
||||
Game.market.changeOrderPrice("57bec1bf77f4d17c4c011960", 9.95);
|
||||
|
||||
// Game.market.createOrder(type, resourceType, price, totalAmount, [roomName])
|
||||
Game.market.createOrder(ORDER_SELL, RESOURCE_GHODIUM, 9.95, 10000, "W1N1");
|
||||
|
||||
// Game.market.deal(orderId, amount, [yourRoomName])
|
||||
Game.market.deal("57cd2b12cda69a004ae223a3", 1000, "W1N1");
|
||||
|
||||
const amountToBuy = 2000;
|
||||
const maxTransferEnergyCost = 500;
|
||||
const orders = Game.market.getAllOrders({ type: ORDER_SELL, resourceType: RESOURCE_GHODIUM });
|
||||
|
||||
for (const i of orders) {
|
||||
if (i.roomName) {
|
||||
const transferEnergyCost = Game.market.calcTransactionCost(amountToBuy, "W1N1", i.roomName);
|
||||
|
||||
if (transferEnergyCost < maxTransferEnergyCost) {
|
||||
Game.market.deal(i.id, amountToBuy, "W1N1");
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Game.market.extendOrder(orderId, addAmount)
|
||||
Game.market.extendOrder("57bec1bf77f4d17c4c011960", 10000);
|
||||
|
||||
// Game.market.getAllOrders([filter])
|
||||
Game.market.getAllOrders();
|
||||
Game.market.getAllOrders({ type: ORDER_SELL, resourceType: RESOURCE_GHODIUM });
|
||||
|
||||
const targetRoom = "W1N1";
|
||||
Game.market.getAllOrders((currentOrder) => currentOrder.resourceType === RESOURCE_GHODIUM &&
|
||||
currentOrder.type === ORDER_SELL &&
|
||||
Game.market.calcTransactionCost(1000, targetRoom, currentOrder.roomName!) < 500);
|
||||
|
||||
// Game.market.getOrderById(id)
|
||||
const order = Game.market.getOrderById("55c34a6b5be41a0a6e80c123");
|
||||
}
|
||||
|
||||
// PathFinder
|
||||
|
||||
{
|
||||
const pfCreep = Game.creeps.John;
|
||||
|
||||
const goals = pfCreep.room.find(FIND_SOURCES).map((source) => {
|
||||
// We can't actually walk on sources-- set `range` to 1
|
||||
// so we path next to it.
|
||||
return { pos: source.pos, range: 1 };
|
||||
});
|
||||
|
||||
const ret = PathFinder.search(
|
||||
pfCreep.pos, goals,
|
||||
{
|
||||
// We need to set the defaults costs higher so that we
|
||||
// can set the road cost lower in `roomCallback`
|
||||
plainCost: 2,
|
||||
swampCost: 10,
|
||||
|
||||
roomCallback(roomName) {
|
||||
const curRoom = Game.rooms[roomName];
|
||||
// In this example `room` will always exist, but since
|
||||
// PathFinder supports searches which span multiple rooms
|
||||
// you should be careful!
|
||||
if (!curRoom) {
|
||||
return false;
|
||||
}
|
||||
const costs = new PathFinder.CostMatrix();
|
||||
|
||||
curRoom.find(FIND_STRUCTURES).forEach((struct) => {
|
||||
if (struct.structureType === STRUCTURE_ROAD) {
|
||||
// Favor roads over plain tiles
|
||||
costs.set(struct.pos.x, struct.pos.y, 1);
|
||||
} else if (struct.structureType !== STRUCTURE_CONTAINER &&
|
||||
(struct.structureType !== STRUCTURE_RAMPART ||
|
||||
!(struct as OwnedStructure).my)) {
|
||||
// Can't walk through non-walkable buildings
|
||||
costs.set(struct.pos.x, struct.pos.y, 0xff);
|
||||
}
|
||||
});
|
||||
|
||||
// Avoid creeps in the room
|
||||
curRoom.find(FIND_CREEPS).forEach((thisCreep) => {
|
||||
costs.set(thisCreep.pos.x, thisCreep.pos.y, 0xff);
|
||||
});
|
||||
|
||||
return costs;
|
||||
},
|
||||
}
|
||||
);
|
||||
|
||||
const pos = ret.path[0];
|
||||
pfCreep.move(pfCreep.pos.getDirectionTo(pos));
|
||||
}
|
||||
|
||||
// RawMemory
|
||||
|
||||
{
|
||||
// RawMemory.segments
|
||||
|
||||
RawMemory.setActiveSegments([0, 3]);
|
||||
// on the next tick
|
||||
const segmentZero = RawMemory.segments[0];
|
||||
RawMemory.segments[3] = '{"foo": "bar", "counter": 15}';
|
||||
|
||||
// RawMemory.foreignSegment
|
||||
|
||||
RawMemory.setActiveForeignSegment("player");
|
||||
// on the next tick
|
||||
const playerSegment = RawMemory.foreignSegment;
|
||||
// --> {"username": "player", "id": 40, "data": "Hello!"}
|
||||
|
||||
// RawMemory.interShardSegment
|
||||
|
||||
RawMemory.interShardSegment = JSON.stringify({
|
||||
creeps: {
|
||||
Bob: {role: "claimer"}
|
||||
}
|
||||
});
|
||||
|
||||
// on another shard
|
||||
const interShardData = JSON.parse(RawMemory.interShardSegment);
|
||||
if (interShardData.creeps[creep.name]) {
|
||||
creep.memory = interShardData[creep.name];
|
||||
delete interShardData.creeps[creep.name];
|
||||
}
|
||||
RawMemory.interShardSegment = JSON.stringify(interShardData);
|
||||
|
||||
// RawMemory.get()
|
||||
const myMemory = JSON.parse(RawMemory.get());
|
||||
|
||||
// RawMemory.set(value)
|
||||
RawMemory.set(JSON.stringify(myMemory));
|
||||
|
||||
// RawMemory.setActiveSegments(ids)
|
||||
RawMemory.setActiveSegments([0, 3]);
|
||||
|
||||
// RawMemory.setActiveForeignSegment(username, [id])
|
||||
RawMemory.setActiveForeignSegment("player");
|
||||
RawMemory.setActiveForeignSegment("player", 10);
|
||||
RawMemory.setActiveForeignSegment(null);
|
||||
|
||||
// RawMemory.setDefaultPublicSegment(id)
|
||||
RawMemory.setPublicSegments([5, 20, 21]);
|
||||
RawMemory.setDefaultPublicSegment(5);
|
||||
RawMemory.setDefaultPublicSegment(null);
|
||||
|
||||
// RawMemory.setPublicSegments(ids)
|
||||
RawMemory.setPublicSegments([5, 3]);
|
||||
RawMemory.setPublicSegments([]);
|
||||
}
|
||||
|
||||
// Find Overloads
|
||||
|
||||
{
|
||||
const creeps = room.find(FIND_HOSTILE_CREEPS);
|
||||
creeps[0].say(creeps[1].name);
|
||||
|
||||
const flags = room.find(FIND_FLAGS);
|
||||
flags[0].remove();
|
||||
|
||||
const spawns = room.find(FIND_HOSTILE_SPAWNS);
|
||||
spawns[0].spawning;
|
||||
|
||||
const sources = room.find(FIND_SOURCES);
|
||||
sources[0].ticksToRegeneration;
|
||||
|
||||
const resources = room.find(FIND_DROPPED_RESOURCES);
|
||||
resources[0].resourceType;
|
||||
|
||||
const energy = room.find(FIND_DROPPED_ENERGY);
|
||||
energy[0].resourceType;
|
||||
|
||||
const sites = room.find(FIND_CONSTRUCTION_SITES);
|
||||
sites[0].remove();
|
||||
|
||||
// Should have type (_HasRoomPosition | RoomPosition)[]
|
||||
const exits = room.find(FIND_EXIT);
|
||||
|
||||
const creepsHere = room.lookForAt(LOOK_CREEPS, 10, 10);
|
||||
creepsHere[0]!.getActiveBodyparts(ATTACK);
|
||||
|
||||
const towers = room.find<StructureTower>(FIND_MY_STRUCTURES, {
|
||||
filter: (structure) => {
|
||||
return (structure.structureType === STRUCTURE_TOWER);
|
||||
}
|
||||
});
|
||||
towers[0].attack(creeps[0]);
|
||||
}
|
||||
|
||||
// RoomPosition Finds
|
||||
|
||||
{
|
||||
// Should have type Creep
|
||||
const hostileCreep = creep.pos.findClosestByRange(FIND_HOSTILE_CREEPS);
|
||||
|
||||
creep.say(hostileCreep.name);
|
||||
|
||||
const tower = creep.pos.findClosestByPath<StructureTower>(FIND_HOSTILE_STRUCTURES, {
|
||||
filter: (structure) => {
|
||||
return structure.structureType === STRUCTURE_TOWER;
|
||||
}
|
||||
});
|
||||
|
||||
tower.attack(creep);
|
||||
|
||||
const rampart = creep.pos.findClosestByRange<StructureRampart>(FIND_HOSTILE_STRUCTURES, {
|
||||
filter: (structure) => {
|
||||
return structure.structureType === STRUCTURE_RAMPART;
|
||||
}
|
||||
});
|
||||
|
||||
rampart.isPublic;
|
||||
|
||||
// Should have type Creep[]
|
||||
const hostileCreeps = creep.pos.findInRange(FIND_HOSTILE_CREEPS, 10);
|
||||
hostileCreeps[0].saying;
|
||||
|
||||
const labs = creep.pos.findInRange<StructureLab>(FIND_MY_STRUCTURES, 4, {
|
||||
filter: (structure) => {
|
||||
return structure.structureType === STRUCTURE_LAB;
|
||||
}
|
||||
});
|
||||
|
||||
labs[0].boostCreep(creep);
|
||||
}
|
||||
|
||||
// LookAt Finds
|
||||
|
||||
{
|
||||
const nukes = room.lookForAt(LOOK_NUKES, creep.pos);
|
||||
|
||||
nukes[0]!.launchRoomName;
|
||||
|
||||
const flags = room.lookForAtArea(LOOK_FLAGS, 10, 10, 20, 20);
|
||||
|
||||
const x = flags[10];
|
||||
const y = x[11];
|
||||
const entry = y[0];
|
||||
entry.flag!.remove();
|
||||
|
||||
const creeps = room.lookForAtArea(LOOK_CREEPS, 10, 10, 20, 20, true);
|
||||
|
||||
creeps[0].x;
|
||||
creeps[0].y;
|
||||
creeps[0].creep!.move(TOP);
|
||||
}
|
||||
|
||||
// Advanced Structure types
|
||||
{
|
||||
const owned = Game.getObjectById<AnyOwnedStructure>("blah");
|
||||
const owner = owned!.owner.username;
|
||||
owned!.notifyWhenAttacked(false);
|
||||
|
||||
const unowned = Game.getObjectById<AnyStructure>("blah2")!;
|
||||
const hp = unowned.hits / unowned.hitsMax;
|
||||
|
||||
// test discriminated union
|
||||
switch (unowned.structureType) {
|
||||
case STRUCTURE_TOWER:
|
||||
unowned.heal(Game.creeps.myCreep);
|
||||
break;
|
||||
case STRUCTURE_CONTAINER:
|
||||
case STRUCTURE_STORAGE:
|
||||
case STRUCTURE_TERMINAL:
|
||||
const energyPercent = unowned.store.energy / unowned.storeCapacity;
|
||||
break;
|
||||
case STRUCTURE_WALL:
|
||||
case STRUCTURE_RAMPART:
|
||||
const wallHp = unowned.hits / unowned.hitsMax;
|
||||
break;
|
||||
}
|
||||
|
||||
// test discriminated union using filter functions on find
|
||||
const from = Game.rooms.myRoom.find(FIND_STRUCTURES, (s) => (s.structureType === STRUCTURE_CONTAINER || s.structureType === STRUCTURE_STORAGE) && s.store.energy > 0)[0];
|
||||
const to = from.pos.findClosestByPath(FIND_MY_STRUCTURES, {filter: (s) => (s.structureType === STRUCTURE_SPAWN || s.structureType === STRUCTURE_EXTENSION) && s.energy < s.energyCapacity});
|
||||
|
||||
Game.rooms.myRoom.find(FIND_MY_STRUCTURES, (s) => s.structureType === STRUCTURE_RAMPART).forEach((r) => r.notifyWhenAttacked(false));
|
||||
}
|
||||
24
types/screeps/tsconfig.json
Normal file
24
types/screeps/tsconfig.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"strictFunctionTypes": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"screeps-tests.ts"
|
||||
]
|
||||
}
|
||||
|
||||
12
types/screeps/tslint.json
Normal file
12
types/screeps/tslint.json
Normal file
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json",
|
||||
"rules": {
|
||||
"no-redundant-jsdoc-2": false,
|
||||
"dt-header": false,
|
||||
"no-empty-interface": false,
|
||||
"no-unnecessary-generics": false,
|
||||
"no-misused-new": false,
|
||||
"no-any-union": false,
|
||||
"no-redundant-undefined": false
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user