TxtCaptchaStage Class Reference

the TxtCaptchaStage class is a class that represents a txt captcha stage in the game More...

#include <txt_captcha_stage.h>

Inheritance diagram for TxtCaptchaStage:

Collaboration diagram for TxtCaptchaStage:

Public Member Functions
	TxtCaptchaStage (GameManager *gameManager)
	constructor for TxtCaptchaStage More...
bool	validateStage ()
	validates the stage More...
void	update (const rapidjson::Value &req)
	updates the stage More...
rapidjson::Value	getFieldStates (rapidjson::Document::AllocatorType &allocator)
	gets the field states More...
bool	setNewChallenge ()
Public Member Functions inherited from Stage
std::vector< std::string >	getFieldErrors (std::string field)
	gets the field errors for a given field More...
std::string	getStageName ()
	gets the stage name More...
rapidjson::Value	getStageState (rapidjson::Document::AllocatorType &allocator)
	creates the JSON representation of the stage state More...
bool	isFieldDisabled (const std::string &field)

Additional Inherited Members
Protected Member Functions inherited from Stage
	Stage (GameManager *gameManager)
rapidjson::Value	createFieldState (const std::string &field, rapidjson::Value &fieldValue, rapidjson::Document::AllocatorType &allocator)
	creates the JSON representation of the field states More...
Protected Attributes inherited from Stage
GameManager *	gm
std::string	name = ""
std::map< std::string, std::vector< std::string > >	field_errors
const int	REQ_FIELD_INDEX = 1
const int	REQ_VALUE_INDEX = 2

Detailed Description

the TxtCaptchaStage class is a class that represents a txt captcha stage in the game

contains concrete stage implementions for the txt captcha stage in the game

Constructor & Destructor Documentation

TxtCaptchaStage()

TxtCaptchaStage::TxtCaptchaStage

(

GameManager *

gameManager

)

constructor for TxtCaptchaStage

Parameters

gameManager

the game manager object owning this stage

Member Function Documentation

getFieldStates()

rapidjson::Value TxtCaptchaStage::getFieldStates ( rapidjson::Document::AllocatorType &  allocator )

virtual

gets the field states

gets the field states by returning a rapidjson object containing the field states

Parameters

allocator

the rapidjson allocator

Returns

the rapidjson value object containing the field states

Implements Stage.

update()

void TxtCaptchaStage::update ( const rapidjson::Value &  req )

virtual

updates the stage

updates the stage by updating the field values

Parameters

req	the rapidjson request object containing the field to update and the new value

Implements Stage.

validateStage()

bool TxtCaptchaStage::validateStage ( )

virtual

validates the stage

validates the stage by checking if the requirements are met

Returns

true if the stage is valid, false otherwise

Implements Stage.

---

The documentation for this class was generated from the following files:

• src/game/stages/txt_captcha_stage.h
• src/game/stages/txt_captcha_stage.cpp