Skip to content
Snippets Groups Projects
Verified Commit f598d46d authored by João Magalhães's avatar João Magalhães :rocket:
Browse files

docs: add GameShark structure docstring

Contains detailed information about the inner structure.
parent 2a29c13f
No related branches found
No related tags found
No related merge requests found
Pipeline #3979 passed
...@@ -8,6 +8,18 @@ use crate::rom::RomType; ...@@ -8,6 +8,18 @@ use crate::rom::RomType;
#[cfg(feature = "wasm")] #[cfg(feature = "wasm")]
use wasm_bindgen::prelude::*; use wasm_bindgen::prelude::*;
/// Implementation of the GameShark cheat code system
/// that "patches" RAM entries, making use of the V-Blank
/// time to do that.
///
/// The codes in the GameShark system are in an hexadecimal
/// ASCII format in the form of "ABCDGHEF" where:
/// AB = RAM bank
/// CD = New data
/// GH = Address LSB
/// EF = Address MSB
///
/// [Wikipedia - GameShark](https://en.wikipedia.org/wiki/GameShark)
#[derive(Clone)] #[derive(Clone)]
#[cfg_attr(feature = "wasm", wasm_bindgen)] #[cfg_attr(feature = "wasm", wasm_bindgen)]
pub struct GameShark { pub struct GameShark {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment