Class GameController

Controller to handle all game related requests

Index

Constructors

Methods

convertActionResultToGameState convertActionToReference convertGameObjectToReference convertTalkChoiceToReference executeAction handleActionRequest handleStateRequest

Constructors

constructor

new GameController(): GameController
Returns GameController

Methods

`Private`convertActionResultToGameState

convertActionResultToGameState(
actionResult?: ActionResult,
): Promise<undefined | GameState>
Convert the result of an action to a type of GameState.
Parameters
- OptionalactionResult: ActionResult
  Result of an action, can be undefined.
Returns Promise<undefined | GameState>
A type of GameState representing the result of the action or undefined when something went wrong.
- Defined in src/api/src/game-implementation/controllers/GameController.ts:98

`Private`convertActionToReference

convertActionToReference(action: Action): Promise<ActionReference>
Convert an action instance into an action reference for the client application
Parameters
- action: Action
  Action instance to convert
Returns Promise<ActionReference>
Action reference for the client application
- Defined in src/api/src/game-implementation/controllers/GameController.ts:186

`Private`convertGameObjectToReference

convertGameObjectToReference(
gameObject: GameObject,
): Promise<GameObjectReference>
Convert a game object instance into a game object reference for the client application
Parameters
- gameObject: GameObject
  Game object instance to convert
Returns Promise<GameObjectReference>
Game object reference for the client application
- Defined in src/api/src/game-implementation/controllers/GameController.ts:201

`Private`convertTalkChoiceToReference

convertTalkChoiceToReference(
action: TalkActionResult,
choice: TalkChoice,
): ActionReference
Convert a talk choice into an action reference for the client application
Parameters
- action: TalkActionResult
  Action instance to convert
- choice: TalkChoice
  Choice instance to convert
Returns ActionReference
Action reference for the client application
- Defined in src/api/src/game-implementation/controllers/GameController.ts:171

`Private`executeAction

executeAction(
actionAlias: string,
gameObjectAliases?: string[],
): Promise<undefined | GameState>
Execute the requested action and convert the result to a type of GameState.
Parameters
- actionAlias: string
  Alias of action to execute
- OptionalgameObjectAliases: string[]
  Optional list of game object aliases to execute the action on
Returns Promise<undefined | GameState>
A type of GameState representing the result of the action or undefined when something went wrong.
- Defined in src/api/src/game-implementation/controllers/GameController.ts:68

handleActionRequest

handleActionRequest(req: Request, res: Response): Promise<void>
Handle the request to execute an action for the current player
Parameters
- req: Request
- res: Response
Returns Promise<void>
Remarks
Response is a 200 with a GameState on success, otherwise a 500.
- Defined in src/api/src/game-implementation/controllers/GameController.ts:42

handleStateRequest

handleStateRequest(_: Request, res: Response): Promise<void>
Handle the request to retrieve the game state for the current player
Parameters
- _: Request
- res: Response
Returns Promise<void>
Remarks
Response is a 200 with a GameState on success, otherwise a 500.
- Defined in src/api/src/game-implementation/controllers/GameController.ts:23