Module screeps_api::websocket::objects

Room object parsing.

If you just want to use the module, reading the rustdocs documentation is very recommended. All types generated with macros will also have documentation for them available.

Reading the source code is definitely possible. But there may be some investment in reading each of the macros defined and used here, and it will be much easier to just read the documentation.

Structs

ActionLogTarget	A struct describing the destination of various actions within action logs.
ActionLogTargetUpdate	The update structure for an ActionLogTarget.
ConstructionSite	A construction site - a planned structure
ConstructionSiteUpdate	The update structure for a ConstructionSite.
ContainerContents	Resource iterator for a StructureContainer.
ControllerReservation	A struct describing a room's reservation.
ControllerReservationUpdate	The update structure for a controller reservation.
Creep	A creep object.
CreepActions	A struct describing a creep's actions.
CreepActionsUpdate	The update structure for a CreepActions.
CreepContents	Resource iterator for a Creep.
CreepMessage	A struct describing a creep's message conveyed with say.
CreepMessageUpdate	The update structure for a CreepMessage.
CreepPart	A struct describing a creep part.
CreepPartUpdate	The update structure for a CreepPart.
CreepUpdate	The update structure for a Creep.
LabActionTarget	A struct describing the source labs for a lab performing a mineral reaction.
LabActionTargetUpdate	The update structure for a LabActionTarget.
Mineral	A mineral, an object creeps can mine for a non-energy resource.
MineralUpdate	The update structure for a mineral object.
PortalDestination	The destination for a portal structure.
PortalDestinationUpdate	The update structure for a portal destination.
Resource	A resource, a bit of some resource which has dropped on the ground, and is decaying each tick.
ResourceUpdate	Update structure for a Resource.
RoomSignUpdate	Update for room signs
Source	A source object, which creeps can gain energy by mining from.
SourceUpdate	The update structure for a source object.
SpawningCreep	A struct describing a creep currently spawning (used as part of the update for a StructureSpawn).
SpawningCreepUpdate	The update structure for a spawning creep.
StorageContents	Resource iterator for Storage.
StructureContainer	A container structure - a structure which can store a small number of any combination of resources, and can be built in any room, but decays over time.
StructureContainerUpdate	The update structure for an extension structure.
StructureController	A controller, an object creeps can upgrade in order to increase room level.
StructureControllerUpdate	The update structure for a controller object.
StructureExtension	An extension structure - a structure that can be filled with extra energy spawns can use.
StructureExtensionUpdate	The update structure for an extension structure.
StructureExtractor	An extractor structure - a structure that can be used to harvest minerals.
StructureExtractorUpdate	The update structure for an extension structure.
StructureKeeperLair	A keeper lair - a structure which spawns npc hostiles to protect minerals and resources nearby.
StructureKeeperLairUpdate	The update structure for a keeper lair structure.
StructureLab	A lab structure - a structure that can be filled with energy and minerals, merge minerals with minerals from other labs, and use minerals and energy to boost creeps.
StructureLabActions	A struct describing a lab's actions.
StructureLabActionsUpdate	The update structure for a StructureLabActions.
StructureLabUpdate	The update structure for a StructureLab.
StructureLink	A link structure - a structure that can be filled with energy, then instantly send energy to other links in the same room.
StructureLinkActions	A struct describing a link's actions.
StructureLinkActionsUpdate	The update structure for StructureLinkActions.
StructureLinkUpdate	The update structure for a StructureLink.
StructureNuker	An nuker structure - a structure which can be loaded with energy and ghodium, and then fired to launch a large impact missile into another nearby room.
StructureNukerUpdate	The update structure for a StructureNuker.
StructureObserver	An observer structure - a structure that give each player room information on one other room within 10 room distance each tick.
StructureObserverUpdate	The update structure for a StructureObserver.
StructurePortal	A portal object, which creeps can use to exit this room into another room somewhere else.
StructurePortalUpdate	The update structure for a portal object.
StructurePowerBank	A power bank object, which can be attacked by creeps, and when killed will yield a harvest of power.
StructurePowerBankUpdate	The update structure for a StructurePowerBank.
StructurePowerSpawn	A power spawn structure - a structure which can consume power, and in the future will be able to spawn power creeps.
StructurePowerSpawnUpdate	The update structure for a mineral object.
StructureRampart	A rampart structure - a structure that has a large amount of possible hit points, and is uniquely walkable only for the owner.
StructureRampartUpdate	The update structure for a rampart structure.
StructureRoad	A road structure - a structure that speeds up creeps without sufficient move parts.
StructureRoadUpdate	The update structure for a road structure.
StructureSpawn	A spawn structure - a structure which can create creeps.
StructureSpawnUpdate	The update structure for a mineral object.
StructureStorage	A storage structure - a structure that has a large capacity for storing multiple resources, and does not decay over time.
StructureStorageUpdate	The update structure for an extension structure.
StructureTerminal	A terminal structure - a structure that has a medium capacity for storing multiple resources, and can spend energy to send any resources to another room with a terminal instantly.
StructureTerminalUpdate	The update structure for an extension structure.
StructureTower	A tower structure - a structure that can be filled with energy, and then attack, heal and repair things within the same room using that energy.
StructureTowerActions	A struct describing a tower's actions.
StructureTowerActionsUpdate	The update structure for a StructureTowerActions.
StructureTowerUpdate	The update structure for a StructureTower.
StructureWall	A wall structure - a structure that has a large amount of possible hit points.
StructureWallUpdate	The update structure for a wall structure.
TerminalContents	Resource iterator for a StructureTerminal.
Tombstone	A tomstone - remnants of a dead creep
TombstoneContents	Resource iterator for a Tombstone.
TombstoneUpdate	The update structure for a Tombstone.
WallDecayTime	Describes the decay of a decaying wall.
WallDecayTimeUpdate	The update structure for a wall decay description.

Enums

CreepPartType	A type of creep part.
KnownRoomObject	Enum describing all known room objects.
StructureType	Type of structure (not general room object).