Screeps API

https://docs.screeps.com/api
Admin
Screeps API provides a comprehensive reference for the objects, properties, and methods available...
Tokens:101,020
Snippets:873
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example Market Orders Output

Source: https://docs.screeps.com/api

An example of the structure of the orders array returned by Game.market.getAllOrders().

```json
[
    {
        id : "55c34a6b5be41a0a6e80c68b",
        created : 13131117,
        type : "sell",
        resourceType : "OH",
        roomName : "W1N1",
        amount : 15821,
        remainingAmount : 30000,
        price : 2.95
    }, {
        createdTimestamp: 1543253147522,
        type: "sell",
        amount: 1000,
        remainingAmount: 1000,
        resourceType: "O",
        price: 1,
        roomName: "E2S7",
        created: 12010056,
        id: "5bfc2c9bd719fb605037c06d"
    }, {
        id : "55c34a6b5be41a0a6e80c123",
        createdTimestamp: 1543253155580,
        type : "sell",
        resourceType : "token",
        amount : 3,
        remainingAmount : 10,
        price : 50000
    }
]
```

--------------------------------

### Resource Components Example

Source: https://docs.screeps.com/api

Illustrates the structure of resource components, showing the required materials and energy for crafting.

```javascript
{
                [exports.RESOURCE_UTRIUM_BAR]: 20,
                [exports.RESOURCE_ZYNTHIUM_BAR]: 20,
                [exports.RESOURCE_ENERGY]: 20
            }
```

```javascript
{
                [exports.RESOURCE_LEMERGIUM_BAR]: 6,
                [exports.RESOURCE_KEANIUM_BAR]: 6,
                [exports.RESOURCE_PURIFIER]: 6,
                [exports.RESOURCE_ENERGY]: 45
            }
```

```javascript
{
                [exports.RESOURCE_OXIDANT]: 12,
                [exports.RESOURCE_REDUCTANT]: 12,
                [exports.RESOURCE_GHODIUM_MELT]: 12,
                [exports.RESOURCE_ENERGY]: 90
            }
```

```javascript
{
                [exports.RESOURCE_UTRIUM_BAR]: 20,
                [exports.RESOURCE_SILICON]: 100,
                [exports.RESOURCE_ENERGY]: 40
            }
```

```javascript
{
                [exports.RESOURCE_WIRE]: 40,
                [exports.RESOURCE_OXIDANT]: 95,
                [exports.RESOURCE_UTRIUM_BAR]: 35,
                [exports.RESOURCE_ENERGY]: 20
            }
```

```javascript
{
                [exports.RESOURCE_SWITCH]: 4,
                [exports.RESOURCE_WIRE]: 15,
                [exports.RESOURCE_REDUCTANT]: 85,
                [exports.RESOURCE_ENERGY]: 8
            }
```

```javascript
{
                [exports.RESOURCE_TRANSISTOR]: 2,
                [exports.RESOURCE_COMPOSITE]: 50,
                [exports.RESOURCE_WIRE]: 117,
                [exports.RESOURCE_PURIFIER]: 25,
                [exports.RESOURCE_ENERGY]: 16
            }
```

```javascript
{
                [exports.RESOURCE_MICROCHIP]: 1,
                [exports.RESOURCE_TRANSISTOR]: 5,
                [exports.RESOURCE_SWITCH]: 4,
                [exports.RESOURCE_OXIDANT]: 115,
                [exports.RESOURCE_ENERGY]: 32
            }
```

```javascript
{
                [exports.RESOURCE_CIRCUIT]: 1,
                [exports.RESOURCE_MICROCHIP]: 3,
                [exports.RESOURCE_CRYSTAL]: 110,
                [exports.RESOURCE_GHODIUM_MELT]: 150,
                [exports.RESOURCE_ENERGY]: 64
            }
```

```javascript
{
                [exports.RESOURCE_LEMERGIUM_BAR]: 20,
                [exports.RESOURCE_BIOMASS]: 100,
                [exports.RESOURCE_ENERGY]: 40
            }
```

```javascript
{
                [exports.RESOURCE_CELL]: 20,
                [exports.RESOURCE_OXIDANT]: 36,
                [exports.RESOURCE_LEMERGIUM_BAR]: 16,
                [exports.RESOURCE_ENERGY]: 8
            }
```

```javascript
{
                [exports.RESOURCE_PHLEGM]: 10,
                [exports.RESOURCE_CELL]: 10,
                [exports.RESOURCE_REDUCTANT]: 110,
                [exports.RESOURCE_ENERGY]: 16
            }
```

```javascript
{
                [exports.RESOURCE_TISSUE]: 3,
                [exports.RESOURCE_PHLEGM]: 3,
                [exports.RESOURCE_ZYNTHIUM_BAR]: 50,
                [exports.RESOURCE_REDUCTANT]: 50,
                [exports.RESOURCE_ENERGY]: 16
            }
```

```javascript
{
                [exports.RESOURCE_MUSCLE]: 1,
                [exports.RESOURCE_TISSUE]: 5,
                [exports.RESOURCE_PURIFIER]: 208,
                [exports.RESOURCE_OXIDANT]: 256,
                [exports.RESOURCE_ENERGY]: 32
            }
```

--------------------------------

### Incoming Transactions Structure

Source: https://docs.screeps.com/api

An example of the data structure for incoming market transactions.

```javascript
[
    {
        transactionId : "56dec546a180ce641dd65960",
        time : 10390687,
        sender : {username: "Sender"},
        recipient : {username: "Me"},
        resourceType : "U",
        amount : 100,
        from : "W0N0",
        to : "W10N10",
        description : "trade contract #1",
        order: {        // optional
            id : "55c34a6b5be41a0a6e80c68b",
            type : "sell",
            price : 2.95
        }
    }
]
```

--------------------------------

### Flag: Set Position Example (RoomPosition Object)

Source: https://docs.screeps.com/api

Sets a new position for a flag using a RoomPosition object.

```javascript
Game.flags.Flag1.setPosition( new RoomPosition(10, 20, 'W3S5') );
```

--------------------------------

### Store Methods

Source: https://docs.screeps.com/api

Documentation for the Store prototype, including methods to get capacity, free capacity, and used capacity for resources.

```APIDOC
## Store
An object that can contain resources in its cargo.

## getCapacity([resource])
Returns capacity of this store for the specified resource. For a general purpose store, it returns total capacity if `resource` is undefined.

### Parameters
* `resource` (string, optional) - The type of the resource.
### Return value
Returns capacity number, or `null` in case of an invalid `resource` for this store type.

## getFreeCapacity([resource])
Returns free capacity for the store. For a limited store, it returns the capacity available for the specified resource if `resource` is defined and valid for this store.

### Parameters
* `resource` (string, optional) - The type of the resource.
### Return value
Returns available capacity number, or `null` in case of an invalid `resource` for this store type.

## getUsedCapacity([resource])
Returns the capacity used by the specified resource. For a general purpose store, it returns total used capacity if `resource` is undefined.

### Parameters
* `resource` (string, optional) - The type of the resource.
### Return value
Returns used capacity number, or `null` in case of a not valid `resource` for this store type.
```

--------------------------------

### Flag: Set Position Example (Coordinates)

Source: https://docs.screeps.com/api

Sets a new position for a flag using X and Y coordinates within the room.

```javascript
Game.flags.Flag1.setPosition(10,20);
```

--------------------------------

### Use Power

Source: https://docs.screeps.com/api

Example of a power creep using a specific power. Ensure the power is valid and the creep has the necessary conditions.

```javascript
Game.powerCreeps['PowerCreep1'].usePower(PWR_GENERATE_OPS);
```

--------------------------------

### Resource Components Example

Source: https://docs.screeps.com/api

Illustrates the structure for defining resource components and their properties, such as amount, cooldown, and constituent parts. This is useful for understanding how complex resources are synthesized in-game.

```javascript
components: {
                [exports.RESOURCE_ORGANOID]: 1,
                [exports.RESOURCE_LIQUID]: 150,
                [exports.RESOURCE_TISSUE]: 6,
                [exports.RESOURCE_CELL]: 310,
                [exports.RESOURCE_ENERGY]: 64
            }
        },

        [exports.RESOURCE_ALLOY]: {
            amount: 20,
            cooldown: 8,
            components: {
                [exports.RESOURCE_ZYNTHIUM_BAR]: 20,
                [exports.RESOURCE_METAL]: 100,
                [exports.RESOURCE_ENERGY]: 40
            }
        },
        [exports.RESOURCE_TUBE]: {
            level: 1,
            amount: 2,
            cooldown: 45,
            components: {
                [exports.RESOURCE_ALLOY]: 40,
                [exports.RESOURCE_ZYNTHIUM_BAR]: 16,
                [exports.RESOURCE_ENERGY]: 8
            }
        },
        [exports.RESOURCE_FIXTURES]: {
            level: 2,
            amount: 1,
            cooldown: 115,
            components: {
                [exports.RESOURCE_COMPOSITE]: 20,
                [exports.RESOURCE_ALLOY]: 41,
                [exports.RESOURCE_OXIDANT]: 161,
                [exports.RESOURCE_ENERGY]: 8
            }
        },
        [exports.RESOURCE_FRAME]: {
            level: 3,
            amount: 1,
            cooldown: 125,
            components: {
                [exports.RESOURCE_FIXTURES]: 2,
                [exports.RESOURCE_TUBE]: 4,
                [exports.RESOURCE_REDUCTANT]: 330,
                [exports.RESOURCE_ZYNTHIUM_BAR]: 31,
                [exports.RESOURCE_ENERGY]: 16
            }
        },
        [exports.RESOURCE_HYDRAULICS]: {
            level: 4,
            amount: 1,
            cooldown: 800,
            components: {
                [exports.RESOURCE_LIQUID]: 150,
                [exports.RESOURCE_FIXTURES]: 3,
                [exports.RESOURCE_TUBE]: 15,
                [exports.RESOURCE_PURIFIER]: 208,
                [exports.RESOURCE_ENERGY]: 32
            }
        },
        [exports.RESOURCE_MACHINE]: {
            level: 5,
            amount: 1,
            cooldown: 600,
            components: {
                [exports.RESOURCE_HYDRAULICS]: 1,
                [exports.RESOURCE_FRAME]: 2,
                [exports.RESOURCE_FIXTURES]: 3,
                [exports.RESOURCE_TUBE]: 12,
                [exports.RESOURCE_ENERGY]: 64
            }
        },

        [exports.RESOURCE_CONDENSATE]: {
            amount: 20,
            cooldown: 8,
            components: {
                [exports.RESOURCE_KEANIUM_BAR]: 20,
                [exports.RESOURCE_MIST]: 100,
                [exports.RESOURCE_ENERGY]: 40
            }
        },
        [exports.RESOURCE_CONCENTRATE]: {
            level: 1,
            amount: 3,
            cooldown: 41,
            components: {
                [exports.RESOURCE_CONDENSATE]: 30,
                [exports.RESOURCE_KEANIUM_BAR]: 15,
                [exports.RESOURCE_REDUCTANT]: 54,
                [exports.RESOURCE_ENERGY]: 12
            }
        },
        [exports.RESOURCE_EXTRACT]: {
            level: 2,
            amount: 2,
            cooldown: 128,
            components: {
                [exports.RESOURCE_CONCENTRATE]: 10,
                [exports.RESOURCE_CONDENSATE]: 30,
                [exports.RESOURCE_OXIDANT]: 60,
                [exports.RESOURCE_ENERGY]: 16
            }
        },
        [exports.RESOURCE_SPIRIT]: {
            level: 3,
            amount: 1,
            cooldown: 200,
            components: {
                [exports.RESOURCE_EXTRACT]: 2,
                [exports.RESOURCE_CONCENTRATE]: 6,
                [exports.RESOURCE_REDUCTANT]: 90,
                [exports.RESOURCE_PURIFIER]: 20,
                [exports.RESOURCE_ENERGY]: 16
            }
        },
        [exports.RESOURCE_EMANATION]: {
            level: 4,
            amount: 1,
            cooldown: 800,
            components: {
                [exports.RESOURCE_SPIRIT]: 2,
                [exports.RESOURCE_EXTRACT]: 2,
                [exports.RESOURCE_CONCENTRATE]: 3,
                [exports.RESOURCE_KEANIUM_BAR]: 112,
                [exports.RESOURCE_ENERGY]: 32
            }
        },
        [exports.RESOURCE_ESSENCE]: {
            level: 5,
            amount: 1,
            cooldown: 600,
            components: {
                [exports.RESOURCE_EMANATION]: 1,
                [exports.RESOURCE_SPIRIT]: 3,
                [exports.RESOURCE_CRYSTAL]: 110,
                [exports.RESOURCE_GHODIUM_MELT]: 150,
                [exports.RESOURCE_ENERGY]: 64
            }
        },
    }
});
```

--------------------------------

### Flag: Set Color Example

Source: https://docs.screeps.com/api

Sets the primary and secondary colors of a flag. Ensure the color constants are valid.

```javascript
Game.flags.Flag1.setColor(COLOR_GREEN, COLOR_WHITE);
```

--------------------------------

### Market Orders Structure

Source: https://docs.screeps.com/api

An example of the object structure containing market buy/sell orders.

```json
{
    "55c34a6b5be41a0a6e80c68b": {
        id : "55c34a6b5be41a0a6e80c68b",
        created : 13131117,
        active: true,
        type : "sell"
        resourceType : "OH",
        roomName : "W1N1",
        amount : 15821,
        remainingAmount : 30000,
        totalAmount : 50000,
        price : 2.95
    },
    "55c34a6b52411a0a6e80693a": {
        id : "55c34a6b52411a0a6e80693a",
        created : 13134122,
        active: true,
        type : "buy"
        resourceType : "energy",
        roomName : "W1N1",
        amount : 94000,
        remainingAmount : 94000,
        totalAmount : 94000
        price : 0.45
    },
    "55c34a6b5be41a0a6e80c123": {
        id : "55c34a6b5be41a0a6e80c123",
        created : 13105123,
        active: false,
        type : "sell"
        resourceType : "token",
        amount : 0,
        remainingAmount : 10,
        totalAmount : 10,
        price : 50000
    }
}
```

--------------------------------

### createCreep

Source: https://docs.screeps.com/api

Deprecated method to start the creep spawning process. It takes the creep's body, an optional name, and optional memory. The required energy is withdrawn from all spawns and extensions in the room. This method will be removed soon; use `StructureSpawn.spawnCreep` instead.

```APIDOC
## createCreep(body, [name], [memory])

### Description
Deprecated method to start the creep spawning process. It takes the creep's body, an optional name, and optional memory. The required energy is withdrawn from all spawns and extensions in the room. This method will be removed soon; use `StructureSpawn.spawnCreep` instead.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **body** (array<string>) - Required - An array describing the new creep’s body. Should contain 1 to 50 elements with one of the following constants: `WORK`, `MOVE`, `CARRY`, `ATTACK`, `RANGED_ATTACK`, `HEAL`, `TOUGH`, `CLAIM`.
- **name** (string) - Optional - The name of a new creep. The name length limit is 100 characters. It should be a unique creep name. If not defined, a random name will be generated.
- **memory** (any) - Optional - The memory of a new creep. If provided, it will be immediately stored into `Memory.creeps[name]`.

### Request Example
```javascript
Game.spawns['Spawn1'].createCreep([WORK, CARRY, MOVE], 'Worker1');
Game.spawns['Spawn1'].createCreep([WORK, CARRY, MOVE], null, {role: 'harvester'});
const result = Game.spawns['Spawn1'].createCreep([WORK, CARRY, MOVE]);

if(_.isString(result)) {
    console.log('The name is: '+result);
}
else {
    console.log('Spawn error: '+result);
}
```

### Response
#### Success Response
The name of a new creep.

#### Error Response
One of the following error codes:
- **ERR_NOT_OWNER** (-1): You are not the owner of this spawn.
- **ERR_NAME_EXISTS** (-3): There is a creep with the same name already.
- **ERR_BUSY** (-4): The spawn is already in process of spawning another creep.
- **ERR_NOT_ENOUGH_ENERGY** (-6): The spawn and its extensions contain not enough energy to create a creep with the given body.
- **ERR_INVALID_ARGS** (-10): Body is not properly described.
- **ERR_RCL_NOT_ENOUGH** (-14): Your Room Controller level is insufficient to use this spawn.
```

--------------------------------

### spawnCreep

Source: https://docs.screeps.com/api

Starts the creep spawning process. The required energy amount can be withdrawn from all spawns and extensions in the room. This method takes the creep's body, name, and optional options.

```APIDOC
## spawnCreep(body, name, [opts])

### Description
Starts the creep spawning process. The required energy amount can be withdrawn from all spawns and extensions in the room. This method takes the creep's body, name, and optional options.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **body** (array<string>) - Required - An array describing the new creep’s body. Should contain 1 to 50 elements with one of the following constants: `WORK`, `MOVE`, `CARRY`, `ATTACK`, `RANGED_ATTACK`, `HEAL`, `TOUGH`, `CLAIM`.
- **name** (string) - Required - The name of a new creep. The name length limit is 100 characters. It must be a unique creep name.
- **opts** (object) - Optional - An object with additional options for the spawning process:
  - **memory** (any): Memory of the new creep. If provided, it will be immediately stored into `Memory.creeps[name]`.
  - **energyStructures** (array): Array of spawns/extensions from which to draw energy. Structures will be used according to the array order.
  - **dryRun** (boolean): If `dryRun` is true, the operation will only check if it is possible to create a creep.
  - **directions** (array): Set desired directions where the creep should move when spawned. An array with the direction constants: `TOP`, `TOP_RIGHT`, `RIGHT`, `BOTTOM_RIGHT`, `BOTTOM`, `BOTTOM_LEFT`, `LEFT`, `TOP_LEFT`.

### Request Example
```javascript
Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 'Worker1');
Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 'Worker1', { memory: {role: 'harvester'} });
Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 'Worker1', {
    energyStructures: [
        Game.spawns['Spawn1'], 
        Game.getObjectById('anExtensionId')
    ]
});
var testIfCanSpawn = Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 'Worker1', { dryRun: true });
```

### Response
#### Success Response (0)
- **OK** (0) - The operation has been scheduled successfully.

#### Error Response
One of the following codes:
- **ERR_NOT_OWNER** (-1): You are not the owner of this spawn.
- **ERR_NAME_EXISTS** (-3): There is a creep with the same name already.
- **ERR_BUSY** (-4): The spawn is already in process of spawning another creep.
- **ERR_NOT_ENOUGH_ENERGY** (-6): The spawn and its extensions contain not enough energy to create a creep with the given body.
- **ERR_INVALID_ARGS** (-10): Body is not properly described or name was not provided.
- **ERR_RCL_NOT_ENOUGH** (-14): Your Room Controller level is insufficient to use this spawn.
```

--------------------------------

### Pathfinding with Cost Callback

Source: https://docs.screeps.com/api

Finds a path while customizing costs for specific locations using a costCallback function. This example sets an alternative creep's location as walkable and a flag's location as an obstacle.

```javascript
PathFinder.use(true);
const path = creep.room.findPath(creep.pos, targetPos, {
    costCallback: function(roomName, costMatrix) {
        if(roomName == 'W1N5') {
            // set anotherCreeps location as walkable
            costMatrix.set(anotherCreep.pos.x, anotherCreep.pos.y, 0);
            // set flag location as an obstacle
            costMatrix.set(flag.pos.x, flag.pos.y, 255);
            // increase cost for (25,20) location to 50
            costMatrix.set(25, 20, 50);
        }
    }
});
```

--------------------------------

### Get Terrain at Position (Deprecated)

Source: https://docs.screeps.com/api

Deprecated method to get terrain type at specified room coordinates. Use Game.map.getRoomTerrain instead.

```javascript
console.log(Game.map.getTerrainAt(25,20,'W10N10'));
```

```javascript
console.log(Game.map.getTerrainAt(new RoomPosition(25,20,'W10N10'));
```

--------------------------------

### RawMemory.get()

Source: https://docs.screeps.com/api

Get a raw string representation of the Memory object.

```APIDOC
## RawMemory.get()

### Description
Get a raw string representation of the `Memory` object.

### Return value
Returns a string value.

### Request Example
```javascript
const myMemory = JSON.parse(RawMemory.get());
```
```

--------------------------------

### Find Optimal Path with Custom Costs

Source: https://docs.screeps.com/api

Demonstrates finding a path for a creep to reach one of multiple sources, with custom costs for roads, swamps, and avoiding structures and other creeps. Uses a roomCallback to generate a CostMatrix.

```javascript
  let creep = Game.creeps.John;

  let goals = _.map(creep.room.find(FIND_SOURCES), function(source) {
    // We can't actually walk on sources-- set `range` to 1 
    // so we path next to it.
    return { pos: source.pos, range: 1 };
  });

  let ret = PathFinder.search(
    creep.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: function(roomName) {

        let room = Game.rooms[roomName];
        // In this example `room` will always exist, but since 
        // PathFinder supports searches which span multiple rooms 
        // you should be careful!
        if (!room) return;
        let costs = new PathFinder.CostMatrix;

        room.find(FIND_STRUCTURES).forEach(function(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.my)) {
            // Can't walk through non-walkable buildings
            costs.set(struct.pos.x, struct.pos.y, 0xff);
          }
        });

        // Avoid creeps in the room
        room.find(FIND_CREEPS).forEach(function(creep) {
          costs.set(creep.pos.x, creep.pos.y, 0xff);
        });

        return costs;
      },
    }
  );

  let pos = ret.path[0];
  creep.move(creep.pos.getDirectionTo(pos));
```

--------------------------------

### Game.time

Source: https://docs.screeps.com/api

Get the current system game tick counter.

```APIDOC
## Game.time

System game tick counter. It is automatically incremented on every tick. Learn more
```
console.log(Game.time);
```
```

--------------------------------

### Outgoing Transactions Structure

Source: https://docs.screeps.com/api

An example of the data structure for outgoing market transactions.

```javascript
[
    {
        transactionId : "56dec546a180ce641dd65960",
        time : 10390687,
        sender : {username: "Me"},
        recipient : {username: "Recipient"},
        resourceType : "U",
        amount : 100,
        from : "W0N0",
        to : "W10N10",
        description : "trade contract #1",
        order: {        // optional
            id : "55c34a6b5be41a0a6e80c68b",
            type : "sell",
            price : 2.95
        }
    }
]
```

--------------------------------

### delete

Source: https://docs.screeps.com/api

Deletes a power creep permanently from your account. A 24-hour deletion timer is started, which can be cancelled.

```APIDOC
## delete([cancel])

### Description
Delete the power creep permanently from your account. It should NOT be spawned in the world. The creep is not deleted immediately, but a 24-hours delete timer is started instead (see `deleteTime`). You can cancel deletion by calling `delete(true)`.

### Method
`delete`

### Parameters
#### Path Parameters
- **cancel** (boolean) - Optional - Set this to true to cancel previously scheduled deletion.

### Return value
- **OK** (0) - The operation has been scheduled successfully.
- **ERR_NOT_OWNER** (-1) - You are not the owner of the creep.
- **ERR_BUSY** (-4) - The power creep is spawned in the world.
```

--------------------------------

### Execute a Deal to Buy Gходium

Source: https://docs.screeps.com/api

This snippet demonstrates how to execute a deal to buy a specific amount of a resource. It first finds available sell orders and checks the transaction cost before attempting the deal. A maximum of 10 deals can be executed per tick.

```javascript
Game.market.deal('57cd2b12cda69a004ae223a3', 1000, "W1N1");
```

```javascript
const amountToBuy = 2000, maxTransferEnergyCost = 500;
const orders = Game.market.getAllOrders({type: ORDER_SELL, resourceType: RESOURCE_GHODIUM});

for(let i=0; i<orders.length; i++) {
    const transferEnergyCost = Game.market.calcTransactionCost(
        amountToBuy, 'W1N1', orders[i].roomName);

    if(transferEnergyCost < maxTransferEnergyCost) {
        Game.market.deal(orders[i].id, amountToBuy, "W1N1");
        break;
    }
}
```

--------------------------------

### Get Market Order by ID

Source: https://docs.screeps.com/api

Retrieves information for a specific market order using its unique ID.

```javascript
const order = Game.market.getOrderById('55c34a6b5be41a0a6e80c123');
```

--------------------------------

### RoomVisual constructor

Source: https://docs.screeps.com/api

Initializes a RoomVisual object for drawing debug information in a specified room. Visuals are temporary and only visible for the current tick.

```APIDOC
## constructor([roomName])

### Description
You can directly create new `RoomVisual` object in any room, even if it's invisible to your script.

### Parameters
#### Path Parameters
- **roomName** (string) - Optional - The room name. If undefined, visuals will be posted to all rooms simultaneously.
```

--------------------------------

### Game.cpu.generatePixel()

Source: https://docs.screeps.com/api

Generates 1 pixel resource unit for 10000 CPU from your bucket.

```APIDOC
## Game.cpu.generatePixel()

### Description
Generate 1 pixel resource unit for 10000 CPU from your bucket.

### Return value
One of the following codes: 
```
constant| value| description  
---|---|---
`OK`| 0| The operation has been scheduled successfully.  
`ERR_NOT_ENOUGH_RESOURCES`| -6| Your bucket does not have enough CPU.  
```
```

--------------------------------

### Get Raw Memory String

Source: https://docs.screeps.com/api

Retrieves the entire Memory object as a raw string. This is useful for custom serialization.

```javascript
const myMemory = JSON.parse(RawMemory.get());
```

--------------------------------

### Populate CostMatrix with Terrain Costs

Source: https://docs.screeps.com/api

Initializes a PathFinder.CostMatrix with default costs based on terrain type (plain, swamp, wall) for a given room. Visualizes the weights on a RoomVisual.

```javascript
const roomName = "E2S7";
const terrain = new Room.Terrain(roomName);
const matrix = new PathFinder.CostMatrix;
const visual = new RoomVisual(roomName);

// Fill CostMatrix with default terrain costs for future analysis:
for(let y = 0; y < 50; y++) {
    for(let x = 0; x < 50; x++) {
        const tile = terrain.get(x, y);
        const weight =
            tile === TERRAIN_MASK_WALL  ? 255 : // wall  => unwalkable
            tile === TERRAIN_MASK_SWAMP ?   5 : // swamp => weight:  5
                                            1 ; // plain => weight:  1
        matrix.set(x, y, weight);
        visual.text(weight, x, y);
    }
}
```

--------------------------------

### Dry Run Spawn Creep

Source: https://docs.screeps.com/api

Checks if a creep can be spawned without actually starting the process. Useful for validation.

```javascript
var testIfCanSpawn = Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 
    'Worker1', { dryRun: true });
```

--------------------------------

### Create Global RoomVisuals

Source: https://docs.screeps.com/api

Create a `RoomVisual` object without a room name to display text in all rooms. This is useful for global debug messages.

```javascript
// this text will be displayed in all rooms
new RoomVisual().text('Some text', 1, 1, {align: 'left'});
```

--------------------------------

### Game.resources

Source: https://docs.screeps.com/api

Access your global resources, such as pixels and CPU unlocks. Values are resource amounts.

```APIDOC
## Game.resources

An object with your global resources that are bound to the account, like pixels or cpu unlocks. Each object key is a resource constant, values are resources amounts.
```

--------------------------------

### Create Construction Site for Spawn

Source: https://docs.screeps.com/api

Use the position of a flag to create a construction site for a spawn with a specified name. Ensure room controller level is sufficient and player has not exceeded the maximum number of construction sites.

```javascript
Game.flags['Flag1'].pos.createConstructionSite(STRUCTURE_SPAWN, 'MySpawn2');
```

--------------------------------

### Get Direction to Target

Source: https://docs.screeps.com/api

Determines the linear direction from the current position to a target position. Useful for simple movement commands.

```javascript
const direction = creep.pos.getDirectionTo(target);
creep.move(direction);
```

--------------------------------

### PowerCreep.create

Source: https://docs.screeps.com/api

Creates a new Power Creep instance associated with your account. The creep is initially unspawned and requires the `spawn` method to be placed in the world.

```APIDOC
## PowerCreep.create(name, className)

### Description
A static method to create new Power Creep instance in your account. It will be added in an unspawned state, use `spawn` method to spawn it in the world. You need one free Power Level in your account to perform this action.

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the new power creep. The name length limit is 100 characters.
- **className** (string) - Required - The class of the new power creep, one of the `POWER_CLASS` constants.

### Return value
One of the following codes:
- OK (0): The operation has been scheduled successfully.
- ERR_NAME_EXISTS (-3): A power creep with the specified name already exists.
- ERR_NOT_ENOUGH_RESOURCES (-6): You don't have free Power Levels in your account.
- ERR_INVALID_ARGS (-10): The provided power creep name is exceeds the limit, or the power creep class is invalid.

### Example
```
PowerCreep.create('PowerCreep1', POWER_CLASS.OPERATOR);
```
```

--------------------------------

### Game.spawns

Source: https://docs.screeps.com/api

Access all your spawns. The keys are the spawn names.

```APIDOC
## Game.spawns

A hash containing all your spawns with spawn names as hash keys.
```
for(const i in Game.spawns) {
    Game.spawns[i].createCreep(body);
}
```
```

--------------------------------

### getSize()

Source: https://docs.screeps.com/api

Gets the stored size of all visuals added on the map in the current tick. The size must not exceed 1024,000 bytes.

```APIDOC
## getSize()

### Description
Get the stored size of all visuals added on the map in the current tick. It must not exceed 1024,000 (1000 KB).

### Return value
The size of the visuals in bytes.
```

--------------------------------

### Game.cpu.getUsed()

Source: https://docs.screeps.com/api

Gets the amount of CPU time used from the beginning of the current game tick. Returns 0 in Simulation mode.

```APIDOC
## Game.cpu.getUsed()

### Description
Get amount of CPU time used from the beginning of the current game tick. Always returns 0 in the Simulation mode.

### Return value
Returns currently used CPU time as a float number.
```

--------------------------------

### findPath(fromPos, toPos, [opts])

Source: https://docs.screeps.com/api

Finds an optimal path within a room between two positions using the Jump Point Search algorithm. It allows for various options to customize pathfinding behavior, such as ignoring creeps, destructible structures, or roads, and provides a cost callback for advanced matrix manipulation.

```APIDOC
## findPath(fromPos, toPos, [opts])

### Description
Finds an optimal path within a room between two positions using the Jump Point Search algorithm. It allows for various options to customize pathfinding behavior, such as ignoring creeps, destructible structures, or roads, and provides a cost callback for advanced matrix manipulation.

### Method
Not explicitly defined, but implied to be a method of `Room` or accessible via `PathFinder`.

### Endpoint
Not applicable (in-game API method).

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Parameters
- **fromPos** (RoomPosition) - Required - The start position.
- **toPos** (RoomPosition) - Required - The end position.
- **opts** (object) - Optional - An object containing additional pathfinding flags:
  - **ignoreCreeps** (boolean) - Treat squares with creeps as walkable. Default is false.
  - **ignoreDestructibleStructures** (boolean) - Treat squares with destructible structures as walkable. Default is false.
  - **ignoreRoads** (boolean) - Ignore road structures. Default is false. Used when `PathFinder` is enabled.
  - **costCallback** (function(string, CostMatrix)) - Callback to modify a `CostMatrix` for any room. Accepts `roomName` and `costMatrix`. If a new matrix is returned, it will be used. Used when `PathFinder` is enabled.
  - **ignore** (array) - Objects or `RoomPosition` objects to treat as walkable. Cannot be used when `PathFinder` is enabled.
  - **avoid** (array) - Objects or `RoomPosition` objects to treat as obstacles. Cannot be used when `PathFinder` is enabled.
  - **maxOps** (number) - Maximum limit of possible pathfinding operations. Default is 2000.
  - **heuristicWeight** (number) - Weight for the heuristic in the A* formula. Default is 1.2.
  - **serialize** (boolean) - If true, the result path will be serialized. Default is false.
  - **maxRooms** (number) - Maximum allowed rooms to search. Default (and maximum) is 16. Used when `PathFinder` is enabled.
  - **range** (number) - Find a path to a position in specified linear range of target. Default is 0.
  - **plainCost** (number) - Cost for walking on plain positions. Default is 1.
  - **swampCost** (number) - Cost for walking on swamp positions. Default is 5.

### Return value
An array with path steps in the following format:
```json
[
    { x: 10, y: 5, dx: 1,  dy: 0, direction: RIGHT },
    { x: 10, y: 6, dx: 0,  dy: 1, direction: BOTTOM },
    { x: 9,  y: 7, dx: -1, dy: 1, direction: BOTTOM_LEFT },
    ...
]
```
```

--------------------------------

### Notify on Spawn Energy Depletion

Source: https://docs.screeps.com/api

Send a grouped notification if a spawn runs out of energy. This example groups notifications for 3 hours.

```javascript
if(Game.spawns['Spawn1'].energy == 0) {
    Game.notify(
        'Spawn1 is out of energy',
        180  // group these notifications for 3 hours
    );

}
```

--------------------------------

### Get Range to Target

Source: https://docs.screeps.com/api

Calculates the linear distance (number of squares) between the current position and a target position. Useful for range-based actions.

```javascript
const range = creep.pos.getRangeTo(target);
if(range <= 3) {
    creep.rangedAttack(target);
}
```

--------------------------------

### moveTo

Source: https://docs.screeps.com/api

Finds the optimal path to the target within the same room and moves the creep to it. This is a shorthand for `pos.findPathTo()` and `move()` methods. If the target is in another room, the corresponding exit will be used.

```APIDOC
## moveTo(x, y, [opts])

### Description
Finds the optimal path to the target within the same room and moves the creep to it. A shorthand to consequent calls of pos.findPathTo() and move() methods. If the target is in another room, then the corresponding exit will be used as a target.

### Method
`moveTo`

### Parameters
#### Path Parameters
- **x** (number) - Required - X position of the target in the same room.
- **y** (number) - Required - Y position of the target in the same room.

#### Target Object
- **target** (object) - Required - Can be a RoomPosition object or any object containing RoomPosition. The position doesn't have to be in the same room with the creep.

#### Options (`opts`)
- **reusePath** (number) - Optional - This option enables reusing the path found along multiple game ticks. It allows to save CPU time, but can result in a slightly slower creep reaction behavior. The path is stored into the creep's memory to the `_move` property. The `reusePath` value defines the amount of ticks which the path should be reused for. The default value is 5. Increase the amount to save more CPU, decrease to make the movement more consistent. Set to 0 if you want to disable path reusing.
- **serializeMemory** (boolean) - Optional - If `reusePath` is enabled and this option is set to true, the path will be stored in memory in the short serialized form using `Room.serializePath`. The default value is true.
- **noPathFinding** (boolean) - Optional - If this option is set to true, `moveTo` method will return `ERR_NOT_FOUND` if there is no memorized path to reuse. This can significantly save CPU time in some cases. The default value is false.
- **visualizePathStyle** (object) - Optional - Draw a line along the creep’s path using `RoomVisual.poly`. You can provide either an empty object or custom style parameters. The default style is equivalent to: 
```
{
    fill: 'transparent',
    stroke: '#fff',
    lineStyle: 'dashed',
    strokeWidth: .15,
    opacity: .1
}
```
- **Any options supported by `Room.findPath` method.**

### Return value
- **OK** (0): The operation has been scheduled successfully.
- **ERR_NOT_OWNER** (-1): You are not the owner of this creep.
- **ERR_NO_PATH** (-2): No path to the target could be found.
- **ERR_BUSY** (-4): The power creep is not spawned in the world.
- **ERR_NOT_FOUND** (-5): The creep has no memorized path to reuse.
- **ERR_INVALID_TARGET** (-7): The target provided is invalid.
- **ERR_TIRED** (-11): The fatigue indicator of the creep is non-zero.
```

--------------------------------

### Game.map.findExit

Source: https://docs.screeps.com/api

Finds the exit direction from a starting room to a destination room. This is useful for pathfinding when a creep needs to move to an adjacent room.

```APIDOC
## Game.map.findExit(fromRoom, toRoom, [opts])

### Description
Find the exit direction from the given room en route to another room.

### Parameters
#### Path Parameters
- **fromRoom** (string, Room) - Required - Start room name or room object.
- **toRoom** (string, Room) - Required - Finish room name or room object.
- **opts** (object) - Optional - An object with the pathfinding options. See `findRoute`.

### Return value
The room direction constant, one of the following:
  * `FIND_EXIT_TOP`
  * `FIND_EXIT_RIGHT`
  * `FIND_EXIT_BOTTOM`
  * `FIND_EXIT_LEFT`

Or one of the following error codes:
constant| value| description  
---|---|---
`ERR_NO_PATH`| -2| Path can not be found.
`ERR_INVALID_ARGS`| -10| The location is incorrect.
```

--------------------------------

### Create RoomPosition Object

Source: https://docs.screeps.com/api

Instantiate a new RoomPosition object by providing the X and Y coordinates and the room name.

```javascript
const pos = new RoomPosition(10, 25, 'sim');
```

--------------------------------

### Get Room Visual Size

Source: https://docs.screeps.com/api

Checks the current size of visuals added in the room. Useful for preventing exceeding the 512,000 byte limit.

```javascript
if(creep.room.visual.getSize() >= 512000) {
    // cannot add more visuals in this tick
}
```

--------------------------------

### Create RoomVisuals in a Specific Room

Source: https://docs.screeps.com/api

Instantiate `RoomVisual` for a specific room to draw debug information. Visuals persist for one tick unless updated.

```javascript
Game.rooms['W10N10'].visual.circle(10,20).line(0,0,10,20);
// the same as:
new RoomVisual('W10N10').circle(10,20).line(0,0,10,20);
```

--------------------------------

### Get Room Terrain Data

Source: https://docs.screeps.com/api

Retrieves a Room.Terrain object for fast access to static terrain information. This can be used even for rooms you do not have access to.

```javascript
const terrain = Game.rooms['W1N1'].getTerrain();
switch(terrain.get(10,15)) {
    case TERRAIN_MASK_WALL:
        break;
    case TERRAIN_MASK_SWAMP:
        break;
    case 0:
        break;
}
```

--------------------------------

### Optimized Creep Movement with Path Caching

Source: https://docs.screeps.com/api

This snippet demonstrates an optimized approach to creep movement. It first attempts to move creeps using cached paths (`noPathFinding: true`) to save CPU. If CPU is available, it then performs pathfinding for all creeps.

```javascript
// Execute moves by cached paths at first
for(const name in Game.creeps) {
    Game.creeps[name].moveTo(target, {noPathFinding: true});
}

// Perform pathfinding only if we have enough CPU
if(Game.cpu.tickLimit - Game.cpu.getUsed() > 20) {
    for(const name in Game.creeps) {
        Game.creeps[name].moveTo(target);
    }
}
```

--------------------------------

### Get Room Position

Source: https://docs.screeps.com/api

Creates a RoomPosition object at the specified coordinates within a room. Useful for finding objects relative to a specific location.

```javascript
const pos = Game.rooms.sim.getPositionAt(5,12);
const source = pos.findClosestByRange(FIND_SOURCES_ACTIVE);
```

--------------------------------

### Get All Market Orders

Source: https://docs.screeps.com/api

Retrieves all active market orders. Can be filtered for specific types and resources for faster results. Use with caution as fetching all orders can be slow.

```javascript
Game.market.getAllOrders(); // slow
```

```javascript
Game.market.getAllOrders({type: ORDER_SELL, resourceType: RESOURCE_GHODIUM}); // fast
```

```javascript
const targetRoom = "W1N1";
Game.market.getAllOrders(order => order.resourceType == RESOURCE_GHODIUM &&
    order.type == ORDER_SELL &&
    Game.market.calcTransactionCost(1000, targetRoom, order.roomName) < 500); // slow
```

--------------------------------

### Basic Pathfinding

Source: https://docs.screeps.com/api

Finds a path between the creep's current position and a target position and then moves the creep in the first direction of the path.

```javascript
const path = creep.room.findPath(creep.pos, targetPos);
creep.move(path[0].direction);
```

--------------------------------

### Get Room Terrain Data

Source: https://docs.screeps.com/api

Retrieves a Room.Terrain object for fast access to static terrain data in any room. The terrain type at specific coordinates can then be checked.

```javascript
const terrain = Game.map.getRoomTerrain("E2S7");
switch(terrain.get(10,15)) {
    case TERRAIN_MASK_WALL:
        break;
    case TERRAIN_MASK_SWAMP:
        break;
    case 0:
        break;
}
```

--------------------------------

### Get Remote Inter-Shard Data

Source: https://docs.screeps.com/api

Retrieve the string contents of another shard's data. The data is typically parsed from JSON to access structured information.

```javascript
var data = JSON.parse(InterShardMemory.getRemote('shard0') || "{}");
console.log(data.message);
```
Tokens:
Raw