GameApi | ogame-bot-api

The GameApi is used to interact with the game itself, create and list ressources/ship/research... You should use LobbyApi to load it, don't create it yourself

Hierarchy

GameApi

Index

Methods

Methods

canCreate

canCreate(item: Ship | Defense, count?: number, resources?: ResourceList): Promise<boolean>

- Defined in Api/game/GameApi.ts:169
Check if you can create a certain amount of ship/defense

Parameters
- item: Ship | Defense
  
  Ship or Defense
- Default value count: number = 1
  
  The number of items you wants to create
- Optional resources: ResourceList
  
  Optional parameter, if provided it will speed up the fonction
Returns Promise<boolean>

canUpgrade

canUpgrade(building: BuildingLight, resources?: ResourceList): Promise<boolean>

- Defined in Api/game/GameApi.ts:157
Check if you can upgrade a building

Parameters
- building: BuildingLight
  
  the building to upgrade
- Optional resources: ResourceList
  
  Optional parameter, if provided it will speed up the fonction
Returns Promise<boolean>

createDefense

createDefense(defense: Defense, count?: number): Promise<void>

- Defined in Api/game/GameApi.ts:192
Create a defense

Parameters
- defense: Defense
  
  defense to create
- Default value count: number = 1
  
  number of defense to create
Returns Promise<void>

createShip

createShip(ship: Ship, count?: number): Promise<void>

- Defined in Api/game/GameApi.ts:179
Create a ship

Parameters
- ship: Ship
  
  ship to create
- Default value count: number = 1
  
  number of ship to create
Returns Promise<void>

defenseList

defenseList(): Promise<DefenseList>

- Defined in Api/game/GameApi.ts:124
List your defenses

Returns Promise<DefenseList>

facilitiesList

facilitiesList(): Promise<FacilitiesList>

- Defined in Api/game/GameApi.ts:100
List your facilities

Returns Promise<FacilitiesList>

makeUpgrade

makeUpgrade(building: BuildingLight): Promise<void>

- Defined in Api/game/GameApi.ts:133
Upgrade or create a building. Don't use it for ships/defenses

Parameters
- building: BuildingLight
  
  The building to upgrade
Returns Promise<void>

researchList

researchList(): Promise<ResearchList>

- Defined in Api/game/GameApi.ts:108
List you research

Returns Promise<ResearchList>

resourceFactoryList

resourceFactoryList(): Promise<ResourceFactoryList>

- Defined in Api/game/GameApi.ts:91
List your mines and storage

Returns Promise<ResourceFactoryList>

resourcesList

resourcesList(): Promise<ResourceList>

- Defined in Api/game/GameApi.ts:83
List your ressources

Returns Promise<ResourceList>

shipList

shipList(): Promise<ShipList>

- Defined in Api/game/GameApi.ts:116
List your ships

Returns Promise<ShipList>

start

start(): Promise<void>

- Defined in Api/game/GameApi.ts:52
Start the game api

Returns Promise<void>

stop

stop(): Promise<void>

- Defined in Api/game/GameApi.ts:76
Stop the game api. You should called this before exiting your program.

Returns Promise<void>

Generated using TypeDoc