Skip to content

Latest commit

 

History

History
487 lines (321 loc) · 19.4 KB

DungeonsAndTrollsApi.md

File metadata and controls

487 lines (321 loc) · 19.4 KB

{{classname}}

All URIs are relative to https://dt.garage-trip.cz/

Method HTTP request Description
DungeonsAndTrollsAssignSkillPoints Post /v1/assign-skill-points Send multiple commands to the Character bound to the logged user. The order of execution is defined in the message.
DungeonsAndTrollsBuy Post /v1/buy Buy Items identified by the provided ID for the Character bound to the logged user.
DungeonsAndTrollsCommands Post /v1/commands Send multiple commands to the Character bound to the logged user. The order of execution is defined in the message.
DungeonsAndTrollsGame Get /v1/game Sends all info about the game.
DungeonsAndTrollsGameLevel Get /v1/game/{level} Sends all info about the game level.
DungeonsAndTrollsLevels Get /v1/levels Sends info about
DungeonsAndTrollsMonstersCommands Post /v1/monsters-commands Control monsters. Admin only.
DungeonsAndTrollsMove Post /v1/move Assign skill point to the attribute for the Character bound to the logged user.
DungeonsAndTrollsPickUp Post /v1/pick-up Equip the Item from the ground identified by the provided ID for the Character bound to the logged user (unused).
DungeonsAndTrollsPlayers Get /v1/players Sends all info about all players.
DungeonsAndTrollsRegister Post /v1/register Register provided User to the Game and create a character.
DungeonsAndTrollsRespawn Post /v1/respawn Respawn the Character bound to the logged user.
DungeonsAndTrollsSkill Post /v1/skill Use a skill (provided by an item) by the Character bound to the logged user.
DungeonsAndTrollsYell Post /v1/yell The Character bound to the logged user yells a messages (visible for everyone).

DungeonsAndTrollsAssignSkillPoints

interface{} DungeonsAndTrollsAssignSkillPoints(ctx, body, optional) Send multiple commands to the Character bound to the logged user. The order of execution is defined in the message.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsAttributes
optional *DungeonsAndTrollsApiDungeonsAndTrollsAssignSkillPointsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsAssignSkillPointsOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsBuy

interface{} DungeonsAndTrollsBuy(ctx, body, optional) Buy Items identified by the provided ID for the Character bound to the logged user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsIdentifiers
optional *DungeonsAndTrollsApiDungeonsAndTrollsBuyOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsBuyOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsCommands

interface{} DungeonsAndTrollsCommands(ctx, body, optional) Send multiple commands to the Character bound to the logged user. The order of execution is defined in the message.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsCommandsBatch
optional *DungeonsAndTrollsApiDungeonsAndTrollsCommandsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsCommandsOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsGame

DungeonsandtrollsGameState DungeonsAndTrollsGame(ctx, optional) Sends all info about the game.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DungeonsAndTrollsApiDungeonsAndTrollsGameOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsGameOpts struct

Name Type Description Notes
blocking optional.Bool default false
items optional.Bool default true
fogOfWar optional.Bool default false

Return type

DungeonsandtrollsGameState

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DungeonsAndTrollsGameLevel

DungeonsandtrollsGameState DungeonsAndTrollsGameLevel(ctx, level, optional) Sends all info about the game level.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
level int32
optional *DungeonsAndTrollsApiDungeonsAndTrollsGameLevelOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsGameLevelOpts struct

Name Type Description Notes

blocking | optional.Bool| default false | items | optional.Bool| default true | fogOfWar | optional.Bool| default false |

Return type

DungeonsandtrollsGameState

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DungeonsAndTrollsLevels

DungeonsandtrollsAvailableLevels DungeonsAndTrollsLevels(ctx, optional) Sends info about

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DungeonsAndTrollsApiDungeonsAndTrollsLevelsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsLevelsOpts struct

Name Type Description Notes
blocking optional.Bool default false

Return type

DungeonsandtrollsAvailableLevels

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DungeonsAndTrollsMonstersCommands

interface{} DungeonsAndTrollsMonstersCommands(ctx, body, optional) Control monsters. Admin only.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsCommandsForMonsters
optional *DungeonsAndTrollsApiDungeonsAndTrollsMonstersCommandsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsMonstersCommandsOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsMove

interface{} DungeonsAndTrollsMove(ctx, body, optional) Assign skill point to the attribute for the Character bound to the logged user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsPosition
optional *DungeonsAndTrollsApiDungeonsAndTrollsMoveOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsMoveOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsPickUp

interface{} DungeonsAndTrollsPickUp(ctx, body, optional) Equip the Item from the ground identified by the provided ID for the Character bound to the logged user (unused).

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsIdentifier
optional *DungeonsAndTrollsApiDungeonsAndTrollsPickUpOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsPickUpOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsPlayers

DungeonsandtrollsPlayersInfo DungeonsAndTrollsPlayers(ctx, optional) Sends all info about all players.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DungeonsAndTrollsApiDungeonsAndTrollsPlayersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsPlayersOpts struct

Name Type Description Notes
blocking optional.Bool default false

Return type

DungeonsandtrollsPlayersInfo

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DungeonsAndTrollsRegister

DungeonsandtrollsRegistration DungeonsAndTrollsRegister(ctx, body) Register provided User to the Game and create a character.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsUser

Return type

DungeonsandtrollsRegistration

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsRespawn

interface{} DungeonsAndTrollsRespawn(ctx, body, optional) Respawn the Character bound to the logged user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body interface{}
optional *DungeonsAndTrollsApiDungeonsAndTrollsRespawnOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsRespawnOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsSkill

interface{} DungeonsAndTrollsSkill(ctx, body, optional) Use a skill (provided by an item) by the Character bound to the logged user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsSkillUse
optional *DungeonsAndTrollsApiDungeonsAndTrollsSkillOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsSkillOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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

DungeonsAndTrollsYell

interface{} DungeonsAndTrollsYell(ctx, body, optional) The Character bound to the logged user yells a messages (visible for everyone).

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body DungeonsandtrollsMessage
optional *DungeonsAndTrollsApiDungeonsAndTrollsYellOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DungeonsAndTrollsApiDungeonsAndTrollsYellOpts struct

Name Type Description Notes

blocking | optional.| default true |

Return type

interface{}

Authorization

ApiKeyAuth

HTTP request headers

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

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