freezer: Update documentation

This commit is contained in:
Zach Hilman 2019-06-10 14:11:06 -04:00
parent ed82fa3a91
commit 4111971cbd
1 changed files with 8 additions and 1 deletions

View File

@ -17,7 +17,14 @@ struct EventType;
namespace Tools { namespace Tools {
// A class that will effectively freeze memory values. /**
* This class allows the user to prevent an application from writing new values to certain memory
* locations. This has a variety of uses when attempting to reverse a game.
*
* One example could be a cheat to prevent Mario from taking damage in SMO. One could freeze the
* memory address that the game uses to store Mario's health so when he takes damage (and the game
* tries to write the new health value to memory), the value won't change.
*/
class Freezer { class Freezer {
public: public:
struct Entry { struct Entry {