Tgm.Roborally.Api.Api.GameApi

All URIs are relative to http://game.host/v1

Method	HTTP request	Description
CommitAction	PUT /games/{game_id}/actions	Commit Action
CreateGame	POST /games/	Create Game
GetActions	GET /games/{game_id}/actions	Get games actions
GetGameState	GET /games/{game_id}/status	Get game status
GetGames	GET /games/	Get all games
GetProgrammingCard	GET /games/{game_id}/statements/{statement_id}	Get Programming Card
GetProgrammingCardIds	HEAD /games/{game_id}/statements	Get Programming Card IDs
GetProgrammingCards	GET /games/{game_id}/statements	Get Programming cards

CommitAction

void CommitAction (int gameId, ActionType action)

Commit Action

Queues an action to be executed

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class CommitActionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            // Configure API key authorization: player-auth
            config.AddApiKey("pat", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("pat", "Bearer");

            var apiInstance = new GameApi(config);
            var gameId = 56;  // int | The id of the game to interact with
            var action = ;  // ActionType | 

            try
            {
                // Commit Action
                apiInstance.CommitAction(gameId, action);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.CommitAction: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
gameId	int	The id of the game to interact with
action	ActionType

Return type

void (empty response body)

Authorization

player-auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-
409	Conflict	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateGame

int CreateGame (GameRules gameRules = null)

Create Game

Creates a random game by your defined rules

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class CreateGameExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            // Configure API key authorization: admin-access
            config.AddApiKey("skey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("skey", "Bearer");

            var apiInstance = new GameApi(config);
            var gameRules = new GameRules(); // GameRules | *Optional* This rules define how your game will behave (optional) 

            try
            {
                // Create Game
                int result = apiInstance.CreateGame(gameRules);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.CreateGame: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
gameRules	GameRules	Optional This rules define how your game will behave	[optional]

Return type

int

Authorization

admin-access

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetActions

List<Action> GetActions (int gameId, string mode = null)

Get games actions

Get all (not robot related) actions comitted to this game.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class GetActionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            // Configure API key authorization: admin-access
            config.AddApiKey("skey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("skey", "Bearer");

            var apiInstance = new GameApi(config);
            var gameId = 56;  // int | The id of the game to interact with
            var mode = mode_example;  // string | Defines wich entries to return (optional)  (default to ALL)

            try
            {
                // Get games actions
                List<Action> result = apiInstance.GetActions(gameId, mode);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.GetActions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
gameId	int	The id of the game to interact with
mode	string	Defines wich entries to return	[optional] [default to ALL]

Return type

List<Action>

Authorization

admin-access

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
201	Created	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGameState

GameInfo GetGameState (int gameId)

Get game status

Returns the status of a game

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class GetGameStateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            var apiInstance = new GameApi(config);
            var gameId = 56;  // int | The id of the game to interact with

            try
            {
                // Get game status
                GameInfo result = apiInstance.GetGameState(gameId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.GetGameState: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
gameId	int	The id of the game to interact with

Return type

GameInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGames

List<int> GetGames (bool? joinable = null, bool? unprotected = null)

Get all games

Returns a list of all hosted games

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class GetGamesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            var apiInstance = new GameApi(config);
            var joinable = true;  // bool? | true: only return joinable games (optional)  (default to false)
            var unprotected = true;  // bool? | true: only display games with no password set (optional)  (default to false)

            try
            {
                // Get all games
                List<int> result = apiInstance.GetGames(joinable, unprotected);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.GetGames: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
joinable	bool?	true: only return joinable games	[optional] [default to false]
unprotected	bool?	true: only display games with no password set	[optional] [default to false]

Return type

List

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProgrammingCard

RobotCommand GetProgrammingCard (int gameId, int statementId)

Get Programming Card

Get the programming card by id

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class GetProgrammingCardExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            // Configure API key authorization: player-auth
            config.AddApiKey("pat", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("pat", "Bearer");

            var apiInstance = new GameApi(config);
            var gameId = 56;  // int | The id of the game to interact with
            var statementId = 56;  // int | The id of the programming card

            try
            {
                // Get Programming Card
                RobotCommand result = apiInstance.GetProgrammingCard(gameId, statementId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.GetProgrammingCard: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
gameId	int	The id of the game to interact with
statementId	int	The id of the programming card

Return type

RobotCommand

Authorization

player-auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProgrammingCardIds

List<int> GetProgrammingCardIds (int gameId)

Get Programming Card IDs

Get the ids of all programming cards avainable in this game

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class GetProgrammingCardIdsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            // Configure API key authorization: player-auth
            config.AddApiKey("pat", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("pat", "Bearer");

            var apiInstance = new GameApi(config);
            var gameId = 56;  // int | The id of the game to interact with

            try
            {
                // Get Programming Card IDs
                List<int> result = apiInstance.GetProgrammingCardIds(gameId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.GetProgrammingCardIds: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
gameId	int	The id of the game to interact with

Return type

List

Authorization

player-auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProgrammingCards

List<RobotCommand> GetProgrammingCards (int gameId)

Get Programming cards

Returns the Programming cards in this game

Example

using System.Collections.Generic;
using System.Diagnostics;
using Tgm.Roborally.Api.Api;
using Tgm.Roborally.Api.Client;
using Tgm.Roborally.Api.Model;

namespace Example
{
    public class GetProgrammingCardsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://game.host/v1";
            // Configure API key authorization: player-auth
            config.AddApiKey("pat", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("pat", "Bearer");

            var apiInstance = new GameApi(config);
            var gameId = 56;  // int | The id of the game to interact with

            try
            {
                // Get Programming cards
                List<RobotCommand> result = apiInstance.GetProgrammingCards(gameId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GameApi.GetProgrammingCards: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
gameId	int	The id of the game to interact with

Return type

List<RobotCommand>

Authorization

player-auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

GameApi.md

Latest commit

History

GameApi.md

File metadata and controls

Tgm.Roborally.Api.Api.GameApi

CommitAction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateGame

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetActions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetGameState

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetGames

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetProgrammingCard

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetProgrammingCardIds

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetProgrammingCards

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details