Detailed Description

Cheat operations

Cheat operation parts in interface:
Copy this to your project and extend with your parts or leave functions complete away where not used or supported.

Function Documentation

◆ CheatReset()

virtual GAME_ERROR CheatReset ( )

inlinevirtual

Reset the cheat system.

Returns: The error, or GAME_ERROR_NO_ERROR if the cheat system was reset

◆ GetMemory()

virtual GAME_ERROR GetMemory	(	GAME_MEMORY	type,
		uint8_t *&	data,
		size_t &	size )

inlinevirtual

Get a region of memory.

Parameters

[in]	type	The type of memory to retrieve
[in]	data	Set to the region of memory; must remain valid until UnloadGame() is called
[in]	size	Set to the size of the region of memory

Returns: The error, or GAME_ERROR_NO_ERROR if data was set to a valid buffer

◆ SetCheat()

virtual GAME_ERROR SetCheat	(	unsigned int	index,
		bool	enabled,
		const std::string &	code )

inlinevirtual

Set a cheat code.

Parameters

[in]	index
[in]	enabled
[in]	code

Returns: The error, or GAME_ERROR_NO_ERROR if the cheat was set

◆ RCGenerateHashFromFile()

virtual GAME_ERROR RCGenerateHashFromFile	(	std::string &	hash,
		unsigned int	consoleID,
		const std::string &	filePath )

inlinevirtual

Generates a RetroAchievements hash for a given game that can be used to identify the game by RetroAchievements.

Parameters

[out]	hash	The generated hash of the file
[in]	consoleID	The console ID as it is defined by rcheevos for the console the ROM is made for
[in]	filePath	The path of the rom

Returns: The error, or GAME_ERROR_NO_ERROR if the hash was generated successfully

◆ RCGetGameIDUrl()

virtual GAME_ERROR RCGetGameIDUrl	(	std::string &	url,
		const std::string &	hash )

inlinevirtual

Gets a URL to the endpoint that returns the game ID.

Parameters

[out]	url	The URL to GET the game ID
[in]	hash	The hash of the rom

Returns: The error, or GAME_ERROR_NO_ERROR if the URL was created

◆ RCGetPatchFileUrl()

virtual GAME_ERROR RCGetPatchFileUrl	(	std::string &	url,
		const std::string &	username,
		const std::string &	token,
		unsigned int	gameID )

inlinevirtual

Gets a URL to the endpoint that returns the patch file.

Parameters

[out]	url	The URL to GET the game patch file
[in]	username	The RetroAchievements username of the user
[in]	token	The login token to RetroAchievements of the user
[in]	gameID	The ID of the game in RetroAchievements API

Returns: The error, or GAME_ERROR_NO_ERROR if the URL was created

◆ SetRetroAchievementsCredentials()

virtual GAME_ERROR SetRetroAchievementsCredentials	(	const std::string &	username,
		const std::string &	token )

inlinevirtual

Set the credentials of the RetroAchievements user.

Parameters

[in]	username	The RetroAchievements username of the user
[in]	token	The login token to RetroAchievements of the user

Returns: The error, or GAME_ERROR_NO_ERROR if the call was successful

◆ RCPostRichPresenceUrl()

virtual GAME_ERROR RCPostRichPresenceUrl	(	std::string &	url,
		std::string &	postData,
		const std::string &	username,
		const std::string &	token,
		unsigned int	gameID,
		const std::string &	richPresence )

inlinevirtual

Gets a URL to the endpoint that updates the rich presence in the user's RetroAchievements profile.

Parameters

[out]	url	The URL to POST the rich presence to RetroAchievements
[out]	postData	The post data of the request
[in]	username	The RetroAchievements username of the user
[in]	token	The login token to RetroAchievements of the user
[in]	gameID	The ID of the game in RetroAchievements API
[in]	richPresence	The rich presence evaluation to POST

Returns: The error, or GAME_ERROR_NO_ERROR if the URL and post data were created

◆ RCEnableRichPresence()

virtual GAME_ERROR RCEnableRichPresence ( const std::string & script )

inlinevirtual

Enables rich presence.

Parameters

[in] script The rich presence script from RetroAchievements

Returns: The error, or GAME_ERROR_NO_ERROR if rich presence was enabled

◆ RCGetRichPresenceEvaluation()

virtual GAME_ERROR RCGetRichPresenceEvaluation	(	std::string &	evaluation,
		unsigned int	consoleID )

inlinevirtual

Gets the rich presence evaluation for the current frame. Rich presence must be enabled first or this will fail.

Parameters

[out]	evaluation	The evaluation of what the player is doing in the game this frame
[in]	consoleID	The console ID as it is defined by rcheevos for the console the rom is made for

Returns: The error, or GAME_ERROR_NO_ERROR if the evaluation was created successfully

◆ ActivateAchievement()

virtual GAME_ERROR ActivateAchievement	(	unsigned int	cheevoId,
		const std::string &	memAddrExpression )

inlinevirtual

Activate an achievement.

Parameters

[in]	cheevoId	The achievement ID
[in]	memAddrExpression	Achievement memory expression from patch data as a string

Returns: The error, or GAME_ERROR_NO_ERROR if the call was successful

◆ GetCheevoUrlId()

virtual GAME_ERROR GetCheevoUrlId ( const std::function< void(const std::string &achievementUrl, unsigned int cheevoId)> & callback )

inlinevirtual

Get triggered achievement URL and ID pairs.

Parameters

[in] callback Callback invoked once per triggered achievement during this call. It may be called zero or more times before the function returns. Implementations must not retain/copy the callback for later use. The URL string reference is valid only for the callback invocation and must be copied if needed afterwards.

Returns: The error, or GAME_ERROR_NO_ERROR if the call was successful

◆ RCResetRuntime()

virtual GAME_ERROR RCResetRuntime ( )

inlinevirtual

Resets the runtime. Must be called each time a new rom is starting and when the savestate is changed.

Returns: The error, or GAME_ERROR_NO_ERROR if the runtime was reset successfully