mirror/mm
1
0
Fork 0
mirror of https://github.com/zeldaret/mm.git synced 2026-07-10 14:04:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

z_en_test7.c Documentation Pass (#1497)

Browse Source 
* copy over docs

* more docs

* some docs

* more docs

* small cleanup

* more small cleanup

* more small cleanup

* lerp time

* small reordering

* feather type

* general owl warp docs

* more cleanup

* rm redundant info

* PR Review

* PR Review
This commit is contained in:
engineer124
2023-11-27 21:21:52 +11:00
committed by GitHub
parent 702f3cf44e
commit 5284302c8f
28 changed files with 765 additions and 740 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/regs.h
+1 -1
View File
@@ -144,7 +144,7 @@ extern RegEditor* gRegEditor;
#define R_PAUSE_DBG_MAP_CLOUD_Y XREG(53)
#define R_MOON_CRASH_TIMER_Y XREG(80)
#define R_MOON_CRASH_TIMER_X XREG(81)
#define R_PAUSE_OWLWARP_ALPHA XREG(87)
#define R_PAUSE_OWL_WARP_ALPHA XREG(87)
#define R_STORY_FILL_SCREEN_ALPHA XREG(91)
#define R_REVERSE_FLOOR_INDEX XREG(94)
#define R_MINIMAP_DISABLED XREG(95)
include/z64player.h
+17 -16
View File
@@ -1059,22 +1059,23 @@ typedef enum PlayerCueId {
#define PLAYER_GET_INITMODE(thisx) (((thisx)->params & 0xF00) >> 8)
typedef enum PlayerInitMode {
/* 0x0 */ PLAYER_INITMODE_0,
/* 0x1 */ PLAYER_INITMODE_1, // Spawning after pulling/putting-back Master sword // OoT leftover
/* 0x2 */ PLAYER_INITMODE_2,
/* 0x3 */ PLAYER_INITMODE_3,
/* 0x4 */ PLAYER_INITMODE_4,
/* 0x5 */ PLAYER_INITMODE_5,
/* 0x6 */ PLAYER_INITMODE_6,
/* 0x7 */ PLAYER_INITMODE_7,
/* 0x8 */ PLAYER_INITMODE_8,
/* 0x9 */ PLAYER_INITMODE_9,
/* 0xA */ PLAYER_INITMODE_A,
/* 0xB */ PLAYER_INITMODE_B,
/* 0xC */ PLAYER_INITMODE_TELESCOPE,
/* 0xD */ PLAYER_INITMODE_D,
/* 0xE */ PLAYER_INITMODE_E,
/* 0xF */ PLAYER_INITMODE_F
/* 0x0 */ PLAYER_INITMODE_0,
/* 0x1 */ PLAYER_INITMODE_1, // Spawning after pulling/putting-back Master sword // OoT leftover
/* 0x2 */ PLAYER_INITMODE_2,
/* 0x3 */ PLAYER_INITMODE_3,
/* 0x4 */ PLAYER_INITMODE_4,
/* 0x5 */ PLAYER_INITMODE_5,
/* 0x6 */ PLAYER_INITMODE_6,
/* 0x7 */ PLAYER_INITMODE_7,
/* 0x8 */ PLAYER_INITMODE_8,
/* 0x9 */ PLAYER_INITMODE_9,
/* 0xA */ PLAYER_INITMODE_A,
/* 0xB */ PLAYER_INITMODE_B,
/* 0xC */ PLAYER_INITMODE_TELESCOPE,
/* 0xD */ PLAYER_INITMODE_D,
/* 0xE */ PLAYER_INITMODE_E,
/* 0xF */ PLAYER_INITMODE_F,
/* 0x10 */ PLAYER_INITMODE_MAX // Must not exceed 0x10 as `PLAYER_GET_INITMODE` is limited to a nibble in player params
} PlayerInitMode;
#define PLAYER_PARAMS(startBgCamIndex, initMode) ((startBgCamIndex & 0xFF) | ((initMode & 0xF) << 8))
include/z64save.h
+6 -3
View File
@@ -275,7 +275,7 @@ typedef struct SavePlayerData {
/* 0x1D */ u8 isDoubleMagicAcquired; // "magic_ability"
/* 0x1E */ u8 doubleDefense; // "life_ability"
/* 0x1F */ u8 unk_1F; // "ocarina_round"
/* 0x20 */ u8 unk_20; // "first_memory"
/* 0x20 */ u8 owlWarpId; // See `OwlWarpId`, "first_memory"
/* 0x22 */ u16 owlActivationFlags; // "memory_warp_point"
/* 0x24 */ u8 unk_24; // "last_warp_pt"
/* 0x26 */ s16 savedSceneId; // "scene_data_ID"
@@ -324,7 +324,7 @@ typedef struct Save {
/* 0x07 */ u8 linkAge; // "link_age"
/* 0x08 */ s32 cutsceneIndex; // "day_time"
/* 0x0C */ u16 time; // "zelda_time"
/* 0x0E */ u16 owlSaveLocation;
/* 0x0E */ u16 owlWarpId; // See `OwlWarpId` enum
/* 0x10 */ s32 isNight; // "asahiru_fg"
/* 0x14 */ s32 timeSpeedOffset; // "change_zelda_time"
/* 0x18 */ s32 day; // "totalday"
@@ -460,6 +460,9 @@ typedef enum {
#define GET_PLAYER_FORM ((void)0, gSaveContext.save.playerForm)
#define GET_OWL_STATUE_ACTIVATED(owlWarpId) (((void)0, gSaveContext.save.saveInfo.playerData.owlActivationFlags) & (u16)gBitFlags[(owlWarpId)])
#define SET_OWL_STATUE_ACTIVATED(owlWarpId) (gSaveContext.save.saveInfo.playerData.owlActivationFlags = (((void)0, gSaveContext.save.saveInfo.playerData.owlActivationFlags) | (u16)gBitFlags[(owlWarpId)]))
#define SLOT(item) gItemSlots[item]
#define AMMO(item) gSaveContext.save.saveInfo.inventory.ammo[SLOT(item)]
#define INV_CONTENT(item) gSaveContext.save.saveInfo.inventory.items[SLOT(item)]
@@ -1653,7 +1656,7 @@ typedef enum {
#define STRAY_FAIRY_TOTAL 25 // total number of stray fairies, including those already in the Great Fairy Fountain
#define STRAY_FAIRY_SCATTERED_TOTAL 15 // original number of stray fairies in one dungeon area
void Sram_ActivateOwl(u8 owlId);
void Sram_ActivateOwl(u8 owlWarpId);
void Sram_ClearFlagsAtDawnOfTheFirstDay(void);
void Sram_SaveEndOfCycle(struct PlayState* play);
void Sram_IncrementDay(void);
include/z64scene.h
+16 -15
View File
@@ -560,7 +560,7 @@ typedef union {
} SceneCmd; // size = 0x8
// Sets cursor point options on the world map
typedef enum {
typedef enum RegionId {
/* -1 */ REGION_NONE = -1,
/* 0x0 */ REGION_GREAT_BAY,
/* 0x1 */ REGION_ZORA_HALL,
@@ -577,23 +577,24 @@ typedef enum {
} RegionId;
// Sets warp points for owl statues
typedef enum {
/* 0x0 */ OWL_WARP_GREAT_BAY_COAST,
/* 0x1 */ OWL_WARP_ZORA_CAPE,
/* 0x2 */ OWL_WARP_SNOWHEAD,
/* 0x3 */ OWL_WARP_MOUNTAIN_VILLAGE,
/* 0x4 */ OWL_WARP_CLOCK_TOWN,
/* 0x5 */ OWL_WARP_MILK_ROAD,
/* 0x6 */ OWL_WARP_WOODFALL,
/* 0x7 */ OWL_WARP_SOUTHERN_SWAMP,
/* 0x8 */ OWL_WARP_IKANA_CANYON,
/* 0x9 */ OWL_WARP_STONE_TOWER,
/* 0xA */ OWL_WARP_ENTRANCE, // Special index for warping to the entrance of a scene
/* 0xB */ OWL_WARP_MAX
typedef enum OwlWarpId {
/* 0x0 */ OWL_WARP_GREAT_BAY_COAST,
/* 0x1 */ OWL_WARP_ZORA_CAPE,
/* 0x2 */ OWL_WARP_SNOWHEAD,
/* 0x3 */ OWL_WARP_MOUNTAIN_VILLAGE,
/* 0x4 */ OWL_WARP_CLOCK_TOWN,
/* 0x5 */ OWL_WARP_MILK_ROAD,
/* 0x6 */ OWL_WARP_WOODFALL,
/* 0x7 */ OWL_WARP_SOUTHERN_SWAMP,
/* 0x8 */ OWL_WARP_IKANA_CANYON,
/* 0x9 */ OWL_WARP_STONE_TOWER,
/* 0xA */ OWL_WARP_ENTRANCE, // Special index for warping to the entrance of a scene
/* 0xB */ OWL_WARP_MAX,
/* 0xFF */ OWL_WARP_NONE = 0xFF
} OwlWarpId;
// Sets cloud visibility on the world map
typedef enum {
typedef enum TingleMapId {
/* 0 */ TINGLE_MAP_CLOCK_TOWN,
/* 1 */ TINGLE_MAP_WOODFALL,
/* 2 */ TINGLE_MAP_SNOWHEAD,