ac-decomp/include/m_common_data.h

#ifndef M_COMMON_DATA_H
#define M_COMMON_DATA_H

#include "types.h"
#include "m_actor_type.h"
#include "m_land_h.h"
#include "lb_rtc.h"
#include "m_flashrom.h"
#include "m_home_h.h"
#include "m_private.h"
#include "m_npc.h"
#include "m_field_make.h"
#include "m_notice.h"
#include "m_shop.h"
#include "m_kabu_manager.h"
#include "m_post_office.h"
#include "m_police_box.h"
#include "m_snowman.h"
#include "m_config.h"
#include "m_island.h"
#include "m_needlework.h"
#include "m_museum_display.h"
#include "m_lib.h"
#include "m_field_assessment.h"
#include "m_mushroom.h"
#include "m_clip.h"
#include "m_event.h"
#include "m_scene.h"
#include "m_npc_walk.h"
#include "m_mask_cat.h"
#include "m_npc_schedule_h.h"
#include "m_all_grow.h"

#ifdef __cplusplus
extern "C" {
#endif

#define SCHEDULE_NUM ANIMAL_NUM_MAX + mISL_ISLANDER_NUM

typedef struct time_s {
  u32 season;
  u32 term_idx;
  s16 bgitem_profile;
  s16 bgitem_bank;
  int now_sec;
  lbRTC_time_c rtc_time;
  s16 rad_min; /* clock hand radial position for mins */
  s16 rad_hour; /* clock hand radial position for hours */
  u8 time_signal;
  u8 under_sec;
  u8 disp;
  u8 rtc_crashed;
  int rtc_enabled;
  int add_sec;
  int add_idx;
} Time_c;

/* sizeof(PlusBridge_c) == 8 */
typedef struct plus_bridge_s {
  /* 0x00 */ u8 block_x;
  /* 0x01 */ u8 block_z;
  /* 0x02 */ struct {
    u8 exists:1;
    u8 pending:1;
    u8 pad:6;
  };
  /* 0x04 */ lbRTC_ymd_t build_date;
} PlusBridge_c;

typedef struct Save_s {
  /* 0x000000 */ mFRm_chk_t save_check; /* save information */
  /* 0x000014 */ int scene_no; /* current 'scene' id */
  /* 0x000018 */ u8 now_npc_max; /* current number of villagers living in town (see mNpc_(Add/Sub)NowNpcMax) */
  /* 0x000019 */ u8 remove_animal_idx; /* index of the villager which is scheduled to leave town, 0xFF when none selected */
  /* 0x00001A */ u16 copy_protect; /* 'unique' value between [1, 65520] used for copy protection (see mCD_get_land_copyProtect) */
  /* 0x00001C */ u8 pad_1C[4];
  /* 0x000020 */ Private_c private[PLAYER_NUM]; /* player data */
  /* 0x009120 */ mLd_land_info_c land_info; /* town name & id */
  /* 0x00912C */ mNtc_board_post_c noticeboard[mNtc_BOARD_POST_COUNT]; /* noticeboard posts */
  /* 0x009CE4 */ u8 pad_9CE4[4];
  /* 0x009CE8 */ mHm_hs_c homes[PLAYER_NUM]; /* player house data */
  /* 0x0137A8 */ mFM_fg_c fg[FG_BLOCK_Z_NUM][FG_BLOCK_X_NUM]; /* fg items (fg = foreground?) */
  /* 0x0173A8 */ mFM_combination_c combi_table[BLOCK_Z_NUM][BLOCK_X_NUM]; /* acre 'combination' data */
  /* 0x017438 */ Animal_c animals[ANIMAL_NUM_MAX]; /* villagers in town */
  /* 0x020330 */ AnmPersonalID_c last_removed_animal_id; /* ID of last villager who left town */
  /* 0x020340 */ Shop_c shop; /* Nook's shop */
  /* 0x020480 */ Kabu_price_c kabu_price_schedule; /* Stalk Market info */
  /* 0x020498 */ mEv_event_save_c event_save_data;
  /* 0x020554 */ u8 _20554[0x20688 - 0x20554]; /* active event data? */
  /* 0x020688 */ mActor_name_t fruit; /* town fruit type */
  /* 0x02068A */ u8 house_arrangement; /* 2 bits for each player for the # of house they own */
  /* 0x02068B */ u8 num_statues; /* number of statues built for players who have paid off their debts */
  /* 0x02068C */ lbRTC_time_c all_grow_renew_time; /* renewal time for fg items handled by mAgrw_RenewalFgItem_ovl */
  /* 0x020694 */ PostOffice_c post_office; /* post office data */
  /* 0x020ED0 */ PoliceBox_c police_box; /* police station lost & found */
  /* 0x020EF8 */ mSN_snowman_save_c snowmen; /* saved snowmen data */
  /* 0x020F08 */ u64 melody; /* town tune, each nibble is a note (16 notes) */
  /* 0x020F10 */ Config_c config; /* saved config for sound mode, voice mode, and vibration */
  /* 0x020F14 */ lbRTC_ymd_t renew_time; /* next renew date */
  /* 0x020F18 */ u8 station_type; /* train station type */
  /* 0x020F19 */ u8 weather; /* upper nibble is intensity, lower nibble is type */
  /* 0x020F1A */ u8 save_exist; /* unsure, set in mCD_SaveHome_bg_set_data (1) & mCD_SaveHome_bg (bss) */
  /* 0x020F1B */ u8 npc_force_go_home; /* when set to 1, forces the 'm_go_home' code to activate */
  /* 0x020F1C */ u16 deposit[FG_BLOCK_X_NUM * FG_BLOCK_Z_NUM][UT_Z_NUM]; /* flags for which items are buried around town */
  /* 0x0212DC */ lbRTC_time_c last_grow_time; /* last time that a new villager moved into town */
  /* 0x0212E4 */ mPr_mother_mail_info_c mother_mail[PLAYER_NUM]; /* info on when mom sent player letters and what event was sent */
  /* 0x02131C */ mMsr_MushTime_c mushroom_time; /* last time mushroom season info was updated */
  /* 0x021322 */ u8 _tmp21322[0x02137E - 0x021322];
  /* 0x02137E */ lbRTC_time_c treasure_buried_time; /* last time treasure was actually buried */
  /* 0x021386 */ lbRTC_time_c treasure_checked_time; /* last time check to bury treasure was executed */
  /* 0x02138E */ u8 saved_rom_debug; /* flag to set save to 'debug rom' mode */
  /* 0x02138F */ u8 snowman_year; /* year last snowman was built */
  /* 0x021390 */ u8 snowman_month; /* month last snowman was built */
  /* 0x021391 */ u8 snowman_day; /* day last snowman was built */
  /* 0x021392 */ u8 snowman_hour; /* hour last snowman was built */
  /* 0x021393 */ u8 haniwa_scheduled; /* when set, gyroids will be spwaned */
  /* 0x021394 */ u8 dust_flag; /* set by field assessment for too much 'dust' (garbage) around town, causes immediate fail of town ranking */
  /* 0x021395 */ u8 clear_grass; /* set by Wisp, removes all weeds */
  /* 0x021396 */ lbRTC_ymd_t event_year_ymd; /* might not exist and just be lbRTC_year_t */
  /* 0x02139A */ u8 unused_2139A[6];
  /* 0x0213A0 */ u8 keep_house_size[PLAYER_NUM]; /* saved flags for house sizes */
  /* 0x0213A4 */ lbRTC_ymd_t force_remove_date; /* last time the NPC force remove timer was updated */
  /* 0x0213A8 */ mMmd_info_c museum_display; /* museum display bits */
  /* 0x0213E7 */ u8 _tmp6[0x213F0 - 0x213E7];
  /* 0x0213F0 */ PlusBridge_c plus_bridge; /* additional bridge info */
  /* 0x021400 */ mNW_needlework_c needlework; /* Able Sisters' designs */
  /* 0x022500 */ u8 _tmp7[0x22528 - 0x22500];
  /* 0x022528 */ OSTime time_delta; /* time delta against GC RTC */
  /* 0x022540 */ Island_c island; /* island data */
  /* 0x023E40 */ mAGrw_AllGrow_c allgrow_ss_pos_info;
  /* 0x023E68 */ u8 _23E68[0x23F20 - 0x23E68];
  /* 0x023F20 */ MaskCat_c mask_cat;
  /* 0x024160 */ Anmret_c return_animal; /* information about villager which moved back in to your town after moving to someone else's town */
  /* 0x02416C */ u8 _tmp10[0x24174 - 0x2416C];
  /* 0x024174 */ u8 insect_term; /* current insect term idx */
  /* 0x024175 */ u8 insect_term_transition_offset; /* days offset from end of term to begin transition */
  /* 0x024176 */ u8 gyoei_term; /* current fish term idx */
  /* 0x024177 */ u8 gyoei_term_transition_offset; /* days offset from end of term to begin transition */
  /* 0x024178 */ mFAs_GoodField_c good_field; /* field assessment last info */
  /* 0x024184 */ u8 bg_tex_idx; /* Grass type */
  /* 0x024185 */ u8 _24185[0x2418A - 0x24185];
  /* 0x02418A */ u8 town_day;
  /* 0x02418B */ u8 _2418B[0x241A0 - 0x2418B];
  /* 0x0241A0 */ lbRTC_time_c saved_auto_nwrite_time; /* save data notice time used for fishing tourney results? */
  /* 0x0241A8 */ u8 _241A8[0x26000 - 0x241A8];
} Save_t;

typedef union save_u {
  Save_t save;
  //u8 raw[0x26000]; /* Temp to force length */
} Save;

/* sizeof(common_data_t) == 0x2DC00 */
typedef struct common_data_s {
  /* 0x000000 */ Save save;
  /* 0x026000 */ u8 game_started;
  /* 0x026001 */ u8 field_type;
  /* 0x026002 */ u8 field_draw_type;
  /* 0x026003 */ u8 player_no;
  /* 0x026004 */ int last_scene_no;
  /* 0x026008 */ int player_data_mode;
  /* 0x02600C */ Clip_c clip;
  /* 0x026110 */ Time_c time;
  /* 0x02613C */ Private_c* now_private;
  /* 0x026140 */ mHm_hs_c* now_home;
  /* 0x026144 */ u8 map_flag;
  /* 0x026145 */ u8 fish_location;
  /* 0x026146 */ u8 tmp0[0x2614D - 0x26146];
  /* 0x02614D */ u8 transFadeDuration;
  /* 0x02614E */ u8 transWipeSpeed;
  /* 0x02614F */ u8 wipeType; /* maybe unused? */
  /* 0x026150 */ s16 bg_item_type;
  /* 0x026152 */ s16 bg_item_profile;
  /* 0x026154 */ u8 _26154[0x26164 - 0x26154];
  /* 0x026164 */ mNpc_NpcList_c npclist[ANIMAL_NUM_MAX];
  /* 0x0264AC */ mNpc_NpcList_c unk_264AC; // fits exact size of npc list struct, seems unused
  /* 0x0264E4 */ mNpc_NpcList_c island_npclist[1]; // TODO: define for island npc count
  /* 0x02651C */ mActor_name_t house_owner_name;
  /* 0x02651E */ mActor_name_t last_field_id;
  /* 0x026520 */ u8 in_initial_block; /* when TRUE, the player is in the acre which they exited a building. FALSE otherwise. */
  /* 0x026521 */ u8 submenu_disabled; /* when set, submenus cannot be accessed from start button */
  /* 0x026522 */ u8 sunlight_flag;
  /* 0x026523 */ u8 train_flag;
  /* 0x026522 */ u8 _26524[0x2666C - 0x26524];
  /* 0x02666C */ s16 weather;
  /* 0x02666E */ s16 weather_intensity;
  /* 0x026670 */ lbRTC_time_c weather_time;
  /* 0x026678 */ u8 _26678[0x2669C - 0x26678];
  /* 0x02669C */ mQst_not_saved_c quest;
  /* 0x0266A4 */ int scene_from_title_demo; /* next scene to be loaded when title demo finishes */
  /* 0x0266A8 */ mNPS_schedule_c npc_schedule[SCHEDULE_NUM];
  /* 0x0267A8 */ mNpc_walk_c npc_walk;
  /* 0x026838 */ u8 _26838[0x28528 - 0x26838];
  /* 0x028528 */ int snowman_msg_id;
  /* 0x02852C */ s16 money_power;
  /* 0x02852E */ s16 goods_power;
  /* 0x028530 */ Door_data_c door_data; /* misc door data */
  /* 0x028544 */ Door_data_c structure_exit_door_data; /* door data for when exiting a building */
  /* 0x028558 */ u8 tmp1[0x028592 - 0x028558];
  /* 0x028592 */ s16 demo_profiles[mDemo_CLIP_TYPE_NUM - 1];
  /* 0x028596 */ u8 _28596[0x285C0 - 0x28596];
  /* 0x0285C0 */ s8 player_decoy_flag;
  /* 0x0285C1 */ u8 _285C1[0x028838 - 0x0285C1];
  /* 0x028838 */ s8 player_bee_swell_flag;
  /* 0x028839 */ s8 player_bee_chase_flag;
  /* 0x02883A */ u8 goki_shocked_flag;
  /* 0x02883B */ u8 time_changed_flag;
  /* 0x02883C */ u8 unable_to_wade_flag;
  /* 0x02883D */ u8 _02883D;
  /* 0x02883E */ u8 train_coming_flag; /* state tracker for when train is going to spawn/has spawned */
  /* 0x02883F */ u8 train_exists_flag; /* state tracker for when train exists */
  /* 0x028840 */ u8 train_control_state; /* current train state */
  /* 0x028841 */ u8 train_last_control_state; /* previous train state */
  /* 0x028842 */ u8 train_signal;
  /* 0x028843 */ u8 train_day;
  /* 0x028844 */ u8 train_action;
  /* 0x028845 */ u8 train_timer;
  /* 0x028848 */ u32 train_start_timer;
  /* 0x02884C */ f32 train_speed;
  /* 0x028850 */ xyz_t train_position;
  /* 0x02885C */ f32 unused_02885C;
  /* 0x028860 */ f32 unused_028860;
  /* 0x028864 */ u16 unused_028864;
  /* 0x028866 */ u16 unused_028866;
  /* 0x028868 */ u8 reset_flag;
  /* 0x028869 */ u8 reset_type;
  /* 0x02886A */ u8 force_mail_delivery_flag;
  /* 0x02886B */ u8 post_girl_npc_type;
  /* 0x02886C */ xyz_t ball_pos;
  /* 0x028878 */ u8 ball_type;
  /* 0x028879 */ u8 auto_nwrite_count;
  /* 0x02887A */ lbRTC_year_t auto_nwrite_year;
  /* 0x02887C */ u8 save_error_type; /* set to one of the mFRm_ERROR_* states when save is invalid */
  /* 0x02887D */ u8 train_approaching_flag; /* set when the train is coming */
  /* 0x02887E */ u8 buried_treasure_flag; /* when set, treasure cannot be buried */
  /* 0x02887F */ u8 spnpc_first_talk_flags;
  /* 0x028880 */ u8 needlework_first_talk_flags;
  /* 0x028882 */ u16 event_notification_active;
  /* 0x028884 */ lbRTC_time_c newly_set_time; /* time set by player in time adjust menu */
  /* 0x02888C */ lbRTC_time_c old_time; /* time before being changed by the player */
  /* 0x028894 */ s16 balloon_state; /* balloon's current state */
  /* 0x028896 */ s16 balloon_last_spawn_min; /* last minute the balloon was spawned */
  /* 0x028898 */ f32 balloon_spawn_percent; /* chance that a balloon will spawn */
  /* 0x02889C */ int nook_shop_state; /* adjusted based on any current events happening to Nook's shop */
  /* 0x0288A0 */ u8 pad_connected; /* is gamepad 0 connected? */
  /* 0x0288A1 */ u8 _288a1[0x02DB40 - 0x0288A1];
  /* 0x02DB40 */ u8 auto_nwrite_set; /* when true, saved nwrite time will be utilized. Seems to be used to keep same date for fishing tourney stuff. */
  /* 0x02DB42 */ u16 select_last_select_no;
  /* 0x02DB44 */ u16 select_last_top_no;
  /* 0x02DB46 */ u8 tmp3[0x2DBB0 - 0x2DB46];
  /* 0x02DBB0 */ s16 can_look_goki_count;
  /* 0x02DBB4 */ f32 rainbow_opacity; /* current opacity of rainbow (0.0f - 1.0f) */
  /* 0x02DBB8 */ u32 event_flags[7]; /* TODO: make array size a definition/enum */
  /* 0x02DBD4 */ xyz_t* pluss_bridge_pos; /* position of extra bridge */
  /* 0x02DBD8 */ lbRTC_time_c auto_nwrite_time; /* cached notice time used for fishing tourney results? */
  /* 0x02DBE0 */ u8 rhythym_updated;
  /* 0x02DBE1 */ u8 _2dbe1;
  /* 0x02DBE2 */ u8 hem_visible; /* controls farley's visiblilty during cutscene? */
  /* 0x02DBE4 */ u8* carde_program_p; /* pointer to current e-Reader program data */
  /* 0x02DBE8 */ size_t carde_program_size; /* size of current e-Reader program data */
  /* 0x02DBEC */ int unk_nook_present_count; /* something possibly to do withhanding over password present? */
  /* 0x02DBF0 */ u8 pad[16];
} common_data_t;

extern common_data_t common_data;

#define Common_Get(name) (common_data.name)
#define Common_GetPointer(name) (&common_data.name)
#define Common_Set(name, value) (common_data.name = (value))

#define Save_Get(name) (Common_Get(save.save.name))
#define Save_GetPointer(name) (Common_GetPointer(save.save.name))
#define Save_Set(name, value) (Common_Set(save.save.name, value))

/* Useful for returning fg item data as a pointer to mActor_name_t */
#define Save_GetFG() Save_Get(fg[0][0].items[0])

extern void common_data_reinit();
extern void common_data_init();
extern void common_data_clear();

#ifdef __cplusplus
}
#endif

#endif