summaryrefslogtreecommitdiffstats
path: root/src/core/tools/freezer.h
diff options
context:
space:
mode:
authorZach Hilman <zachhilman@gmail.com>2019-06-10 20:11:06 +0200
committerZach Hilman <zachhilman@gmail.com>2019-06-21 01:22:53 +0200
commit4111971cbdae3a4700156a802f8e0c9309a9cf1e (patch)
treef6ba35a21c43a191bd03bec1d27bb185efaf329c /src/core/tools/freezer.h
parentcore: Move Freezer class to tools namespace (diff)
downloadyuzu-4111971cbdae3a4700156a802f8e0c9309a9cf1e.tar
yuzu-4111971cbdae3a4700156a802f8e0c9309a9cf1e.tar.gz
yuzu-4111971cbdae3a4700156a802f8e0c9309a9cf1e.tar.bz2
yuzu-4111971cbdae3a4700156a802f8e0c9309a9cf1e.tar.lz
yuzu-4111971cbdae3a4700156a802f8e0c9309a9cf1e.tar.xz
yuzu-4111971cbdae3a4700156a802f8e0c9309a9cf1e.tar.zst
yuzu-4111971cbdae3a4700156a802f8e0c9309a9cf1e.zip
Diffstat (limited to 'src/core/tools/freezer.h')
-rw-r--r--src/core/tools/freezer.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/core/tools/freezer.h b/src/core/tools/freezer.h
index 5edd049c1..b58de5472 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 {