/// <summary>
/// Register Consumers Add a consumer to create a *virtual* (*spectating*) player to consume events
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="consumerRegistration">Information about the joining consumer (optional)</param>
/// <returns>JoinResponse</returns>
public JoinResponse RegisterConsumer(int gameId, ConsumerRegistration consumerRegistration = default(ConsumerRegistration))
{
Tgm.Roborally.Api.Client.ApiResponse <JoinResponse> localVarResponse = RegisterConsumerWithHttpInfo(gameId, consumerRegistration);
return(localVarResponse.Data);
}
/// <summary>
/// Register Consumers Add a consumer to create a *virtual* (*spectating*) player to consume events
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="consumerRegistration">Information about the joining consumer (optional)</param>
/// <returns>Task of JoinResponse</returns>
public async System.Threading.Tasks.Task <JoinResponse> RegisterConsumerAsync(int gameId, ConsumerRegistration consumerRegistration = default(ConsumerRegistration))
{
Tgm.Roborally.Api.Client.ApiResponse <JoinResponse> localVarResponse = await RegisterConsumerAsyncWithHttpInfo(gameId, consumerRegistration);
return(localVarResponse.Data);
}
/// <summary>
/// Get upgrade information Get detailed information about the Upgrade
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="upgradeId">The id of the upgrade to interact with</param>
/// <returns>Task of Upgrade</returns>
public async System.Threading.Tasks.Task <Upgrade> GetUpgradeInformationAsync(int gameId, int upgradeId)
{
Tgm.Roborally.Api.Client.ApiResponse <Upgrade> localVarResponse = await GetUpgradeInformationAsyncWithHttpInfo(gameId, upgradeId);
return(localVarResponse.Data);
}
/// <summary>
/// Get upgrade shop Retuns a list of all cards in the upgrade shop
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <returns>UpgradeShop</returns>
public UpgradeShop GetUpgradeShop(int gameId)
{
Tgm.Roborally.Api.Client.ApiResponse <UpgradeShop> localVarResponse = GetUpgradeShopWithHttpInfo(gameId);
return(localVarResponse.Data);
}
/// <summary>
/// Get map Get a map by its name
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="mapName"></param>
/// <returns>Task of MapInfo</returns>
public async System.Threading.Tasks.Task <MapInfo> GetMapAsync(string mapName)
{
Tgm.Roborally.Api.Client.ApiResponse <MapInfo> localVarResponse = await GetMapAsyncWithHttpInfo(mapName);
return(localVarResponse.Data);
}
/// <summary>
/// Get upgrade information Get detailed information about the Upgrade
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="upgradeId">The id of the upgrade to interact with</param>
/// <returns>Upgrade</returns>
public Upgrade GetUpgradeInformation(int gameId, int upgradeId)
{
Tgm.Roborally.Api.Client.ApiResponse <Upgrade> localVarResponse = GetUpgradeInformationWithHttpInfo(gameId, upgradeId);
return(localVarResponse.Data);
}
/// <summary>
/// trace event All events needed by the client are accessible here. (Usefull for animations) More about this function is found in the [regarding Github Issue](https://github.com/FactoryRally/game-controller/issues/6) **This function only returns the type of the event you need to fetch the data seperately** > Read more at [api-usage.md](https://github.com/FactoryRally/game-controller/blob/master/documentation/rest/api-usage.md#events- -updates)
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="wait">If true the server will not responde until a event is added to the queue Rrequires less traffic but might impacts the servers performance or cause timeouts at the client</param>
/// <param name="batch">If true you will get all past events at once If false the list only contains the oldest unfetched event (optional, default to false)</param>
/// <returns>Task of List<EventType></returns>
public async System.Threading.Tasks.Task <List <EventType> > TraceEventAsync(int gameId, bool wait, bool?batch = default(bool?))
{
Tgm.Roborally.Api.Client.ApiResponse <List <EventType> > localVarResponse = await TraceEventAsyncWithHttpInfo(gameId, wait, batch);
return(localVarResponse.Data);
}
/// <summary>
/// Get tile Inspect a tile of the map
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="x">The x codinate of the tile</param>
/// <param name="y">The y codinate of the tile</param>
/// <returns>Tile</returns>
public Tile GetTile(int gameId, int x, int y)
{
Tgm.Roborally.Api.Client.ApiResponse <Tile> localVarResponse = GetTileWithHttpInfo(gameId, x, y);
return(localVarResponse.Data);
}
/// <summary>
/// Get next event Returns the next unfetched event of the ***any*** type.
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <returns>Task of GenericEvent</returns>
public async System.Threading.Tasks.Task <GenericEvent> FetchNextEventAsync(int gameId)
{
Tgm.Roborally.Api.Client.ApiResponse <GenericEvent> localVarResponse = await FetchNextEventAsyncWithHttpInfo(gameId);
return(localVarResponse.Data);
}
/// <summary>
/// trace event All events needed by the client are accessible here. (Usefull for animations) More about this function is found in the [regarding Github Issue](https://github.com/FactoryRally/game-controller/issues/6) **This function only returns the type of the event you need to fetch the data seperately** > Read more at [api-usage.md](https://github.com/FactoryRally/game-controller/blob/master/documentation/rest/api-usage.md#events- -updates)
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="wait">If true the server will not responde until a event is added to the queue Rrequires less traffic but might impacts the servers performance or cause timeouts at the client</param>
/// <param name="batch">If true you will get all past events at once If false the list only contains the oldest unfetched event (optional, default to false)</param>
/// <returns>List<EventType></returns>
public List <EventType> TraceEvent(int gameId, bool wait, bool?batch = default(bool?))
{
Tgm.Roborally.Api.Client.ApiResponse <List <EventType> > localVarResponse = TraceEventWithHttpInfo(gameId, wait, batch);
return(localVarResponse.Data);
}
/// <summary>
/// Get next event Returns the next unfetched event of the ***any*** type.
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <returns>GenericEvent</returns>
public GenericEvent FetchNextEvent(int gameId)
{
Tgm.Roborally.Api.Client.ApiResponse <GenericEvent> localVarResponse = FetchNextEventWithHttpInfo(gameId);
return(localVarResponse.Data);
}
/// <summary>
/// Get Map Names Returns a list of all map names
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Task of List<string></returns>
public async System.Threading.Tasks.Task <List <string> > GetMapsAsync()
{
Tgm.Roborally.Api.Client.ApiResponse <List <string> > localVarResponse = await GetMapsAsyncWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Get Map Names Returns a list of all map names
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>List<string></returns>
public List <string> GetMaps()
{
Tgm.Roborally.Api.Client.ApiResponse <List <string> > localVarResponse = GetMapsWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Get Map info Get meta information abouzt the map of the game
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <returns>MapInfo</returns>
public MapInfo GetMapInfo(int gameId)
{
Tgm.Roborally.Api.Client.ApiResponse <MapInfo> localVarResponse = GetMapInfoWithHttpInfo(gameId);
return(localVarResponse.Data);
}
/// <summary>
/// get all Upgrades Returns a list of all Upgrade IDs
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <returns>List<int></returns>
public List <int> GetAllUpgradeIDs(int gameId)
{
Tgm.Roborally.Api.Client.ApiResponse <List <int> > localVarResponse = GetAllUpgradeIDsWithHttpInfo(gameId);
return(localVarResponse.Data);
}
/// <summary>
/// Get Map info Get meta information abouzt the map of the game
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <returns>Task of MapInfo</returns>
public async System.Threading.Tasks.Task <MapInfo> GetMapInfoAsync(int gameId)
{
Tgm.Roborally.Api.Client.ApiResponse <MapInfo> localVarResponse = await GetMapInfoAsyncWithHttpInfo(gameId);
return(localVarResponse.Data);
}
/// <summary>
/// get all Upgrades Returns a list of all Upgrade IDs
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <returns>Task of List<int></returns>
public async System.Threading.Tasks.Task <List <int> > GetAllUpgradeIDsAsync(int gameId)
{
Tgm.Roborally.Api.Client.ApiResponse <List <int> > localVarResponse = await GetAllUpgradeIDsAsyncWithHttpInfo(gameId);
return(localVarResponse.Data);
}
/// <summary>
/// Get tile Inspect a tile of the map
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="gameId">The id of the game to interact with</param>
/// <param name="x">The x codinate of the tile</param>
/// <param name="y">The y codinate of the tile</param>
/// <returns>Task of Tile</returns>
public async System.Threading.Tasks.Task <Tile> GetTileAsync(int gameId, int x, int y)
{
Tgm.Roborally.Api.Client.ApiResponse <Tile> localVarResponse = await GetTileAsyncWithHttpInfo(gameId, x, y);
return(localVarResponse.Data);
}
/// <summary>
/// Get map Get a map by its name
/// </summary>
/// <exception cref="Tgm.Roborally.Api.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="mapName"></param>
/// <returns>MapInfo</returns>
public MapInfo GetMap(string mapName)
{
Tgm.Roborally.Api.Client.ApiResponse <MapInfo> localVarResponse = GetMapWithHttpInfo(mapName);
return(localVarResponse.Data);
}