redstrate/physis
1
Fork 0
mirror of https://github.com/redstrate/Physis.git synced 2025-04-24 13:37:44 +00:00
Code Activity

Improve common module docs

Browse source
This commit is contained in:
Joshua Goins 2023-09-22 18:15:23 -04:00
parent 2ce18ec66a
commit 80f80ac0f5
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/common.rs
View file

@ -10,7 +10,7 @@ use binrw::binrw;
#[brw(repr(u8))] #[brw(repr(u8))]
#[repr(u8)] #[repr(u8)]
#[derive(Copy, Clone)] #[derive(Copy, Clone)]
/// The language the game data is written for. /// The language the game data is written for. Some of these languages are supported in the Global region.
pub enum Language { pub enum Language {
/// Used for data that is language-agnostic, such as item data. /// Used for data that is language-agnostic, such as item data.
None, None,
@ -44,10 +44,12 @@ pub fn get_language_code(lang: &Language) -> &'static str {
} }
} }
/// The region of the game. Used to denote the region a patch is meant for.
#[binrw] #[binrw]
#[brw(repr = i16)] #[brw(repr = i16)]
#[derive(Debug, PartialEq, Eq)] #[derive(Debug, PartialEq, Eq)]
pub enum Region { pub enum Region {
/// The global region.
Global = -1, // TODO: find patch codes for other regions :-) Global = -1, // TODO: find patch codes for other regions :-)
} }

2
src/lib.rs
View file

@ -34,7 +34,7 @@ pub mod exl;
/// Reading equipment and equipment-related data. /// Reading equipment and equipment-related data.
pub mod equipment; pub mod equipment;
/// Common structures used by other modules. /// Common structures, enumerations and functions used by many modules.
pub mod common; pub mod common;
/// Methods for installing game and boot patches. /// Methods for installing game and boot patches.