From 4111971cbdae3a4700156a802f8e0c9309a9cf1e Mon Sep 17 00:00:00 2001 From: Zach Hilman Date: Mon, 10 Jun 2019 14:11:06 -0400 Subject: [PATCH] freezer: Update documentation --- src/core/tools/freezer.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/core/tools/freezer.h b/src/core/tools/freezer.h index 5edd049c18..b58de5472c 100644 --- a/src/core/tools/freezer.h +++ b/src/core/tools/freezer.h @@ -17,7 +17,14 @@ struct EventType; 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 { public: struct Entry {