6. Cheat operations

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.

Header parts:

GAME_ERROR CheatReset() override;
GAME_ERROR GetMemory(GAME_MEMORY type, uint8_t*& data, size_t& size) override;
GAME_ERROR SetCheat(unsigned int index, bool enabled, const std::string& code) override;

Source parts:

GAME_ERROR CMyInstance::CheatReset()
{
  return GAME_ERROR_NOT_IMPLEMENTED;
}
 
GAME_ERROR CMyInstance::GetMemory(GAME_MEMORY type, uint8_t*& data, size_t& size)
{
  return GAME_ERROR_NOT_IMPLEMENTED;
}
 
GAME_ERROR CMyInstance::SetCheat(unsigned int index, bool enabled, const std::string& code)
{
  return GAME_ERROR_NOT_IMPLEMENTED;
}

Modules
	Group header include
	Group source include

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