Expand description
Screeps object wrappers.
Objects types that inherit RoomObject
represent game objects with are
valid to be used only during the current tick; reading or writing a ‘stale’
game object from a past tick will result in undefined behavior.
Re-exports§
Modules§
- Object wrappers representing data retrieved from room event logs.
- Object wrappers for simple javascript objects with known properties sent to game functions.
- Object wrappers for simple javascript objects with known properties returned by game functions.
- Object wrappers allowing drawing of shapes in rooms or on the map in the game world.
Structs§
- A
ConstructionSite
which is an object representing a structure under construction. - A reference to a matrix of pathing costs for a room, stored in JavaScript memory.
- A
Creep
unit in the game world. - A
Deposit
, which can be harvested for resources used in commodities. - A
Flag
, which can be placed by the player or created automatically and are only visible to their owners. You can’t create more thanFLAGS_LIMIT
. - A
Mineral
, which can be harvested for resources with an extractor. - A
Nuke
in flight, which will deal damage in an area and kill all creeps in the room when it lands. - Parent class for all
Structure
objects types which are (or can be) owned by a specific player. - A
PowerCreep
unit in the game world. - Reactor
seasonal-season-5
- A
Resource
is an object representing resources that have been dropped and can be picked up. - A reference to a
Room
object, a 50x50 chunk of the Screeps game world. - Parent class for all objects in rooms in the game world.
- An object representing a position in a room, stored in JavaScript memory.
- A matrix representing the terrain of a room, held in the JavaScript heap.
- A
Ruin
, which represents a destroyed structure and can have resources withdrawn from it. - Score
Collector seasonal-season-1
An object representing aScoreCollector
, which can haveResourceType::Score
transferred to it in order to score points on the leaderboard. - Score
Container seasonal-season-1
An object representing aScoreContainer
, which appears randomly around the map and containsResourceType::Score
which can be collected. - A
Source
, which can be harvested for energy. - Object with info on what a
StructureSpawn
orStructureInvaderCore
is currently spawning. - An object that represents the cargo within an entity in the game world.
- Parent class for all objects that represent a structure in the game world.
- An object representing a
StructureContainer
, which can store resources and does not block creep movement, but requires regular repair due to decay. - An object representing a
StructureController
. - An object representing a
StructureExtension
, which can store energy to be used by spawns in the room to spawn creeps. - An object representing a
StructureExtractor
, which can be placed on top of aMineral
to extract resources. - An object representing a
StructureFactory
, which can compress and decompress resources and produce commodities for sale. - An object representing a
StructureInvaderCore
, which is at the center of NPC strongholds, as well as reserving neutral rooms. - An object representing a
StructureKeeperLair
, which regularly spawns creeps to defend nearby resources. - An object representing a
StructureLab
, which can be used to create mineral compounds. - An object representing a
StructureLink
, which can hold energy and transfer it to other links within the room. - An object representing a
StructureNuker
, which consumes energy and ghodium to fireNuke
s. - An object representing a
StructureObserver
, which can grant vision to remote rooms. - An object representing a
StructurePortal
, which allows movement between remote locations or other shards. - An object representing a
StructurePowerBank
, which can be destroyed for power resources. - An object representing a
StructurePowerSpawn
, which can process power to contribute to your GPL as well as renewing power creeps. - An object representing a
StructureRampart
, which is selectively walkable and protects creeps and structures at the same position. - An object representing a
StructureRoad
, which allows creeps to move onto this position for half of the fatigue of moving onto a plains tile, as well as through terrain walls. - An object representing a
StructureSpawn
, which creates your creeps. - An object representing a
StructureStorage
, which can store large amounts of resources. - An object representing a
StructureTerminal
, which can send resources to distant rooms and participate in the market. - An object representing a
StructureTower
, which can heal, repair, or attack anywhere in the room. - An object representing a
StructureWall
, which blocks movement of all creeps. - Symbol
Container seasonal-season-2
An object representing aSymbolContainer
, which appears randomly around the map and contains symbol resources which can be collected. - Symbol
Decoder seasonal-season-2
An object representing aSymbolDecoder
, which can be used to decode matching symbol resources to score points on the leaderboard. - A
Tombstone
, which represents a dead creep and can have resources withdrawn from it.