Skip to content

StructureSpawn.md

Latest commit

 

History

History
371 lines (277 loc) · 11.6 KB

StructureSpawn.md

File metadata and controls

371 lines (277 loc) · 11.6 KB

StructureSpawn

 

Spawn is your colony center. This structure can create, renew, and recycle creeps. All your spawns are accessible through Game.spawns hash list.  Spawns auto-regenerate a little amount of energy each tick, so that you can easily recover even if all your creeps died.

Controller level
1-6 1 spawn
7 2 spawns
8 3 spawns
Cost 15,000
Hits 5,000
Capacity 300
Spawn time 3 ticks per each body part
Energy auto-regeneration 1 energy unit per tick while energy available in the room (in all spawns and extensions) is less than 300

{% page inherited/OwnedStructure.md %}

{% api_property energy 'number' '{"deprecated": true}' %}

An alias for .store[RESOURCE_ENERGY].

{% api_property energyCapacity 'number' '{"deprecated": true}' %}

An alias for .store.getCapacity(RESOURCE_ENERGY).

{% api_property memory 'any' %}

spawn.memory.queue = [];

A shorthand to Memory.spawns[spawn.name]. You can use it for quick access the spawn’s specific memory data object. Learn more about memory

{% api_property name 'string' %}

Spawn’s name. You choose the name upon creating a new spawn, and it cannot be changed later. This name is a hash key to access the spawn via the Game.spawns object.

{% api_property spawning 'StructureSpawn.Spawning' %}

If the spawn is in process of spawning a new creep, this object will contain a StructureSpawn.Spawning object, or null otherwise.

{% api_property store 'Store' %}

if(structure.store.getFreeCapacity(RESOURCE_ENERGY) > 0) {
    creep.transfer(structure, RESOURCE_ENERGY);
}

A Store object that contains cargo of this structure.

{% api_method canCreateCreep 'body, [name]' 1 '{"deprecated": "Please use StructureSpawn.spawnCreep with dryRun flag instead."}' %}

if(spawn.canCreateCreep(body, name) == OK) {
    spawn.createCreep(body, name);
}

Check if a creep can be created.

{% api_method_params %} body : array<string> An array describing the new creep’s body. Should contain 1 to 50 elements with one of these constants:

  • WORK
  • MOVE
  • CARRY
  • ATTACK
  • RANGED_ATTACK
  • HEAL
  • TOUGH
  • CLAIM

=== name (optional) : string The name of a new creep. The name length limit is 100 characters. It should be unique creep name, i.e. the Game.creeps object should not contain another creep with the same name (hash key). If not defined, a random name will be generated. {% endapi_method_params %}

Return value

One of the following codes: {% api_return_codes %} OK | A creep with the given body and name can be created. ERR_NOT_OWNER | You are not the owner of this spawn. ERR_NAME_EXISTS | There is a creep with the same name already. ERR_BUSY | The spawn is already in process of spawning another creep. ERR_NOT_ENOUGH_ENERGY | The spawn and its extensions contain not enough energy to create a creep with the given body. ERR_INVALID_ARGS | Body is not properly described. ERR_RCL_NOT_ENOUGH | Your Room Controller level is insufficient to use this spawn. {% endapi_return_codes %}

{% api_method createCreep 'body, [name], [memory]' A '{"deprecated": "Please use StructureSpawn.spawnCreep instead."}' %}

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);
}

Start the creep spawning process. The required energy amount can be withdrawn from all spawns and extensions in the room.

{% api_method_params %} body : array<string> An array describing the new creep’s body. Should contain 1 to 50 elements with one of these constants:

  • WORK
  • MOVE
  • CARRY
  • ATTACK
  • RANGED_ATTACK
  • HEAL
  • TOUGH
  • CLAIM

=== name (optional) : string The name of a new creep. The name length limit is 100 characters. It should be unique creep name, i.e. the Game.creeps object should not contain another creep with the same name (hash key). If not defined, a random name will be generated.

memory (optional) : any The memory of a new creep. If provided, it will be immediately stored into Memory.creeps[name]. {% endapi_method_params %}

Return value

The name of a new creep or one of these error codes: {% api_return_codes %} ERR_NOT_OWNER | You are not the owner of this spawn. ERR_NAME_EXISTS | There is a creep with the same name already. ERR_BUSY | The spawn is already in process of spawning another creep. ERR_NOT_ENOUGH_ENERGY | The spawn and its extensions contain not enough energy to create a creep with the given body. ERR_INVALID_ARGS | Body is not properly described. ERR_RCL_NOT_ENOUGH | Your Room Controller level is insufficient to use this spawn. {% endapi_return_codes %}

{% api_method spawnCreep 'body, name, [opts]' A %}

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 });

Start the creep spawning process. The required energy amount can be withdrawn from all spawns and extensions in the room.

{% api_method_params %} body : array<string> An array describing the new creep’s body. Should contain 1 to 50 elements with one of these constants:

  • WORK
  • MOVE
  • CARRY
  • ATTACK
  • RANGED_ATTACK
  • HEAL
  • TOUGH
  • CLAIM

=== name : string The name of a new creep. The name length limit is 100 characters. It must be a unique creep name, i.e. the Game.creeps object should not contain another creep with the same name (hash key).

opts (optional) : object 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 for the spawning process. 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
  • notifyWhenAttacked
    boolean
    Sets the default value for the creep's notifyWhenAttacked property. Defaults to true.
{% endapi_method_params %}

Return value

One of the following codes: {% api_return_codes %} OK | The operation has been scheduled successfully. ERR_NOT_OWNER | You are not the owner of this spawn. ERR_NAME_EXISTS | There is a creep with the same name already. ERR_BUSY | The spawn is already in process of spawning another creep. ERR_NOT_ENOUGH_ENERGY | The spawn and its extensions contain not enough energy to create a creep with the given body. ERR_INVALID_ARGS | Body is not properly described or name was not provided. ERR_RCL_NOT_ENOUGH | Your Room Controller level is insufficient to use this spawn. {% endapi_return_codes %}

{% api_method recycleCreep 'target' A %}

Kill the creep and drop up to 100% of resources spent on its spawning and boosting depending on remaining life time. The target should be at adjacent square. Energy return is limited to 125 units per body part.

{% api_method_params %} target : Creep The target creep object. {% endapi_method_params %}

Return value

One of the following codes: {% api_return_codes %} OK | The operation has been scheduled successfully. ERR_NOT_OWNER | You are not the owner of this spawn or the target creep. ERR_INVALID_TARGET | The specified target object is not a creep. ERR_NOT_IN_RANGE | The target creep is too far away. ERR_RCL_NOT_ENOUGH | Your Room Controller level is insufficient to use this spawn. {% endapi_return_codes %}

{% api_method renewCreep 'target' A %}

Increase the remaining time to live of the target creep. The target should be at adjacent square. The target should not have CLAIM body parts. The spawn should not be busy with the spawning process. Each execution increases the creep's timer by amount of ticks according to this formula:

floor(600/body_size)

Energy required for each execution is determined using this formula:

ceil(creep_cost/2.5/body_size)

Renewing a creep removes all of its boosts.

{% api_method_params %} target : Creep The target creep object. {% endapi_method_params %}

Return value

One of the following codes: {% api_return_codes %} OK | The operation has been scheduled successfully. ERR_NOT_OWNER | You are not the owner of the spawn, or the creep. ERR_BUSY | The spawn is spawning another creep. ERR_NOT_ENOUGH_ENERGY | The spawn does not have enough energy. ERR_INVALID_TARGET | The specified target object is not a creep, or the creep has CLAIM body part. ERR_FULL | The target creep's time to live timer is full. ERR_NOT_IN_RANGE | The target creep is too far away. ERR_RCL_NOT_ENOUGH | Your Room Controller level is insufficient to use this spawn. {% endapi_return_codes %}