Options used by ScreepsConfigManager.loadConfig
User-configurable options for ScreepsHttpClient
Configuration and options for ScreepsHttpClient
Format of a Screeps JSON credentials file: https://github.com/screepers/screeps-typescript-starter/blob/master/screeps.sample.json
Server configuration schema from ScreepsJsonConfig/ScreepsYamlConfig
Normalized configuration for a single Screeps World server
Format of a Screeps Unified Credentials File: https://github.com/screepers/screepers-standards/blob/3877e86f38caed9891ef6270aa9690df556e6c22/SS3-Unified_Credentials_File.md
An extension of ScreepsClientConfig that may contain properties intended for the app using ScreepsHttpClient.
Defaults for ScreepsClientConfig
Default value of ScreepsRawServerConfig.hostname
Default value of ScreepsRawServerConfig.path
Related to decorations: cosmetic effects that can be applied to rooms and room objects.
All possible DecorationProperty types
Enumerates all possible Decoration.type values
Represents a single premium user UserBadge. DecorationInstances of each badge can be earned by users via pixelization.
A configurable boolean property of a Decoration
A configurable color property of a Decoration.
Represents a single non-BadgeDecoration decoration. instances of each decoration can be earned by users via pixelization.
Properties common to all decoration types
An instance of a Decoration that is owned by a user
A configurable property of a Decoration
A configurable number property of a Decoration
A configurable number property of a Decoration that only accepts values within a defined range.
A configurable string property of a Decoration
A DecorationPropertyTypes value
A DecorationTypes value
Related to the in-game market
An active order on the in-game market
A buy or sell order on the in-game market created by the authenticated user.
An Order for a non-account-bound resource
Related to in-game resources and account-bound resources
Resources that can be combined in a StructureFactory to create commodities, which can then be sold to NPCs for a high price.
An account-bound resource.
A resource that can be traded on the in-game market.
A MineralCompoundResource that cannot be used as a boost.
Any non-compressed mineral-based resource type.
Resources created in a StructureLab that can be used to improve the performance of Creep parts.
Resources that can be combined in a StructureLab to create MineralBoostResources.
A DepositResources value
A IntershardResources value
A MarketResources value
A MineralBaseCompoundResources value
A MineralBasedResources value
A MineralBoostResources value
A resource that was formed from the combination of two or more MineralResources in a StructureLab.
A MineralResources value
A Resources value
Related to rooms and RoomObjects
Possible body part types that may be added to a Creep
Describes all possible types of Structures that can be built by a player and associated with a ConstructionSite
Flag colors
A PowerCreep archetype. Each has a unique set of powers.
Represents any possible entity that can physically exist in the game world.
A time interval (in minutes) that can be used to query room stats
Stats that are tracked for each user on a room-level basis
Describes all possible types of Structures that can exist in the game world.
Common properties of Creeps and PowerCreeps
A site of a structure which is currently under construction.
Creeps are your units. Creeps can move, harvest energy, construct structures, attack another creeps, and perform other actions.
A rare resource deposit needed for producing commodities. Can be harvested by creeps with a WORK body part.
A temporary status effect applied to a RoomObject
Represents a flag owned by the authenticated user.
A RoomObject that can be damaged/destroyed
A RoomObject with an owner. The owner could be an NPC.
A RoomObject with a limited Store
A RoomObject with a general-purpose Store.
Destination of an intershard StructurePortal
Destination of an intrashard StructurePortal
A mineral deposit. Can be harvested by creeps with a WORK body part using the extractor structure.
A nuke landing position. This object cannot be removed or modified.
Indicates the position of an object within a known room (which is why a room name field isn't included).
Power Creeps are immortal "heroes" that are tied to your account and can be respawned in any PowerSpawn after death.
An entity that exists within the game world
A destroyed structure. This is a walkable object.
A say action performed by a Creep or PowerCreep
An energy source object. Can be harvested by creeps with a WORK body part.
Indicates a start and end position within the same known room (which is why a room name field isn't included).
An object that can contain resources in its cargo.
The base prototype object of all structures.
A small container that can be used to store resources.
Claim this structure to take control over the room.
Contains energy which can be spent on spawning bigger creeps.
Allows creeps to harvest a mineral deposit.
Produces trade commodities from base minerals and other commodities.
This NPC structure is a control center of NPC Strongholds, and also rules all invaders in the sector.
Non-player structure. Spawns NPC Source Keepers that guards energy sources and minerals in some rooms.
Produces mineral compounds from base minerals, boosts and unboosts creeps.
Remotely transfers energy to another Link in the same room.
Launches a nuke to another room dealing huge damage to the landing area.
Provides visibility into a distant room from your script.
A non-player structure. Instantly teleports your creeps to a distant room acting as a room exit tile.
Non-player structure. Contains power resource which can be obtained by destroying the structure.
Processes power into your account, and spawns power creeps with special unique powers.
Blocks movement of hostile creeps, and defends your creeps and structures on the same tile.
Decreases movement cost to 1. Using roads allows creating creeps with less MOVE body parts.
Spawn is your colony center. This structure can create, renew, and recycle creeps.
A structure that can store huge amount of resource units.
Sends any resources to a Terminal in another room.
Remotely attacks or heals creeps, or repairs structures. Can be targeted to any object in the room.
A remnant of dead creeps. This is a walkable object.
A BodyPartTypes value
A BuildableStructureTypes value
A FlagColors value
A PowerCreepClasses value
A RoomObjectTypes value
A RoomStats value
A RoomStatIntervals value
A RoomStatuses value
A StructureTypes value
Related to users and their accounts
A user's CPU limits for each shard indexed by name.
High-level metadata for an individual user
Parameters used to render a player's SVG icon / logo / "bust" (as it is referenced in the client)
A pair of SVG paths composing a premium UserBadge
A collection of JavaScript/WASM modules
Binary contents of a WebAssembly (WASM) module
A collection of user metadata keyed by user ID
Contents of a single module.
ID of the "Invader" NPC
ID of the "Source Keeper" NPC
ScreepsHttpClient and other entities related to the HTTP API
All possible time periods over which a RateLimit can apply.
HTTP request methods/verbs used with Screeps API endpoints
Thrown by ScreepsHttpClient endpoint methods when an HTTP 4xx/5xx response is received from an endpoint.
Provides access to the Screeps HTTP Http.
Tracks rate limit status for all HTTP API endpoints.
Options to use with ScreepsHttpClient.debug
Rate limit state for an individual HTTP API endpoint.
Payload of ScreepsHttpClient.RATE_LIMIT events.
State that is included in response headers when a rate limit is hit.
Generic HTTP API response to a request to update database records
MongoDB result output from an update operation
Generic HTTP API response to a request to "upsert" (create or update) database records
MongoDB result output from an upsert operation
Response returned by some endpoints when an issue occurs.
Data from a single tick in a ScreepsRoomHistoryResponse
Contains all information needed to submit an API request via ScreepsHttpClient.req.
Payload of ScreepsHttpClient.RESPONSE_RESULT events.
Fake GET /api/authmod response returned by official servers
Body of a HTTP API success response.
GET /api/room-history / GET /room-history/${shard}/${room}/${tick}.json response
Body of an HTTP API success response that has not been typed yet. Please consider submitting a PR to replace this with a defined type if you have a sample response body!
GET /api/authmod response returned by unofficial servers
GET /api/version response
A RateLimitPeriods value
GET /api/authmod response
A ScreepsHttpMethods value
Specifies the delay between retry attempts for API requests that are rejected due to the global rate limit.
The expected number of ticks in a ScreepsRoomHistoryResponse from an official server.
The expected number of ticks in a ScreepsRoomHistoryResponse from an unofficial server.
Used with ScreepsHttpClient endpoint methods on the /api/auth path
GET /api/auth/me response
GET /api/auth/query-token response
Information about an API auth token from a AuthQueryTokenResponse
POST /api/auth/signin response
Used with ScreepsHttpClient endpoint methods on the /api/experimental path
GET /api/experimental/nukes response
GET /api/experimental/pvp response
Used with ScreepsHttpClient endpoint methods on the /api/game path
Stats that can be used with the POST /api/game/map-stats endpoint
Room terrain types in a human-readable format
POST /api/game/create-construction response
POST /api/game/gen-unique-flag-name and
POST /api/game/gen-unique-object-name responses
POST /api/game/map-stats response
A single room result from GameMapStatsResponse
GET /api/game/room-decorations response
GET /api/game/room-objects response
GET /api/game/room-overview response
GET /api/game/room-status response
GET /api/game/room-terrain response when encoded param is
defined and non-empty
GET /api/game/room-terrain response when the encoded param is
undefined or empty (undefined, null, '', etc)
GET /api/game/time response
GET /api/game/world-size response
A player signature on a room controller
A system signature on a room / room controller
Non-plain terrain data for a single room position
A MapStats value
A RoomTerrainTypes value
Used with ScreepsHttpClient endpoint methods on the /api/game/market path
GET /api/game/market/orders-index response
GET /api/game/market/orders response
GET /api/game/market/stats resonse
GET /api/game/market/my-orders response
Used with ScreepsHttpClient endpoint methods on the /api/game/shards path
GET /api/game/shards/info response
Used with ScreepsHttpClient endpoint methods on the /api/leaderboard path
The types of leaderboard available via the leaderboard endpoints (ex: ScreepsHttpClient.leaderboardList)
GET /api/leaderboard/find response
GET /api/leaderboard/list response
A user's leaderboard result for a single season
GET /api/leaderboard/seasons response
A LeaderboardModes value
Used with ScreepsHttpClient endpoint methods on the /api/scoreboard path
GET /api/scoreboard/list response
A user from ScoreboardListResponse
Used with ScreepsHttpClient endpoint methods on the /api/seasons path
GET /api/seasons/current response
Used with ScreepsHttpClient endpoint methods on the /api/servers path
A server from ServerListResponse
POST /api/servers/list response: a curated list of community-run servers
Used with ScreepsHttpClient endpoint methods on the /api/user path
A user's status on the server. This is used to determine whether or not they may claim a room or place a spawn directly (to spawn/respawn).
UserMoneyHistoryTransaction.market information about an order update triggered via Game.market.changeOrderPrice().
UserMoneyHistoryTransaction.market information about an order update triggered via Game.market.extendOrder().
UserMoneyHistoryTransaction.market details of a market transaction executed via Game.market.deal().
UserMoneyHistoryTransaction.market information about a market Order created via Game.market.createOrder().
GET /api/user/branches response
GET /api/user/code response
POST /api/user/code response
POST /api/user/console response
GET /api/user/find response
A result from UserFindResponse
GET /api/user/memory response
GET /api/user/memory-segment response
POST /api/user/memory response
GET /api/user/money-history response
A single record from UserMoneyHistoryResponse
GET /api/user/name response
POST /api/user/notify-prefs request
GET /api/user/overview response
GET /api/user/respawn-prohibited-rooms response
GET /api/user/rooms response
GET /api/user/stats response
GET /api/user/world-start-room response
GET /api/user/world-status response
Any UserWorldStatuses value
Used with ScreepsHttpClient endpoint methods on the /api/user/decorations path
GET /api/user/decorations/inventory response
GET /api/user/decorations/themes response
Used with ScreepsHttpClient endpoint methods on the /api/user/messages path
A message result from UserMessagesListResponse or UserMessagesIndexResponse
A message result from UserMessagesIndexResponse
GET /api/user/messages/index response
GET /api/user/messages/list response
POST /api/user/messages/mark-read response
GET /api/user/messages/unread-count response
Used with ScreepsHttpClient endpoint methods on the /api/warpath path
An individual battle from WarpathBattlesResponse
Response from GET /api/warpath/battles on a game server,
or any GET * /battles.json endpoints on
Voight-Kampff
ScreepsSocketClient and other entities related to the WebSocket API
Provides access to the Screeps WebSocket API.
WebSocket event for map visuals on the alpha version of the world map.
WebSocket event for room objects and other room state updates.
Payload of a RoomEvent
WebSocket event for updates to the map (appears to apply to the original map, alpha map, and minimap in the room view).
Payload of a RoomMap2Event
Configuration options for ScreepsSocketClient. These are used when calling ScreepsSocketClient.connect.
Parsed version of a message received from the server via the WebSocket API.
An [X, Y] tuple representing a room position
Default ScreepsSocketConfig used by ScreepsSocketClient.connect
SocketEvents of type: 'server'
Possible outcomes of a ServerAuthEvent.
WebSocket event for authentication responses.
Payload of a ServerAuthEvent
A ServerAuthStatuses value
SocketEvents of type: 'user'
WebSocket event that appears to be related to the Memory inspector watch list.
WebSocket event for code changes.
Payload of a UserCodeEvent
WebSocket event for console output.
Payload of a UserConsoleEvent
Part of UserConsoleEventData
WebSocket event for CPU/memory usage updates.
Payload of a UserCpuEvent
WebSocket event for updates to account-bound resources.
A resource type that can be included in UserResourceEventData
Payload of a UserResourceEvent
Provides features to find and load save configuration files.